ExportState

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/cherishedbook-com/json-schema/cherishedbook-com-export-state-schema.json",
  "title": "ExportState",
  "x-generated": "2026-11-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cherishedbook-com-openapi.yml#/components/schemas/ExportState",
  "type": "object",
  "required": [
    "export_id",
    "type",
    "status",
    "ready",
    "message"
  ],
  "properties": {
    "export_id": {
      "type": "integer"
    },
    "type": {
      "type": "string",
      "enum": [
        "pdf",
        "zip",
        "slideshow"
      ]
    },
    "status": {
      "type": "string"
    },
    "music": {
      "type": "string",
      "description": "Slideshow only. The track chosen, or `none`."
    },
    "faith_cards": {
      "type": "boolean",
      "description": "Slideshow only. Whether it begins and ends with a prayer from their tradition."
    },
    "ready": {
      "type": "boolean",
      "description": "Only true once the file exists, has not expired, and (for a PDF or slideshow) the memorial still has Premium. A refund ends Premium downloads; buying Premium again restores them."
    },
    "download_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "Null until ready. Never offer a link before then."
    },
    "message": {
      "type": "string",
      "description": "Written for a person to hear."
    }
  }
}