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

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

@@ -0,0 +1,317 @@
+---
+title: "LoyaltyConfig"
+sidebar_label: "LoyaltyConfig"
+sidebar_position: 7
+---
+
+# LoyaltyConfig
+
+<details>
+<summary>Example JSON</summary>
+
+```json
+{
+  "id": null,
+  "isEnabled": true,
+  "pointSystem": "SPENDING",
+  "pointsPerCurrency": null,
+  "pointsPerVisit": null,
+  "pointValue": null,
+  "minimumRedeemPoints": null,
+  "welcomeBonusPoints": null,
+  "pointsExpirationDays": "pointsExpirationDays",
+  "createdAt": "createdAt",
+  "updatedAt": "updatedAt"
+}
+```
+
+</details>
+
+
+- [1. Property `id`](#id)
+- [2. Property `isEnabled`](#isEnabled)
+- [3. Property `pointSystem`](#pointSystem)
+- [4. ~~Property `pointsPerCurrency`~~](#pointsPerCurrency)
+- [5. Property `pointsPerVisit`](#pointsPerVisit)
+- [6. Property `pointValue`](#pointValue)
+- [7. Property `minimumRedeemPoints`](#minimumRedeemPoints)
+- [8. Property `welcomeBonusPoints`](#welcomeBonusPoints)
+- [9. ~~Property `pointsExpirationDays`~~](#pointsExpirationDays)
+  - [9.1. Property `item 0`](#pointsExpirationDays_anyOf_i0)
+  - [9.2. Property `item 1`](#pointsExpirationDays_anyOf_i1)
+- [10. Property `createdAt`](#createdAt)
+  - [10.1. Property `firestore-timestamp`](#createdAt_anyOf_i0)
+    - [10.1.1. Property `_seconds`](#createdAt_anyOf_i0__seconds)
+    - [10.1.2. Property `_nanoseconds`](#createdAt_anyOf_i0__nanoseconds)
+  - [10.2. Property `item 1`](#createdAt_anyOf_i1)
+- [11. Property `updatedAt`](#updatedAt)
+  - [11.1. Property `firestore-timestamp`](#updatedAt_anyOf_i0)
+  - [11.2. Property `item 1`](#updatedAt_anyOf_i1)
+
+|                           |                              |
+| ------------------------- | ---------------------------- |
+| **Type**                  | `object`                     |
+| **Required**              | No                           |
+| **Additional properties** | Not allowed                  |
+| **Defined in**            | #/definitions/loyalty-config |
+
+**Description:** LoyaltyConfig model (D21). Collection: companies/\{companyId\}/loyaltySettings/config. 1 doc per company. Uses canonical field names per D21 (MIG-06 renames legacy aliases).
+
+| Property                                         | Pattern | Type             | Deprecated | Definition | Title/Description                                                                                                                     |
+| ------------------------------------------------ | ------- | ---------------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------- |
+| - [id](#id )                                     | No      | string or null   | No         | -          | (Read-only) Firestore document ID. Singleton doc — typically "config".                                                                |
+| + [isEnabled](#isEnabled )                       | No      | boolean          | No         | -          | -                                                                                                                                     |
+| + [pointSystem](#pointSystem )                   | No      | enum (of string) | No         | -          | How points are earned: SPENDING (per currency spent), PRODUCT (per product purchased), or VISIT (per visit). SCREAMING_SNAKE per D04. |
+| - [pointsPerCurrency](#pointsPerCurrency )       | No      | number or null   | Deprecated | -          | [Deprecated alias: pointsPerCurrencyUnit — renamed by MIG-06]                                                                         |
+| - [pointsPerVisit](#pointsPerVisit )             | No      | number or null   | No         | -          | Points earned per visit (when pointSystem is visit).                                                                                  |
+| - [pointValue](#pointValue )                     | No      | number or null   | No         | -          | Monetary value of one point for redemption.                                                                                           |
+| - [minimumRedeemPoints](#minimumRedeemPoints )   | No      | integer or null  | No         | -          | Minimum points balance required before redemption is allowed.                                                                         |
+| - [welcomeBonusPoints](#welcomeBonusPoints )     | No      | integer or null  | No         | -          | One-time points bonus for new loyalty enrollees.                                                                                      |
+| - [pointsExpirationDays](#pointsExpirationDays ) | No      | Combination      | Deprecated | -          | [Deprecated alias: pointsExpiryMonths — renamed and converted months*30 to days by MIG-06]                                            |
+| - [createdAt](#createdAt )                       | No      | Combination      | No         | -          | (Read-only) Server-generated creation timestamp.                                                                                      |
+| - [updatedAt](#updatedAt )                       | No      | Combination      | No         | -          | (Read-only) Server-generated update timestamp.                                                                                        |
+
+## <a name="id"></a>1. Property `id`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** (Read-only) Firestore document ID. Singleton doc — typically "config".
+
+:::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="isEnabled"></a>2. Property `isEnabled`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `boolean` |
+| **Required** | Yes       |
+
+## <a name="pointSystem"></a>3. Property `pointSystem`
+
+|              |                    |
+| ------------ | ------------------ |
+| **Type**     | `enum (of string)` |
+| **Required** | Yes                |
+
+**Description:** How points are earned: SPENDING (per currency spent), PRODUCT (per product purchased), or VISIT (per visit). SCREAMING_SNAKE per D04.
+
+Must be one of:
+* "SPENDING"
+* "PRODUCT"
+* "VISIT"
+
+## <a name="pointsPerCurrency"></a>4. ~~Property `pointsPerCurrency`~~
+
+|                |                  |
+| -------------- | ---------------- |
+| **Type**       | `number or null` |
+| **Required**   | No               |
+| **Deprecated** |
+
+**Description:** [Deprecated alias: pointsPerCurrencyUnit — renamed by MIG-06]
+
+:::danger Deprecated
+This field is deprecated. Do not write it in new code.
+:::
+
+## <a name="pointsPerVisit"></a>5. Property `pointsPerVisit`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `number or null` |
+| **Required** | No               |
+
+**Description:** Points earned per visit (when pointSystem is visit).
+
+## <a name="pointValue"></a>6. Property `pointValue`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `number or null` |
+| **Required** | No               |
+
+**Description:** Monetary value of one point for redemption.
+
+## <a name="minimumRedeemPoints"></a>7. Property `minimumRedeemPoints`
+
+|              |                   |
+| ------------ | ----------------- |
+| **Type**     | `integer or null` |
+| **Required** | No                |
+
+**Description:** Minimum points balance required before redemption is allowed.
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+## <a name="welcomeBonusPoints"></a>8. Property `welcomeBonusPoints`
+
+|              |                   |
+| ------------ | ----------------- |
+| **Type**     | `integer or null` |
+| **Required** | No                |
+
+**Description:** One-time points bonus for new loyalty enrollees.
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+## <a name="pointsExpirationDays"></a>9. ~~Property `pointsExpirationDays`~~
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | No               |
+| **Deprecated**            |
+| **Additional properties** | Any type allowed |
+
+**Description:** [Deprecated alias: pointsExpiryMonths — renamed and converted months*30 to days by MIG-06]
+
+| Any of(Option)                           |
+| ---------------------------------------- |
+| [item 0](#pointsExpirationDays_anyOf_i0) |
+| [item 1](#pointsExpirationDays_anyOf_i1) |
+
+### <a name="pointsExpirationDays_anyOf_i0"></a>9.1. Property `item 0`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | No        |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="pointsExpirationDays_anyOf_i1"></a>9.2. Property `item 1`
+
+|              |        |
+| ------------ | ------ |
+| **Type**     | `null` |
+| **Required** | No     |
+
+:::danger Deprecated
+This field is deprecated. Do not write it in new code.
+:::
+
+## <a name="createdAt"></a>10. Property `createdAt`
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | No               |
+| **Additional properties** | Any type allowed |
+
+**Description:** (Read-only) Server-generated creation timestamp.
+
+| Any of(Option)                             |
+| ------------------------------------------ |
+| [firestore-timestamp](#createdAt_anyOf_i0) |
+| [item 1](#createdAt_anyOf_i1)              |
+
+### <a name="createdAt_anyOf_i0"></a>10.1. Property `firestore-timestamp`
+
+|                           |                                   |
+| ------------------------- | --------------------------------- |
+| **Type**                  | `object`                          |
+| **Required**              | No                                |
+| **Additional properties** | Not allowed                       |
+| **Defined in**            | #/definitions/firestore-timestamp |
+
+**Description:** Firestore Timestamp serialized representation
+
+| Property                                            | Pattern | Type    | Deprecated | Definition | Title/Description |
+| --------------------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------- |
+| + [_seconds](#createdAt_anyOf_i0__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#createdAt_anyOf_i0__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+#### <a name="createdAt_anyOf_i0__seconds"></a>10.1.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+#### <a name="createdAt_anyOf_i0__nanoseconds"></a>10.1.2. Property `_nanoseconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="createdAt_anyOf_i1"></a>10.2. Property `item 1`
+
+|              |        |
+| ------------ | ------ |
+| **Type**     | `null` |
+| **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="updatedAt"></a>11. Property `updatedAt`
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | No               |
+| **Additional properties** | Any type allowed |
+
+**Description:** (Read-only) Server-generated update timestamp.
+
+| Any of(Option)                             |
+| ------------------------------------------ |
+| [firestore-timestamp](#updatedAt_anyOf_i0) |
+| [item 1](#updatedAt_anyOf_i1)              |
+
+### <a name="updatedAt_anyOf_i0"></a>11.1. Property `firestore-timestamp`
+
+|                           |                                           |
+| ------------------------- | ----------------------------------------- |
+| **Type**                  | `object`                                  |
+| **Required**              | No                                        |
+| **Additional properties** | Not allowed                               |
+| **Same definition as**    | [createdAt_anyOf_i0](#createdAt_anyOf_i0) |
+
+**Description:** Firestore Timestamp serialized representation
+
+### <a name="updatedAt_anyOf_i1"></a>11.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-06 at 19:27:48 +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.
+:::
+
+## Related Decisions
+
+| Decision | Title |
+|---|---|
+| **D21** | Loyalty config canonical field names |

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

@@ -0,0 +1,236 @@
+---
+title: "LoyaltyReward"
+sidebar_label: "LoyaltyReward"
+sidebar_position: 8
+---
+
+# LoyaltyReward
+
+<details>
+<summary>Example JSON</summary>
+
+```json
+{
+  "id": "bk_abc123def456",
+  "name": "Free Braiding Session",
+  "description": null,
+  "pointsRequired": 200,
+  "isActive": true,
+  "imageUrl": null,
+  "rewardType": null,
+  "discountValue": null,
+  "productId": null,
+  "createdAt": "createdAt",
+  "updatedAt": "updatedAt"
+}
+```
+
+</details>
+
+
+- [1. Property `id`](#id)
+- [2. Property `name`](#name)
+- [3. Property `description`](#description)
+- [4. Property `pointsRequired`](#pointsRequired)
+- [5. Property `isActive`](#isActive)
+- [6. Property `imageUrl`](#imageUrl)
+- [7. Property `rewardType`](#rewardType)
+- [8. Property `discountValue`](#discountValue)
+- [9. Property `productId`](#productId)
+- [10. Property `createdAt`](#createdAt)
+  - [10.1. Property `_seconds`](#createdAt__seconds)
+  - [10.2. Property `_nanoseconds`](#createdAt__nanoseconds)
+- [11. Property `updatedAt`](#updatedAt)
+  - [11.1. Property `firestore-timestamp`](#updatedAt_anyOf_i0)
+  - [11.2. Property `item 1`](#updatedAt_anyOf_i1)
+
+|                           |                              |
+| ------------------------- | ---------------------------- |
+| **Type**                  | `object`                     |
+| **Required**              | No                           |
+| **Additional properties** | Not allowed                  |
+| **Defined in**            | #/definitions/loyalty-reward |
+
+**Description:** LoyaltyReward model. Collection: companies/\{companyId\}/loyaltyRewards/\{rewardId\}. Reward catalog for point redemption (IG-10).
+
+| Property                             | Pattern | Type           | Deprecated | Definition                           | Title/Description                                             |
+| ------------------------------------ | ------- | -------------- | ---------- | ------------------------------------ | ------------------------------------------------------------- |
+| + [id](#id )                         | No      | string         | No         | -                                    | (Read-only) Firestore document ID.                            |
+| + [name](#name )                     | No      | string         | No         | -                                    | -                                                             |
+| - [description](#description )       | No      | string or null | No         | -                                    | -                                                             |
+| + [pointsRequired](#pointsRequired ) | No      | integer        | No         | -                                    | Points cost to redeem this reward.                            |
+| + [isActive](#isActive )             | No      | boolean        | No         | -                                    | Whether this reward is currently available for redemption.    |
+| - [imageUrl](#imageUrl )             | No      | string or null | No         | -                                    | -                                                             |
+| - [rewardType](#rewardType )         | No      | string or null | No         | -                                    | Category of reward (e.g. discount, free_item, service).       |
+| - [discountValue](#discountValue )   | No      | number or null | No         | -                                    | Discount amount when rewardType is discount.                  |
+| - [productId](#productId )           | No      | string or null | No         | -                                    | FK → Product.id. Linked product when rewardType is free_item. |
+| + [createdAt](#createdAt )           | No      | object         | No         | In #/definitions/firestore-timestamp | (Read-only) Server-generated creation timestamp.              |
+| - [updatedAt](#updatedAt )           | No      | Combination    | No         | -                                    | (Read-only) Server-generated update timestamp.                |
+
+## <a name="id"></a>1. Property `id`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Read-only) Firestore document ID.
+
+:::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="name"></a>2. Property `name`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+## <a name="description"></a>3. Property `description`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+## <a name="pointsRequired"></a>4. Property `pointsRequired`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+**Description:** Points cost to redeem this reward.
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+## <a name="isActive"></a>5. Property `isActive`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `boolean` |
+| **Required** | Yes       |
+
+**Description:** Whether this reward is currently available for redemption.
+
+## <a name="imageUrl"></a>6. Property `imageUrl`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+## <a name="rewardType"></a>7. Property `rewardType`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** Category of reward (e.g. discount, free_item, service).
+
+## <a name="discountValue"></a>8. Property `discountValue`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `number or null` |
+| **Required** | No               |
+
+**Description:** Discount amount when rewardType is discount.
+
+## <a name="productId"></a>9. Property `productId`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** FK → Product.id. Linked product when rewardType is free_item.
+
+## <a name="createdAt"></a>10. 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](#createdAt__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#createdAt__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+### <a name="createdAt__seconds"></a>10.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="createdAt__nanoseconds"></a>10.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>11. Property `updatedAt`
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | No               |
+| **Additional properties** | Any type allowed |
+
+**Description:** (Read-only) Server-generated update timestamp.
+
+| Any of(Option)                             |
+| ------------------------------------------ |
+| [firestore-timestamp](#updatedAt_anyOf_i0) |
+| [item 1](#updatedAt_anyOf_i1)              |
+
+### <a name="updatedAt_anyOf_i0"></a>11.1. Property `firestore-timestamp`
+
+|                           |                         |
+| ------------------------- | ----------------------- |
+| **Type**                  | `object`                |
+| **Required**              | No                      |
+| **Additional properties** | Not allowed             |
+| **Same definition as**    | [createdAt](#createdAt) |
+
+**Description:** Firestore Timestamp serialized representation
+
+### <a name="updatedAt_anyOf_i1"></a>11.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-06 at 19:27:48 +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.
+:::