batch_elixir v0.2.2 BatchElixir.RestClient.Transactional View Source

Module for interacting with the transactional API

Link to this section Summary

Functions

Send an 1-to-1 interaction one or more users

Link to this section Types

Link to this type

t() View Source
t() :: %BatchElixir.RestClient.Transactional{
  custom_payload: String.t(),
  deeplink: String.t(),
  gcm_collapse_key: map(),
  group_id: String.t(),
  labels: [String.t(), ...],
  landing: BatchElixir.RestClient.Transactional.Landing.t(),
  media: BatchElixir.RestClient.Transactional.Media.t(),
  message: BatchElixir.RestClient.Transactional.Message.t(),
  priority: String.t(),
  recipients: BatchElixir.RestClient.Transactional.Recipients.t(),
  sandbox: boolean(),
  time_to_live: pos_integer(),
  wp_template: String.t()
}

Link to this section Functions

Link to this function

send(api_key, transactional) View Source
send(String.t(), BatchElixir.RestClient.Transactional.t()) ::
  {:ok, String.t()} | {:error, any()}

Send an 1-to-1 interaction one or more users.

Parameters

  • transactional: Request structure
  • api_key: API key of the application

Examples

iex>BatchElixir.RestClient.Transactional.send(%BatchElixir.RestClient.Transactional{}, "my_api_key")
{:ok, "returned token"}

iex>BatchElixir.RestClient.Transactional.send(%BatchElixir.RestClient.Transactional{}, "my_api_key")
{:error, "something bad happend"}