Podium v0.7.0 Podium View Source

Podium is a client for Podium’s public API. It allows you to create new messages and send them, among other things.

All functions accept a keyword list of options as an optional second argument. Those options will be passed through to HTTPoison.Request. Other options include the following:

  • :headers - allows you to add headers to the defaults sent by the library

Link to this section Summary

Link to this section Functions

Link to this function create_conversation_item(item, opts \\ []) View Source
create_conversation_item(Podium.ConversationItem.t(), Keyword.t()) ::
  Podium.ConversationItem.t()

Create a conversation item. Read about conversation items here.

Link to this function create_interaction(interaction, opts \\ []) View Source
create_interaction(Podium.Interaction.t(), Keyword.t()) ::
  Podium.Interaction.t()

Create an interaction. Read about interactions here.

Link to this function create_message(msg, opts \\ []) View Source
create_message(Podium.Message.t(), Keyword.t()) :: Podium.Message.t()

Create a message. Read about messages here.

Link to this function delete_conversation_item(uid, org_uid, opts \\ []) View Source
delete_conversation_item(String.t(), String.t(), Keyword.t()) :: :ok

Delete a conversation item.

Link to this function get_organization(uid, opts \\ []) View Source
get_organization(String.t(), Keyword.t()) :: Podium.Organization.t() | nil

Get an organization and its locations.

Examples

iex> get_organization("f4ac4bcb-e271-5a92-8e43-1d676a8821fa")
%Organization{locations: [%Location{}]}

iex> get_organization("non-existent UID")
nil
Link to this function update_conversation_item(item, opts \\ []) View Source
update_conversation_item(Podium.ConversationItem.t(), Keyword.t()) ::
  Podium.ConversationItem.t()

Update a conversation item.

Link to this function update_interaction(interaction, opts \\ []) View Source
update_interaction(Podium.Interaction.t(), Keyword.t()) ::
  Podium.Interaction.t()

Update an interaction.