Inttegro.MessageTemplates.Variable (inttegro v0.2.0)

Copy Markdown View Source

Represents Variable data in the MessageTemplates 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 reusable email and SMS templates for Chimes.

Templates separate reviewed message content from recipient data supplied at send time. Render a preview before publishing, and treat safety results as part of the template lifecycle rather than as proof that a downstream carrier accepted a message.

Summary

Types

t()

The decoded variable value.

Functions

Builds a Inttegro.MessageTemplates.Variable and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.MessageTemplates.Variable{
  about: String.t() | nil,
  default: term() | nil,
  items: [Inttegro.MessageTemplates.VariableItem.t()] | nil,
  name: String.t(),
  required: boolean(),
  type: Inttegro.MessageTemplates.VariableType.t()
}

The decoded variable value.

Functions

new!(attrs \\ %{})

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

Builds a Inttegro.MessageTemplates.Variable and raises KeyError when a required field is missing.