ExTwilio v0.8.0 ExTwilio.Api View Source

Provides a basic HTTP interface to allow easy communication with the Twilio API, by wrapping HTTPotion.

Examples

Requests are made to the Twilio API by passing in a resource module into one of this Api module's functions. The correct URL to the resource is inferred from the module name.

ExTwilio.Api.find(Resource, "sid")
%Resource{ sid: "sid", ... }

Items are returned as instances of the given module's struct. For more details, see the documentation for each function.

Link to this section Summary

Types

body()

data()

headers()

method()

options()

params()

request()

url()

Functions

auth_header(options \\ [])

Builds custom auth header for subaccounts

auth_header(headers, arg2)

Builds custom auth header for subaccounts handles master account case if :"Authorization" custom header isn't present

create(module, data, options \\ [])

Create a new resource in the Twilio API with a POST request.

delete(url, headers \\ [], options \\ [])

Issues a DELETE request to the given url.

delete!(url, headers \\ [], options \\ [])

Issues a DELETE request to the given url, raising an exception in case of failure.

destroy(module, sid, options \\ [])

Destroy an existing resource in the Twilio Api.

find(module, sid, options \\ [])

Find a given resource in the Twilio API by its SID.

format_data(data)

get(url, headers \\ [], options \\ [])

Issues a GET request to the given url.

get!(url, headers \\ [], options \\ [])

Issues a GET request to the given url, raising an exception in case of failure.

head(url, headers \\ [], options \\ [])

Issues a HEAD request to the given url.

head!(url, headers \\ [], options \\ [])

Issues a HEAD request to the given url, raising an exception in case of failure.

options(url, headers \\ [], options \\ [])

Issues an OPTIONS request to the given url.

options!(url, headers \\ [], options \\ [])

Issues a OPTIONS request to the given url, raising an exception in case of failure.

patch(url, body, headers \\ [], options \\ [])

Issues a PATCH request to the given url.

patch!(url, body, headers \\ [], options \\ [])

Issues a PATCH request to the given url, raising an exception in case of failure.

post(url, body, headers \\ [], options \\ [])

Issues a POST request to the given url.

post!(url, body, headers \\ [], options \\ [])

Issues a POST request to the given url, raising an exception in case of failure.

process_headers(headers) deprecated

Callback implementation for HTTPoison.Base.process_headers/1.

process_request_body(body)

Callback implementation for HTTPoison.Base.process_request_body/1.

process_request_headers(headers)

Automatically adds the correct headers to each API request.

process_request_options(options)

Callback implementation for HTTPoison.Base.process_request_options/1.

process_request_params(params)

Callback implementation for HTTPoison.Base.process_request_params/1.

process_request_url(url)

Callback implementation for HTTPoison.Base.process_request_url/1.

process_response(response)

Callback implementation for HTTPoison.Base.process_response/1.

process_response_body(body)

Callback implementation for HTTPoison.Base.process_response_body/1.

process_response_chunk(chunk)

Callback implementation for HTTPoison.Base.process_response_chunk/1.

process_response_headers(headers)

Callback implementation for HTTPoison.Base.process_response_headers/1.

process_response_status_code(status_code)

Callback implementation for HTTPoison.Base.process_response_status_code/1.

process_status_code(status_code) deprecated

Callback implementation for HTTPoison.Base.process_status_code/1.

process_url(url) deprecated

Callback implementation for HTTPoison.Base.process_url/1.

put(url, body \\ "", headers \\ [], options \\ [])

Issues a PUT request to the given url.

put!(url, body \\ "", headers \\ [], options \\ [])

Issues a PUT request to the given url, raising an exception in case of failure.

request(request)

Issues an HTTP request using a Request struct.

request(method, url, body \\ "", headers \\ [], options \\ [])

Issues an HTTP request with the given method to the given url.

request!(method, url, body \\ "", headers \\ [], options \\ [])

Issues an HTTP request with the given method to the given url, raising an exception in case of failure.

start()

Starts HTTPoison and its dependencies.

stream_next(resp)

Requests the next message to be streamed for a given HTTPoison.AsyncResponse.

update(module, sid, data, options \\ [])

Update an existing resource in the Twilio Api.

Link to this section Types

body()

body() :: HTTPoison.Base.body()

data()

data() :: map() | list()

headers()

headers() :: HTTPoison.Base.headers()

method()

method() :: HTTPoison.Base.method()

options()

options() :: HTTPoison.Base.options()

params()

params() :: HTTPoison.Base.params()

request()

request() :: HTTPoison.Base.request()

url()

url() :: HTTPoison.Base.url()

Link to this section Functions

auth_header(options \\ [])

auth_header(options :: list()) :: list()

Builds custom auth header for subaccounts

Examples

iex> ExTwilio.Api.auth_header([account: 123, token: 123]) ["Authorization": "Basic MTIzOjEyMw=="]

iex> ExTwilio.Api.auth_header([], {nil, 2}) []

auth_header(headers, arg2)

auth_header(headers :: list(), auth :: tuple()) :: list()

Builds custom auth header for subaccounts handles master account case if :"Authorization" custom header isn't present

Examples

iex> ExTwilio.Api.auth_header([], {123, 123}) ["Authorization": "Basic MTIzOjEyMw=="]

iex> ExTwilio.Api.auth_header(["Authorization": "Basic BASE64=="], {123, 123}) ["Authorization": "Basic BASE64=="]

create(module, data, options \\ [])

create(atom(), data(), list()) ::
  ExTwilio.Parser.success() | ExTwilio.Parser.error()

Create a new resource in the Twilio API with a POST request.

Examples

ExTwilio.Api.create(ExTwilio.Call, [to: "1112223333", from: "4445556666"])
{:ok, %Call{ ... }}

ExTwilio.Api.create(ExTwilio.Call, [])
{:error, %{"message" => "No 'To' number is specified"}, 400}

delete(url, headers \\ [], options \\ [])

delete(binary(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues a DELETE request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

delete!(url, headers \\ [], options \\ [])

delete!(binary(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a DELETE request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

destroy(module, sid, options \\ [])

Destroy an existing resource in the Twilio Api.

Examples

ExTwilio.Api.destroy(ExTwilio.Call, "<sid>")
:ok

ExTwilio.Api.destroy(ExTwilio.Call, "nonexistent")
{:error, %{"message" => The requested resource ... was not found"}, 404}

find(module, sid, options \\ [])

find(atom(), String.t() | nil, list()) ::
  ExTwilio.Parser.success() | ExTwilio.Parser.error()

Find a given resource in the Twilio API by its SID.

Examples

If the resource was found, find/2 will return a two-element tuple in this format, {:ok, item}.

ExTwilio.Api.find(ExTwilio.Call, "<sid here>")
{:ok, %Call{ ... }}

If the resource could not be loaded, find/2 will return a 3-element tuple in this format, {:error, error_body, code}. The code is the HTTP status code returned by the Twilio API, for example, 404.

ExTwilio.Api.find(ExTwilio.Call, "nonexistent sid")
{:error, %{"message" => The requested resource couldn't be found..."}, 404}

format_data(data)

format_data(data()) :: binary()

get(url, headers \\ [], options \\ [])

get(binary(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues a GET request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

get!(url, headers \\ [], options \\ [])

get!(binary(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a GET request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

head(url, headers \\ [], options \\ [])

head(binary(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues a HEAD request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

head!(url, headers \\ [], options \\ [])

head!(binary(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a HEAD request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

options(url, headers \\ [], options \\ [])

options(binary(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues an OPTIONS request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

options!(url, headers \\ [], options \\ [])

options!(binary(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a OPTIONS request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

patch(url, body, headers \\ [], options \\ [])

patch(binary(), any(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues a PATCH request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

patch!(url, body, headers \\ [], options \\ [])

patch!(binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a PATCH request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

post(url, body, headers \\ [], options \\ [])

post(binary(), any(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues a POST request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

post!(url, body, headers \\ [], options \\ [])

post!(binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a POST request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

process_headers(headers)

process_headers(list()) :: any()

This function is deprecated. Use process_response_headers/1 instead.

Callback implementation for HTTPoison.Base.process_headers/1.

process_request_body(body)

process_request_body(body()) :: body()

Callback implementation for HTTPoison.Base.process_request_body/1.

process_request_headers(headers)

process_request_headers(headers()) :: headers()

process_request_headers(list()) :: list()

Automatically adds the correct headers to each API request.

process_request_options(options)

process_request_options(options()) :: options()

Callback implementation for HTTPoison.Base.process_request_options/1.

process_request_params(params)

process_request_params(params()) :: params()

Callback implementation for HTTPoison.Base.process_request_params/1.

process_request_url(url)

process_request_url(url()) :: url()

Callback implementation for HTTPoison.Base.process_request_url/1.

process_response(response)

process_response(HTTPoison.Base.response()) :: any()

Callback implementation for HTTPoison.Base.process_response/1.

process_response_body(body)

process_response_body(binary()) :: any()

Callback implementation for HTTPoison.Base.process_response_body/1.

process_response_chunk(chunk)

process_response_chunk(binary()) :: any()

Callback implementation for HTTPoison.Base.process_response_chunk/1.

process_response_headers(headers)

process_response_headers(list()) :: any()

Callback implementation for HTTPoison.Base.process_response_headers/1.

process_response_status_code(status_code)

process_response_status_code(integer()) :: any()

Callback implementation for HTTPoison.Base.process_response_status_code/1.

process_status_code(status_code)

process_status_code(integer()) :: any()

This function is deprecated. Use process_response_status_code/1 instead.

Callback implementation for HTTPoison.Base.process_status_code/1.

process_url(url)

process_url(url()) :: url()

This function is deprecated. Use process_request_url/1 instead.

Callback implementation for HTTPoison.Base.process_url/1.

put(url, body \\ "", headers \\ [], options \\ [])

put(binary(), any(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues a PUT request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

put!(url, body \\ "", headers \\ [], options \\ [])

put!(binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a PUT request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

request(request)

request(HTTPoison.Request.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues an HTTP request using a Request struct.

This function returns {:ok, response} or {:ok, async_response} if the request is successful, {:error, reason} otherwise.

Examples

request = %HTTPoison.Request{
  method: :post,
  url: "https://my.website.com",
  body: "{\"foo\": 3}",
  headers: [{"Accept", "application/json"}]
}

request(request)

request(method, url, body \\ "", headers \\ [], options \\ [])

request(method(), binary(), any(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues an HTTP request with the given method to the given url.

This function is usually used indirectly by get/3, post/4, put/4, etc

Args:

method - HTTP method as an atom (:get, :head, :post, :put, :delete, etc.)
url - target url as a binary string or char list
body - request body. See more below
headers - HTTP headers as an orddict (e.g., [{"Accept", "application/json"}])
options - Keyword list of options

Body: see type HTTPoison.Request

Options: see type HTTPoison.Request

This function returns {:ok, response} or {:ok, async_response} if the request is successful, {:error, reason} otherwise.

Examples

request(:post, "https://my.website.com", "{\"foo\": 3}", [{"Accept", "application/json"}])

request!(method, url, body \\ "", headers \\ [], options \\ [])

request!(method(), binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues an HTTP request with the given method to the given url, raising an exception in case of failure.

request!/5 works exactly like request/5 but it returns just the response in case of a successful request, raising an exception in case the request fails.

start()

Starts HTTPoison and its dependencies.

stream_next(resp)

stream_next(HTTPoison.AsyncResponse.t()) ::
  {:ok, HTTPoison.AsyncResponse.t()} | {:error, HTTPoison.Error.t()}

Requests the next message to be streamed for a given HTTPoison.AsyncResponse.

See request!/5 for more detailed information.

update(module, sid, data, options \\ [])

update(atom(), String.t(), data(), list()) ::
  ExTwilio.Parser.success() | ExTwilio.Parser.error()

Update an existing resource in the Twilio Api.

Examples

ExTwilio.Api.update(ExTwilio.Call, "<sid>", [status: "canceled"])
{:ok, %Call{ status: "canceled" ... }}

ExTwilio.Api.update(ExTwilio.Call, "nonexistent", [status: "complete"])
{:error, %{"message" => "The requested resource ... was not found"}, 404}