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

package/data/docs/models/allowed-user.md

@@ -0,0 +1,188 @@
+---
+title: "AllowedUser"
+sidebar_label: "AllowedUser"
+sidebar_position: 1
+---
+
+# AllowedUser
+
+<details>
+<summary>Example JSON</summary>
+
+```json
+{
+  "id": null,
+  "companyId": "comp_xyz789",
+  "siteId": "sit_ref123",
+  "contact": "contact",
+  "tier": "Gold",
+  "amount": 45000,
+  "currency": "XOF",
+  "transactionId": "tra_ref123",
+  "paidAt": "pai_ref123"
+}
+```
+
+</details>
+
+
+- [1. Property `id`](#id)
+- [2. Property `companyId`](#companyId)
+- [3. Property `siteId`](#siteId)
+- [4. Property `contact`](#contact)
+- [5. Property `tier`](#tier)
+- [6. Property `amount`](#amount)
+- [7. Property `currency`](#currency)
+- [8. Property `transactionId`](#transactionId)
+- [9. Property `paidAt`](#paidAt)
+  - [9.1. Property `_seconds`](#paidAt__seconds)
+  - [9.2. Property `_nanoseconds`](#paidAt__nanoseconds)
+
+|                           |                            |
+| ------------------------- | -------------------------- |
+| **Type**                  | `object`                   |
+| **Required**              | No                         |
+| **Additional properties** | Not allowed                |
+| **Defined in**            | #/definitions/allowed-user |
+
+**Description:** AllowedUser model (D40 / ING-304). Collection: companies/\{companyId\}/sites/\{siteId\}/allowed_users/\{contactId\}. Authoritative paid-access allowlist. Upsert semantics — tier upgrades overwrite. Source of truth for access checks and referral code resolution.
+
+| Property                           | Pattern | Type           | Deprecated | Definition                           | Title/Description                                                                                |
+| ---------------------------------- | ------- | -------------- | ---------- | ------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| - [id](#id )                       | No      | string or null | No         | -                                    | (Read-only) Firestore document ID = contact identifier (email or E.164 phone), URL-escaped.      |
+| + [companyId](#companyId )         | No      | string         | No         | -                                    | (Immutable) FK → Company document ID.                                                            |
+| + [siteId](#siteId )               | No      | string         | No         | -                                    | (Immutable) FK → Site document ID (D40 sub-tenant scope).                                        |
+| + [contact](#contact )             | No      | string         | No         | -                                    | Email or E.164 phone number. Canonical identifier for this user within the site.                 |
+| + [tier](#tier )                   | No      | string         | No         | -                                    | Access tier. Free string per site (ING-304 open question — tier values are site-specific today). |
+| + [amount](#amount )               | No      | number         | No         | -                                    | Amount paid. Generalized from amount_xof per D40 decision.                                       |
+| + [currency](#currency )           | No      | string         | No         | -                                    | Currency code (ISO 4217). Defaults to XOF for legacy SR-Single parity.                           |
+| + [transactionId](#transactionId ) | No      | string         | No         | -                                    | Payment provider transaction ID (e.g. Wave).                                                     |
+| + [paidAt](#paidAt )               | No      | object         | No         | In #/definitions/firestore-timestamp | RFC3339Nano UTC when payment was completed.                                                      |
+
+## <a name="id"></a>1. Property `id`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** (Read-only) Firestore document ID = contact identifier (email or E.164 phone), URL-escaped.
+
+:::warning Server-set
+Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
+:::
+
+## <a name="companyId"></a>2. Property `companyId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) FK → Company document ID.
+
+:::info Immutable
+Set at creation only. This field cannot be modified after the document is created. Include it in CREATE payloads; omit it (or leave unchanged) in UPDATE payloads.
+:::
+
+## <a name="siteId"></a>3. Property `siteId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) FK → Site document ID (D40 sub-tenant scope).
+
+:::info Immutable
+Set at creation only. This field cannot be modified after the document is created. Include it in CREATE payloads; omit it (or leave unchanged) in UPDATE payloads.
+:::
+
+## <a name="contact"></a>4. Property `contact`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** Email or E.164 phone number. Canonical identifier for this user within the site.
+
+## <a name="tier"></a>5. Property `tier`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** Access tier. Free string per site (ING-304 open question — tier values are site-specific today).
+
+## <a name="amount"></a>6. Property `amount`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `number` |
+| **Required** | Yes      |
+
+**Description:** Amount paid. Generalized from amount_xof per D40 decision.
+
+## <a name="currency"></a>7. Property `currency`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+| **Default**  | `"XOF"`  |
+
+**Description:** Currency code (ISO 4217). Defaults to XOF for legacy SR-Single parity.
+
+## <a name="transactionId"></a>8. Property `transactionId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** Payment provider transaction ID (e.g. Wave).
+
+## <a name="paidAt"></a>9. Property `paidAt`
+
+|                           |                                   |
+| ------------------------- | --------------------------------- |
+| **Type**                  | `object`                          |
+| **Required**              | Yes                               |
+| **Additional properties** | Not allowed                       |
+| **Defined in**            | #/definitions/firestore-timestamp |
+
+**Description:** RFC3339Nano UTC when payment was completed.
+
+| Property                                | Pattern | Type    | Deprecated | Definition | Title/Description |
+| --------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------- |
+| + [_seconds](#paidAt__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#paidAt__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+### <a name="paidAt__seconds"></a>9.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="paidAt__nanoseconds"></a>9.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-04-18 at 22:24:54 +0000

package/data/docs/models/analytics-backfill.md

@@ -0,0 +1,398 @@
+---
+title: "AnalyticsBackfill"
+sidebar_label: "AnalyticsBackfill"
+sidebar_position: 2
+---
+
+# AnalyticsBackfill
+
+<details>
+<summary>Example JSON</summary>
+
+```json
+{
+  "id": null,
+  "companyId": "comp_xyz789",
+  "siteId": "sit_ref123",
+  "status": "pending",
+  "from": "from",
+  "to": "to",
+  "dryRun": true,
+  "processedDates": [
+    "example"
+  ],
+  "errors": [
+    {
+      "date": "2026-02-15",
+      "message": "message",
+      "at": "at"
+    }
+  ],
+  "triggeredBy": "triggeredBy",
+  "startedAt": "startedAt",
+  "completedAt": "completedAt"
+}
+```
+
+</details>
+
+
+- [1. Property `id`](#id)
+- [2. Property `companyId`](#companyId)
+- [3. Property `siteId`](#siteId)
+- [4. Property `status`](#status)
+- [5. Property `from`](#from)
+- [6. Property `to`](#to)
+- [7. Property `dryRun`](#dryRun)
+- [8. Property `processedDates`](#processedDates)
+  - [8.1. processedDates items](#processedDates_items)
+- [9. Property `errors`](#errors)
+  - [9.1. errors items](#errors_items)
+    - [9.1.1. Property `date`](#errors_items_date)
+    - [9.1.2. Property `message`](#errors_items_message)
+    - [9.1.3. Property `at`](#errors_items_at)
+      - [9.1.3.1. Property `_seconds`](#errors_items_at__seconds)
+      - [9.1.3.2. Property `_nanoseconds`](#errors_items_at__nanoseconds)
+- [10. Property `triggeredBy`](#triggeredBy)
+- [11. Property `startedAt`](#startedAt)
+  - [11.1. Property `_seconds`](#errors_items_at__seconds)
+  - [11.2. Property `_nanoseconds`](#errors_items_at__nanoseconds)
+- [12. Property `completedAt`](#completedAt)
+  - [12.1. Property `firestore-timestamp`](#completedAt_anyOf_i0)
+  - [12.2. Property `item 1`](#completedAt_anyOf_i1)
+
+|                           |                                  |
+| ------------------------- | -------------------------------- |
+| **Type**                  | `object`                         |
+| **Required**              | No                               |
+| **Additional properties** | Not allowed                      |
+| **Defined in**            | #/definitions/analytics-backfill |
+
+**Description:** AnalyticsBackfill run (D42 / ING-304). Collection: companies/\{companyId\}/sites/\{siteId\}/analytics_backfills/\{runId\}. Tracks admin-triggered rollup backfill jobs; supports dry-run.
+
+| Property                             | Pattern | Type             | Deprecated | Definition                           | Title/Description                                                                               |
+| ------------------------------------ | ------- | ---------------- | ---------- | ------------------------------------ | ----------------------------------------------------------------------------------------------- |
+| - [id](#id )                         | No      | string or null   | No         | -                                    | (Read-only) Firestore document ID, auto-generated.                                              |
+| + [companyId](#companyId )           | No      | string           | No         | -                                    | (Immutable) FK → Company document ID.                                                           |
+| + [siteId](#siteId )                 | No      | string           | No         | -                                    | (Immutable) FK → Site document ID (D40).                                                        |
+| + [status](#status )                 | No      | enum (of string) | No         | -                                    | Run status.                                                                                     |
+| + [from](#from )                     | No      | string           | No         | -                                    | (Immutable) Inclusive start date (\`YYYY-MM-DD\`, UTC).                                         |
+| + [to](#to )                         | No      | string           | No         | -                                    | (Immutable) Inclusive end date (\`YYYY-MM-DD\`, UTC).                                           |
+| + [dryRun](#dryRun )                 | No      | boolean          | No         | -                                    | (Immutable) When true, rollup writes are skipped — only source counts are returned for diffing. |
+| + [processedDates](#processedDates ) | No      | array of string  | No         | -                                    | Ordered list of \`YYYY-MM-DD\` dates already processed by this run.                             |
+| + [errors](#errors )                 | No      | array of object  | No         | -                                    | Per-date errors collected during the run.                                                       |
+| + [triggeredBy](#triggeredBy )       | No      | string           | No         | -                                    | (Immutable) UID of the admin who triggered the backfill.                                        |
+| + [startedAt](#startedAt )           | No      | object           | No         | In #/definitions/firestore-timestamp | (Read-only) When the run actually started.                                                      |
+| - [completedAt](#completedAt )       | No      | Combination      | No         | -                                    | (Read-only) When the run reached a terminal status.                                             |
+
+## <a name="id"></a>1. Property `id`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** (Read-only) Firestore document ID, auto-generated.
+
+:::warning Server-set
+Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
+:::
+
+## <a name="companyId"></a>2. Property `companyId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) FK → Company document ID.
+
+:::info Immutable
+Set at creation only. This field cannot be modified after the document is created. Include it in CREATE payloads; omit it (or leave unchanged) in UPDATE payloads.
+:::
+
+## <a name="siteId"></a>3. Property `siteId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) FK → Site document ID (D40).
+
+:::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="status"></a>4. Property `status`
+
+|              |                    |
+| ------------ | ------------------ |
+| **Type**     | `enum (of string)` |
+| **Required** | Yes                |
+
+**Description:** Run status.
+
+Must be one of:
+* "pending"
+* "running"
+* "completed"
+* "failed"
+* "cancelled"
+
+## <a name="from"></a>5. Property `from`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) Inclusive start date (`YYYY-MM-DD`, UTC).
+
+:::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="to"></a>6. Property `to`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) Inclusive end date (`YYYY-MM-DD`, UTC).
+
+:::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="dryRun"></a>7. Property `dryRun`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `boolean` |
+| **Required** | Yes       |
+
+**Description:** (Immutable) When true, rollup writes are skipped — only source counts are returned for diffing.
+
+:::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="processedDates"></a>8. Property `processedDates`
+
+|              |                   |
+| ------------ | ----------------- |
+| **Type**     | `array of string` |
+| **Required** | Yes               |
+
+**Description:** Ordered list of `YYYY-MM-DD` dates already processed by this run.
+
+|                      | 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 |
+| --------------------------------------------- | ----------- |
+| [processedDates items](#processedDates_items) | -           |
+
+### <a name="processedDates_items"></a>8.1. processedDates items
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | No       |
+
+## <a name="errors"></a>9. Property `errors`
+
+|              |                   |
+| ------------ | ----------------- |
+| **Type**     | `array of object` |
+| **Required** | Yes               |
+
+**Description:** Per-date errors collected during the run.
+
+|                      | 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 |
+| ------------------------------- | ----------- |
+| [errors items](#errors_items)   | -           |
+
+### <a name="errors_items"></a>9.1. errors items
+
+|                           |             |
+| ------------------------- | ----------- |
+| **Type**                  | `object`    |
+| **Required**              | No          |
+| **Additional properties** | Not allowed |
+
+| Property                            | Pattern | Type   | Deprecated | Definition                           | Title/Description                  |
+| ----------------------------------- | ------- | ------ | ---------- | ------------------------------------ | ---------------------------------- |
+| + [date](#errors_items_date )       | No      | string | No         | -                                    | \`YYYY-MM-DD\` date that failed.   |
+| + [message](#errors_items_message ) | No      | string | No         | -                                    | Error message captured at failure. |
+| + [at](#errors_items_at )           | No      | object | No         | In #/definitions/firestore-timestamp | When the error occurred.           |
+
+#### <a name="errors_items_date"></a>9.1.1. Property `date`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** `YYYY-MM-DD` date that failed.
+
+#### <a name="errors_items_message"></a>9.1.2. Property `message`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** Error message captured at failure.
+
+#### <a name="errors_items_at"></a>9.1.3. Property `at`
+
+|                           |                                   |
+| ------------------------- | --------------------------------- |
+| **Type**                  | `object`                          |
+| **Required**              | Yes                               |
+| **Additional properties** | Not allowed                       |
+| **Defined in**            | #/definitions/firestore-timestamp |
+
+**Description:** When the error occurred.
+
+| Property                                         | Pattern | Type    | Deprecated | Definition | Title/Description |
+| ------------------------------------------------ | ------- | ------- | ---------- | ---------- | ----------------- |
+| + [_seconds](#errors_items_at__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#errors_items_at__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+##### <a name="errors_items_at__seconds"></a>9.1.3.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+##### <a name="errors_items_at__nanoseconds"></a>9.1.3.2. Property `_nanoseconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+## <a name="triggeredBy"></a>10. Property `triggeredBy`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) UID of the admin who triggered the backfill.
+
+:::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="startedAt"></a>11. Property `startedAt`
+
+|                           |                                   |
+| ------------------------- | --------------------------------- |
+| **Type**                  | `object`                          |
+| **Required**              | Yes                               |
+| **Additional properties** | Not allowed                       |
+| **Defined in**            | #/definitions/firestore-timestamp |
+
+**Description:** (Read-only) When the run actually started.
+
+| Property                                         | Pattern | Type    | Deprecated | Definition | Title/Description |
+| ------------------------------------------------ | ------- | ------- | ---------- | ---------- | ----------------- |
+| + [_seconds](#errors_items_at__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#errors_items_at__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+### <a name="errors_items_at__seconds"></a>11.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="errors_items_at__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="completedAt"></a>12. Property `completedAt`
+
+|                           |                  |
+| ------------------------- | ---------------- |
+| **Type**                  | `combining`      |
+| **Required**              | No               |
+| **Additional properties** | Any type allowed |
+
+**Description:** (Read-only) When the run reached a terminal status.
+
+| Any of(Option)                               |
+| -------------------------------------------- |
+| [firestore-timestamp](#completedAt_anyOf_i0) |
+| [item 1](#completedAt_anyOf_i1)              |
+
+### <a name="completedAt_anyOf_i0"></a>12.1. Property `firestore-timestamp`
+
+|                           |                        |
+| ------------------------- | ---------------------- |
+| **Type**                  | `object`               |
+| **Required**              | No                     |
+| **Additional properties** | Not allowed            |
+| **Same definition as**    | [at](#errors_items_at) |
+
+**Description:** Firestore Timestamp serialized representation
+
+### <a name="completedAt_anyOf_i1"></a>12.2. Property `item 1`
+
+|              |        |
+| ------------ | ------ |
+| **Type**     | `null` |
+| **Required** | No     |
+
+----------------------------------------------------------------------------------------------------------------------------
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 22:24:54 +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.
+:::