Inttegro.MessageTemplates.CreateEmailRequest (inttegro v0.2.0)

Copy Markdown View Source

Parameters for Create Email Request in the MessageTemplates API.

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

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

A validated create email request request.

Functions

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

Types

t()

@type t() :: %Inttegro.MessageTemplates.CreateEmailRequest{
  about: String.t() | nil,
  attachments: [String.t()] | nil,
  channel: Inttegro.MessageTemplates.Channel.t(),
  email: Inttegro.MessageTemplates.EmailContentInput.t(),
  locale: String.t() | nil,
  name: String.t(),
  purpose: String.t(),
  variables: [Inttegro.MessageTemplates.VariableInput.t()] | nil
}

A validated create email request request.

Functions

new!(attrs \\ %{})

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

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