Inttegro.Chimes.Transmission (inttegro v0.2.0)

Copy Markdown View Source

Represents Transmission 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 transmission value.

Functions

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

Types

t()

@type t() :: %Inttegro.Chimes.Transmission{
  address: String.t(),
  created_at: String.t(),
  delivered_at: String.t() | nil,
  email_events: [Inttegro.Chimes.EmailEvent.t()] | nil,
  email_failure_code: String.t() | nil,
  email_failure_reason: String.t() | nil,
  email_status: String.t() | nil,
  error: String.t() | nil,
  failed_at: String.t() | nil,
  gateway: String.t(),
  gateway_message_id: String.t() | nil,
  id: String.t(),
  initialized_at: String.t(),
  last_email_event_at: String.t() | nil,
  mechanism: Inttegro.Chimes.Transport.t(),
  sent_at: String.t() | nil,
  sent_via: Inttegro.Chimes.Transport.t() | nil,
  status: String.t(),
  suppressed_at: String.t() | nil,
  suppression_reason: String.t() | nil
}

The decoded transmission value.

Functions

new!(attrs \\ %{})

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

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