Inttegro.Broadcasts.RequestMeta (inttegro v0.2.0)

Copy Markdown View Source

Parameters for Request Meta in the Broadcasts API.

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

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

A validated request meta request.

Functions

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

Types

t()

@type t() :: %Inttegro.Broadcasts.RequestMeta{idempotency_key: String.t() | nil}

A validated request meta request.

Functions

new!(attrs \\ %{})

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

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