Inttegro.Chimes.Chime (inttegro v0.2.0)

Represents Chime 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 chime value.

Functions

new!(attrs \\ %{})

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

Types

t()

@type t() :: %Inttegro.Chimes.Chime{
  created_at: String.t(),
  custom_data: %{optional(String.t()) => String.t()} | nil,
  customer_id: String.t() | nil,
  email: Inttegro.Chimes.EmailMessage.t() | nil,
  full_message: String.t(),
  id: String.t(),
  idempotency_key: String.t() | nil,
  purpose: String.t() | nil,
  recipient: Inttegro.Chimes.Recipient.t(),
  sender_id: String.t(),
  transmission: Inttegro.Chimes.Transmission.t() | nil
}

The decoded chime value.

Functions

new!(attrs \\ %{})

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

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