dancecard-email-schemas/src/schemas/Token.js

Schemas for objects for Dancecard Email Nurturing System

let Token = {
  "id": "./Token",
  "title": "Token",
  "description": "A Token that is used within Templates and maps to a token in a Jinja template.",
  "type": "object",
  "properties": {
    "_id": {
      "description": "Unique ID generated by database.",
      "type": "string"
    },
    "token_name": {
      "description": "User provided Token ID/Name",
      "type": "string"
    },
    "placeholder": {
      "description": "Token placeholder used in email templates.",
      "type": "string"
    },
    "jinja_placeholder": {
      "description": "Token placeholder used in the Jinja email templates.",
      "type": "string"
    },
    "end_user_visibility": {
      "description": "If true show this token to end users in list of available tokens. If false do not show to end users in their list of available tokens.",
      "type": "boolean"
    },
    "all_program_visibility": {
      "description": "If true show this token in list of available tokens for all programs. If false this token is to be shown only in the selected programs.",
      "type": "boolean"
    },
    "programs": {
      "description": "List of programs this token is visible for.",
      "type": "array",
      "minItems": 0,
      "items": {
        "$ref": "./Program"
      }
    }
  },
  "required": ["token_name", "placeholder", "jinja_placeholder", "end_user_visibility", "all_program_visibility", "programs"]
}

export { Token }