@fleetless/contracts 6.2.0 → 6.3.0-next.1

package/artifacts/schema/checkout-request.schema.json

@@ -0,0 +1,252 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "plan": {
+      "type": "string",
+      "enum": [
+        "plus",
+        "pro"
+      ],
+      "description": "The plan to buy."
+    },
+    "cycle": {
+      "type": "string",
+      "enum": [
+        "monthly",
+        "yearly"
+      ],
+      "description": "Monthly, or yearly at 15 % off."
+    },
+    "addons": {
+      "description": "Add-on counts to buy alongside the plan. Pro only; named on `plus`, or without the feature, `400 validation_error`.",
+      "type": "object",
+      "properties": {
+        "seats": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Extra developer seats, one each."
+        },
+        "robots": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Extra robots, one each."
+        },
+        "apps": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Extra apps, one each."
+        },
+        "app_user_packs": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Packs of five extra app users."
+        },
+        "live_video_packs": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "Packs of 250 extra hours of app-user live video per month."
+        }
+      },
+      "additionalProperties": false
+    },
+    "billing": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "const": "company",
+              "description": "Billed as a company."
+            },
+            "company_name": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 200,
+              "description": "The company's legal name, printed on the invoice."
+            },
+            "vat_id": {
+              "anyOf": [
+                {
+                  "type": "string",
+                  "maxLength": 20
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "description": "The company's VAT ID, or `null` for none. Required, and must check out through VIES, for a company outside Germany."
+            },
+            "address": {
+              "type": "object",
+              "properties": {
+                "line1": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 200,
+                  "description": "Street and number, or the first address line."
+                },
+                "line2": {
+                  "anyOf": [
+                    {
+                      "type": "string",
+                      "maxLength": 200
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ],
+                  "description": "A second address line, or `null` when there is none."
+                },
+                "postal_code": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 20,
+                  "description": "Postal or ZIP code."
+                },
+                "city": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 100,
+                  "description": "City or town."
+                },
+                "country": {
+                  "type": "string",
+                  "pattern": "^[A-Z]{2}$",
+                  "description": "The billing country. Decides VAT (`vatFor`) and currency (`currencyForCountry`)."
+                }
+              },
+              "required": [
+                "line1",
+                "line2",
+                "postal_code",
+                "city",
+                "country"
+              ],
+              "additionalProperties": false,
+              "description": "The billing address."
+            },
+            "invoice_email": {
+              "type": "string",
+              "format": "email",
+              "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+              "description": "Where invoices and billing mail are sent."
+            }
+          },
+          "required": [
+            "kind",
+            "company_name",
+            "vat_id",
+            "address",
+            "invoice_email"
+          ],
+          "additionalProperties": false,
+          "description": "A company: name and an optional VAT ID, never 'full name'."
+        },
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "const": "person",
+              "description": "Billed as a person."
+            },
+            "full_name": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 200,
+              "description": "The person's full name, printed on the invoice."
+            },
+            "address": {
+              "type": "object",
+              "properties": {
+                "line1": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 200,
+                  "description": "Street and number, or the first address line."
+                },
+                "line2": {
+                  "anyOf": [
+                    {
+                      "type": "string",
+                      "maxLength": 200
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ],
+                  "description": "A second address line, or `null` when there is none."
+                },
+                "postal_code": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 20,
+                  "description": "Postal or ZIP code."
+                },
+                "city": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 100,
+                  "description": "City or town."
+                },
+                "country": {
+                  "type": "string",
+                  "pattern": "^[A-Z]{2}$",
+                  "description": "The billing country. Decides VAT (`vatFor`) and currency (`currencyForCountry`)."
+                }
+              },
+              "required": [
+                "line1",
+                "line2",
+                "postal_code",
+                "city",
+                "country"
+              ],
+              "additionalProperties": false,
+              "description": "The billing address."
+            },
+            "invoice_email": {
+              "type": "string",
+              "format": "email",
+              "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+              "description": "Where invoices and billing mail are sent."
+            }
+          },
+          "required": [
+            "kind",
+            "full_name",
+            "address",
+            "invoice_email"
+          ],
+          "additionalProperties": false,
+          "description": "A person: a full name, never a VAT ID — only a company can be VAT-registered."
+        }
+      ],
+      "description": "Who is paying, and where the invoice goes."
+    },
+    "accept_terms": {
+      "type": "boolean",
+      "const": true,
+      "description": "Confirms Fleetless's terms of service. Always required."
+    },
+    "accept_withdrawal": {
+      "description": "Confirms the plan starts at once and the 14-day right of withdrawal ends with it. Required for a person; a company sending it is `400 validation_error` — it has no withdrawal right to confirm.",
+      "type": "boolean",
+      "const": true
+    }
+  },
+  "required": [
+    "plan",
+    "cycle",
+    "billing",
+    "accept_terms"
+  ],
+  "additionalProperties": false
+}

package/artifacts/schema/checkout-response.schema.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "checkout_id": {
+      "type": "string",
+      "format": "uuid",
+      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
+      "description": "Identifies this checkout: polled by `GET /api/billing/checkout/:id` and carried on the return URL."
+    },
+    "checkout_url": {
+      "type": "string",
+      "format": "uri",
+      "description": "Mollie's hosted checkout page. The caller's browser is sent here."
+    }
+  },
+  "required": [
+    "checkout_id",
+    "checkout_url"
+  ],
+  "additionalProperties": false
+}

package/artifacts/schema/checkout-status.schema.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "checkout_id": {
+      "type": "string",
+      "format": "uuid",
+      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
+      "description": "The checkout this status is for."
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "pending",
+        "paid",
+        "failed",
+        "canceled",
+        "expired"
+      ],
+      "description": "Mollie's payment status, as `reconcilePayment` last read it."
+    },
+    "purpose": {
+      "type": "string",
+      "enum": [
+        "upgrade",
+        "payment_method",
+        "invoice"
+      ],
+      "description": "What this checkout paid for: a plan upgrade, a payment-method change, or an open invoice."
+    },
+    "plan": {
+      "type": "string",
+      "enum": [
+        "basic",
+        "plus",
+        "pro",
+        "enterprise"
+      ],
+      "description": "The org's plan after applying — unchanged unless `purpose` is `upgrade` and `status` is `paid`."
+    }
+  },
+  "required": [
+    "checkout_id",
+    "status",
+    "purpose",
+    "plan"
+  ],
+  "additionalProperties": false
+}

package/artifacts/schema/payment-method-change-request.schema.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "method": {
+      "type": "string",
+      "enum": [
+        "card",
+        "paypal",
+        "sepa"
+      ],
+      "description": "The new mandate's method. `sepa` needs an open invoice to charge a real amount against; without one it is `400 validation_error`."
+    }
+  },
+  "required": [
+    "method"
+  ],
+  "additionalProperties": false
+}

package/artifacts/schema/payment-method.schema.json

@@ -0,0 +1,80 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "oneOf": [
+    {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": "string",
+          "const": "card",
+          "description": "A card mandate."
+        },
+        "brand": {
+          "type": "string",
+          "description": "The card network, as Mollie's mandate reports it, e.g. 'Visa'."
+        },
+        "last4": {
+          "type": "string",
+          "pattern": "^\\d{4}$",
+          "description": "The last four digits of the card."
+        },
+        "expires": {
+          "type": "string",
+          "pattern": "^\\d{2}\\/\\d{2}$",
+          "description": "Expiry as Mollie's mandate shows it, 'MM/YY'."
+        }
+      },
+      "required": [
+        "kind",
+        "brand",
+        "last4",
+        "expires"
+      ],
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": "string",
+          "const": "sepa",
+          "description": "A SEPA direct-debit mandate."
+        },
+        "holder": {
+          "type": "string",
+          "description": "The account holder's name on the mandate."
+        },
+        "iban_last4": {
+          "type": "string",
+          "pattern": "^[0-9A-Z]{4}$",
+          "description": "The last four characters of the IBAN."
+        }
+      },
+      "required": [
+        "kind",
+        "holder",
+        "iban_last4"
+      ],
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": "string",
+          "const": "paypal",
+          "description": "A PayPal mandate."
+        },
+        "account": {
+          "type": "string",
+          "description": "The PayPal account Mollie's mandate names."
+        }
+      },
+      "required": [
+        "kind",
+        "account"
+      ],
+      "additionalProperties": false
+    }
+  ]
+}

package/artifacts/schema/payment-provider-unavailable-details.schema.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "provider": {
+      "type": "string",
+      "const": "mollie",
+      "description": "The payment provider. Always `mollie` today."
+    },
+    "status": {
+      "anyOf": [
+        {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "Mollie's own HTTP status, or `null` when the request timed out instead of answering."
+    }
+  },
+  "required": [
+    "provider",
+    "status"
+  ],
+  "additionalProperties": false
+}

package/artifacts/schema/vat-id-check-request.schema.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "country": {
+      "type": "string",
+      "pattern": "^[A-Z]{2}$",
+      "description": "The VAT ID's country."
+    },
+    "vat_id": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 20,
+      "description": "The VAT ID as typed; normalized before the VIES lookup (`normalizeVatId`)."
+    }
+  },
+  "required": [
+    "country",
+    "vat_id"
+  ],
+  "additionalProperties": false
+}

package/artifacts/schema/vat-id-check-response.schema.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "status": {
+      "type": "string",
+      "enum": [
+        "valid",
+        "unverified",
+        "invalid"
+      ],
+      "description": "VIES's answer."
+    },
+    "vat_id": {
+      "type": "string",
+      "description": "The normalized VAT ID that was checked."
+    },
+    "name": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "The registered holder, when VIES named one; `null` otherwise."
+    }
+  },
+  "required": [
+    "status",
+    "vat_id",
+    "name"
+  ],
+  "additionalProperties": false
+}