Inttegro.Chimes.BroadcastCreationDetail (inttegro v0.2.0)

Copy Markdown View Source

Represents Broadcast Creation Detail 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 broadcast creation detail value.

Functions

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

Types

t()

@type t() :: %Inttegro.Chimes.BroadcastCreationDetail{
  content: String.t(),
  created_at: String.t(),
  customer_ids: [String.t()] | nil,
  email: Inttegro.Chimes.EmailMessage.t() | nil,
  id: String.t(),
  idempotency_key: String.t() | nil,
  purpose: String.t() | nil,
  recipients: [String.t()],
  send_after: String.t(),
  sender_id: String.t()
}

The decoded broadcast creation detail value.

Functions

new!(attrs \\ %{})

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

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