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

Schemas for objects for Dancecard Email Nurturing System

let Email = {
  "_id": "./Email",
  "title": "Email",
  "description": "An email for a program",
  "type": "object",
  "properties": {
    "_id": {
      "description": "Unique ID generated by database.",
      "type": "string"
    },
    "email_name": {
      "description": "User provided Template ID/Name.",
      "type": "string"
    },
    "template": {
      "description": "Template that this Email is using.",
      "$ref": "./Template"
    },
    "cta_type": {
      "description": 'String: either "Gallery", "Video", or "Case Study"',
      "type": "string",
      "enum": ["Gallery", "Video", "Case Study"]
    },
    "cta_override": {
      "description": "TODO: Talk to Colin about this",
      "type": "boolean"
    },
    "email_type": {
      "description": 'String: Either "First Email", "2+ Email", "Lifecycle Email", "Single Email", or "Opt-In Email"',
      "type": "string",
      "enum": ["First Email", "2+ Email", "Lifecycle Email", "Single Email", "Opt-In Email"]
    },
    "subtype_fields": {
      "description": "An object that will contain any custom fields associated with a specific email subtype",
      "$ref": "./EmailSubtype"
    },
    "order": {
      "description": 'Relative ordering of this email versus other emails of the same email_type. For example if there are 8 total emails with 3 "first emails" and 5 "2+ emails" then the 3 first emails will have order ids of 0, 1, 2 and the 2+ emails will have order ids of 0, 1, 2, 3, 4',
      "type": "int"
    }
  },
  "required": ["email_name", "template", "cta_type", "cta_override", "email_type", "subtype_fields", "order"]
}

export { Email }