Inttegro.Chimes.Recipient (inttegro v0.2.0)

Represents Recipient 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 recipient value.

Functions

new!(attrs \\ %{})

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

Types

t()

@type t() :: %Inttegro.Chimes.Recipient{
  email: Inttegro.Chimes.RecipientEmail.t() | nil,
  name: String.t() | nil,
  phone: Inttegro.Chimes.RecipientPhone.t() | nil,
  type: Inttegro.Chimes.RecipientType.t()
}

The decoded recipient value.

Functions

new!(attrs \\ %{})

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

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