Inttegro.Chimes.EmailEvent (inttegro v0.2.0)

Represents Email Event data in the Chimes API.

Inttegro decodes API responses into this struct. Required fields are always present; optional fields are nil when they do not apply or were not returned. Follow the linked types in t/0 for nested domain values.

Sends and schedules transactional messages.

Chimes deliver email or SMS content to inline recipients, saved customers, or template-defined recipients. A returned chime records rendering, safety, and transmission results; delivery may continue asynchronously after the API call succeeds.

Summary

Types

t()

The decoded email event value.

Functions

new!(attrs \\ %{})

Builds a Inttegro.Chimes.EmailEvent and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.Chimes.EmailEvent{
  bounce_sub_type: String.t() | nil,
  bounce_type: String.t() | nil,
  complaint_sub_type: String.t() | nil,
  id: String.t(),
  occurred_at: String.t(),
  provider: String.t(),
  provider_message_id: String.t(),
  reason: String.t() | nil,
  reason_code: String.t() | nil,
  recipient: String.t() | nil,
  source: String.t() | nil,
  suppress_recipient: boolean() | nil,
  temporary: boolean() | nil,
  type: String.t()
}

The decoded email event value.

Functions

new!(attrs \\ %{})

@spec new!(map() | keyword()) :: t()

Builds a Inttegro.Chimes.EmailEvent and raises KeyError when a required field is missing.