ReceivedSummary

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/cherami-to/json-schema/cherami-to-received-summary-schema.json",
  "title": "ReceivedSummary",
  "x-generated": "2026-11-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cherami-to-openapi.yml#/components/schemas/ReceivedSummary",
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Cherami resource ID."
        },
        "inbox_id": {
          "type": "string",
          "description": "Cherami resource ID."
        },
        "thread_id": {
          "anyOf": [
            {
              "type": "string",
              "description": "Cherami resource ID."
            },
            {
              "type": "null"
            }
          ]
        },
        "envelope_from": {
          "type": "string"
        },
        "envelope_to": {
          "type": "string"
        },
        "subject": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "received_at": {
          "type": "string",
          "description": "UTC timestamp with milliseconds.",
          "format": "date-time",
          "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
        },
        "processing_status": {
          "const": "ready"
        },
        "labels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "preview": {
          "anyOf": [
            {
              "$ref": "#/$defs/Preview"
            },
            {
              "type": "null"
            }
          ]
        },
        "from": {
          "anyOf": [
            {
              "$ref": "#/$defs/ParsedAddress"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "id",
        "inbox_id",
        "thread_id",
        "envelope_from",
        "envelope_to",
        "subject",
        "received_at",
        "processing_status",
        "labels",
        "preview",
        "from"
      ]
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Cherami resource ID."
        },
        "inbox_id": {
          "type": "string",
          "description": "Cherami resource ID."
        },
        "thread_id": {
          "anyOf": [
            {
              "type": "string",
              "description": "Cherami resource ID."
            },
            {
              "type": "null"
            }
          ]
        },
        "envelope_from": {
          "type": "string"
        },
        "envelope_to": {
          "type": "string"
        },
        "subject": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "received_at": {
          "type": "string",
          "description": "UTC timestamp with milliseconds.",
          "format": "date-time",
          "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
        },
        "processing_status": {
          "type": "string",
          "enum": [
            "pending",
            "processing",
            "failed"
          ]
        },
        "labels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "preview": {
          "type": "null"
        }
      },
      "required": [
        "id",
        "inbox_id",
        "thread_id",
        "envelope_from",
        "envelope_to",
        "subject",
        "received_at",
        "processing_status",
        "labels",
        "preview"
      ]
    }
  ],
  "$defs": {
    "ParsedAddress": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "address": {
              "type": "string"
            }
          },
          "required": [
            "name",
            "address"
          ]
        },
        {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "group": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "address": {
                    "type": "string"
                  }
                },
                "required": [
                  "name",
                  "address"
                ]
              }
            }
          },
          "required": [
            "name",
            "group"
          ]
        }
      ],
      "description": "Mailbox or group from the message headers, written by the sender and not verified."
    },
    "Preview": {
      "type": "object",
      "properties": {
        "text": {
          "type": "string",
          "description": "Start of the chosen text, whitespace collapsed; empty when the message added no new text.",
          "maxLength": 300
        },
        "truncated": {
          "type": "boolean",
          "description": "true when the chosen text was longer than the excerpt."
        },
        "source": {
          "type": "string",
          "enum": [
            "reply_text",
            "text",
            "html"
          ],
          "description": "Which text the excerpt comes from."
        }
      },
      "required": [
        "text",
        "truncated",
        "source"
      ]
    }
  }
}