Inttegro.Chimes.BroadcastRequest (inttegro v0.2.0)

Parameters for Broadcast Request in the Chimes API.

Build this struct with new!/1 and pass it to the corresponding function on Inttegro.Chimes. Required keys are enforced immediately; optional values left as nil are omitted from the request sent to Inttegro.

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()

A validated broadcast request request.

Functions

new!(attrs \\ %{})

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

Types

t()

@type t() :: %Inttegro.Chimes.BroadcastRequest{
  email: Inttegro.Chimes.EmailMessageInput.t() | nil,
  message_template: Inttegro.MessageTemplates.BroadcastRequest.t() | nil,
  purpose: String.t() | nil,
  recipients: [term()],
  request_meta: Inttegro.Broadcasts.RequestMeta.t() | nil,
  sender: String.t() | nil
}

A validated broadcast request request.

Functions

new!(attrs \\ %{})

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

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