@ingenx-io/valets-schema-mcp-server 0.2.4 → 0.2.6

package/data/docs/models/app-payment.md

@@ -0,0 +1,200 @@
+---
+title: "AppPayment"
+sidebar_label: "AppPayment"
+sidebar_position: 7
+---
+
+# AppPayment
+
+<details>
+<summary>Example JSON</summary>
+
+```json
+{
+  "id": null,
+  "companyId": "comp_xyz789",
+  "appId": "app_ref123",
+  "contact": "contact",
+  "sessionId": "ses_ref123",
+  "transactionId": "tra_ref123",
+  "tier": "Gold",
+  "amount": 45000,
+  "currency": "XOF",
+  "paidAt": "pai_ref123"
+}
+```
+
+</details>
+
+
+- [1. Property `id`](#id)
+- [2. Property `companyId`](#companyId)
+- [3. Property `appId`](#appId)
+- [4. Property `contact`](#contact)
+- [5. Property `sessionId`](#sessionId)
+- [6. Property `transactionId`](#transactionId)
+- [7. Property `tier`](#tier)
+- [8. Property `amount`](#amount)
+- [9. Property `currency`](#currency)
+- [10. Property `paidAt`](#paidAt)
+  - [10.1. Property `_seconds`](#paidAt__seconds)
+  - [10.2. Property `_nanoseconds`](#paidAt__nanoseconds)
+
+|                           |                           |
+| ------------------------- | ------------------------- |
+| **Type**                  | `object`                  |
+| **Required**              | No                        |
+| **Additional properties** | Not allowed               |
+| **Defined in**            | #/definitions/app-payment |
+
+**Description:** AppPayment model (D40 / ING-304). Collection: companies/\{companyId\}/apps/\{appId\}/payments/\{paymentId\}. Immutable append-only transaction ledger. Distinct from AllowedUser (access state) and CustomerPayment (D22 — customer-level billing).
+
+| 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.                                                  |
+| + [appId](#appId )                 | No      | string         | No         | -                                    | (Immutable) FK → App document ID (D40 sub-tenant scope, renamed from siteId per D44).  |
+| + [contact](#contact )             | No      | string         | No         | -                                    | Email or E.164 phone number. Matches AllowedUser.contact.                              |
+| + [sessionId](#sessionId )         | No      | string         | No         | -                                    | Payment provider checkout session ID (e.g. Wave). Usable for dedup across dual writes. |
+| + [transactionId](#transactionId ) | No      | string         | No         | -                                    | Payment provider transaction ID.                                                       |
+| + [tier](#tier )                   | No      | string         | No         | -                                    | Access tier. Free string per app (ING-304 open question).                              |
+| + [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.                 |
+| + [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, 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="appId"></a>3. Property `appId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) FK → App document ID (D40 sub-tenant scope, renamed from siteId per D44).
+
+:::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. Matches AllowedUser.contact.
+
+## <a name="sessionId"></a>5. Property `sessionId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** Payment provider checkout session ID (e.g. Wave). Usable for dedup across dual writes.
+
+## <a name="transactionId"></a>6. Property `transactionId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** Payment provider transaction ID.
+
+## <a name="tier"></a>7. Property `tier`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** Access tier. Free string per app (ING-304 open question).
+
+## <a name="amount"></a>8. Property `amount`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `number` |
+| **Required** | Yes      |
+
+**Description:** Amount paid. Generalized from amount_xof per D40 decision.
+
+## <a name="currency"></a>9. Property `currency`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+| **Default**  | `"XOF"`  |
+
+**Description:** Currency code (ISO 4217). Defaults to XOF for legacy SR-Single parity.
+
+## <a name="paidAt"></a>10. 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>10.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="paidAt__nanoseconds"></a>10.2. Property `_nanoseconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+----------------------------------------------------------------------------------------------------------------------------
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-05-30 at 13:38:44 +0000