Inttegro.Broadcasts.Detail (inttegro v0.2.0)

Represents Detail data in the Broadcasts 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.

Manages broadcasts sent through Inttegro Chimes.

A broadcast applies one message to a larger recipient set and records its own delivery state. Use this API to inspect or cancel a broadcast after it has been created by a messaging flow.

Summary

Types

t()

The decoded detail value.

Functions

new!(attrs \\ %{})

Builds a Inttegro.Broadcasts.Detail and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.Broadcasts.Detail{
  chime_ids: [String.t()] | nil,
  content: String.t(),
  created_at: String.t(),
  customer_ids: [String.t()] | nil,
  email: Inttegro.Chimes.EmailMessage.t() | nil,
  errors: [Inttegro.Broadcasts.Error.t()] | nil,
  executed_at: String.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 detail value.

Functions

new!(attrs \\ %{})

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

Builds a Inttegro.Broadcasts.Detail and raises KeyError when a required field is missing.