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
Functions
@spec cancel(Inttegro.Client.t(), Inttegro.Broadcasts.CancelRequest.t(), keyword()) :: {:ok, Inttegro.Broadcasts.Detail.t()} | {:error, Exception.t()}
Cancel a broadcast before execution wins the cancellation race.
Parameters
client— an authenticatedInttegro.Client.request— aInttegro.Broadcasts.CancelRequestcontaining the operation input.options— request options such as:idempotency_keyand additional:headers.
Returns
Returns {:ok, Inttegro.Broadcasts.Detail.t()} when Inttegro accepts and decodes the operation. Returns
{:error, exception} for API, transport, or decoding failures. A successful API response can
still describe an asynchronous resource that has not reached its terminal state.
Example
request = Inttegro.Broadcasts.CancelRequest.new!(request_attributes)
case Inttegro.Broadcasts.cancel(client, request) do
{:ok, result} -> result
{:error, error} -> {:error, error}
end@spec lookup(Inttegro.Client.t(), Inttegro.Broadcasts.LookupRequest.t(), keyword()) :: {:ok, Inttegro.Broadcasts.Detail.t()} | {:error, Exception.t()}
Look up a broadcast
Parameters
client— an authenticatedInttegro.Client.request— aInttegro.Broadcasts.LookupRequestcontaining the operation input.options— request options such as:idempotency_keyand additional:headers.
Returns
Returns {:ok, Inttegro.Broadcasts.Detail.t()} when Inttegro accepts and decodes the operation. Returns
{:error, exception} for API, transport, or decoding failures. A successful API response can
still describe an asynchronous resource that has not reached its terminal state.
Example
request = Inttegro.Broadcasts.LookupRequest.new!(request_attributes)
case Inttegro.Broadcasts.lookup(client, request) do
{:ok, result} -> result
{:error, error} -> {:error, error}
end