Inttegro.Broadcasts.Error (inttegro v0.2.0)

Represents Error 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 error value.

Functions

new!(attrs \\ %{})

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

Types

t()

@type t() :: %Inttegro.Broadcasts.Error{
  fix_code: String.t() | nil,
  recipient: String.t() | nil,
  type: String.t() | nil
}

The decoded error value.

Functions

new!(attrs \\ %{})

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

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