Integration Base Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ordoro/refs/heads/main/json-schema/ordoro-integration_base-schema.json",
  "title": "Integration Base Schema",
  "type": "object",
  "definitions": {
    "required_in_response": {
      "required": [
        "name",
        "_link",
        "vendor",
        "vendor_display",
        "id",
        "archived_date",
        "vendor_config"
      ]
    }
  },
  "properties": {
    "_link": {
      "type": "string",
      "description": "A relative link to this integration"
    },
    "name": {
      "type": "string",
      "description": "The name of the integration"
    },
    "vendor": {
      "type": "string",
      "description": "Short name of the vendor.",
      "enum": [
        "quickbooks",
        "stripe"
      ]
    },
    "vendor_display": {
      "type": "string",
      "description": "The corresponding display name of the `vendor` property.",
      "enum": [
        "QuickBooks",
        "Stripe"
      ]
    },
    "id": {
      "type": "integer",
      "description": "The identifier used as the main reference to this integration."
    },
    "archived_date": {
      "description": "If this integration has been archived, this will contain the datetime that the integration was archived. Otherwise it will be null.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "vendor_config": {
      "type": "object",
      "description": "Vendor-specific configuration information."
    }
  }
}