ExTwilio

v0.5.0

ExTwilio v0.5.0 ExTwilio.Parser View Source

A JSON parser tuned specifically for Twilio API responses. Based on Poison’s excellent JSON decoder.

Link to this section Summary

Types

error()
http_status_code()
key()
metadata()
parsed_list_response()
parsed_response()
success()
success_delete()
success_list()

Functions

parse(response, module)

Parse a response expected to contain a single resource. If you pass in a module as the first argument, the JSON will be parsed into that module’s __struct__

parse_list(response, module, key)

Parse a response expected to contain multiple resources. If you pass in a module as the first argument, the JSON will be parsed into that module’s __struct__

Link to this section Types

Link to this type http_status_code() View Source 
http_status_code() :: number
Link to this type metadata() View Source 
metadata() :: map
Link to this type parsed_list_response() View Source 
parsed_list_response() :: success_list | error
Link to this type parsed_response() View Source 
parsed_response() :: success | error
Link to this type success() View Source 
success() :: {:ok, [map]}
Link to this type success_delete() View Source 
success_delete() :: :ok
Link to this type success_list() View Source 
success_list() :: {:ok, [map], metadata}

Link to this section Functions

Link to this function parse(response, module) View Source 
parse(HTTPoison.Response.t, module) :: success | error

Parse a response expected to contain a single resource. If you pass in a module as the first argument, the JSON will be parsed into that module’s __struct__.

Examples

Given you have a module named Resource, defined like this:

defmodule Resource do
  defstruct sid: nil
end

You can parse JSON into that module’s struct like so:

iex> response = %{body: "{ \"sid\": \"AD34123\" }", status_code: 200}
...> ExTwilio.Parser.parse(response, Resource)
{:ok, %Resource{sid: "AD34123"}}

You can also parse into a regular map if you want.

iex> response = %{body: "{ \"sid\": \"AD34123\" }", status_code: 200}
...> ExTwilio.Parser.parse(response, %{})
{:ok, %{"sid" => "AD34123"}}
Link to this function parse_list(response, module, key) View Source 
parse_list(HTTPoison.Response.t, module, key) ::
  success_list |
  error

Parse a response expected to contain multiple resources. If you pass in a module as the first argument, the JSON will be parsed into that module’s __struct__.

Examples

Given you have a module named Resource, defined like this:

defmodule Resource do
  defstruct sid: nil
end

And the JSON you are parsing looks like this:

{
  "resources": [{
    "sid": "first"
  }, {
    "sid": "second"
  }],
  "next_page": 10
}

You can parse the the JSON like this:

ExTwilio.Parser.parse_list(json, Resource, "resources")
{:ok, [%Resource{sid: "first"}, %Resource{sid: "second"}], %{"next_page" => 10}}