Specs

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}) []

Specs

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=="]

Specs

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}

Specs

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.

Specs

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 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}

Specs

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}

Specs

format_data(data()) :: binary()

Specs

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.

Specs

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.

Specs

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.

Specs

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.

Specs

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.

Specs

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.

Specs

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.

Specs

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.

Specs

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.

Specs

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.

Specs

process_headers(list()) :: any()

Callback implementation for HTTPoison.Base.process_headers/1.

Specs

process_request_body(body()) :: body()

Callback implementation for HTTPoison.Base.process_request_body/1.

Specs

process_request_headers(headers()) :: headers()

process_request_headers(list()) :: list()

Automatically adds the correct headers to each API request.

Specs

process_request_options(options()) :: options()

Callback implementation for HTTPoison.Base.process_request_options/1.

Specs

process_request_params(params()) :: params()

Callback implementation for HTTPoison.Base.process_request_params/1.

Specs

process_request_url(url()) :: url()

Callback implementation for HTTPoison.Base.process_request_url/1.

Specs

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

Callback implementation for HTTPoison.Base.process_response/1.

Specs

process_response_body(binary()) :: any()

Callback implementation for HTTPoison.Base.process_response_body/1.

Specs

process_response_chunk(binary()) :: any()

Callback implementation for HTTPoison.Base.process_response_chunk/1.

Specs

process_response_headers(list()) :: any()

Callback implementation for HTTPoison.Base.process_response_headers/1.

Specs

process_response_status_code(integer()) :: any()

Callback implementation for HTTPoison.Base.process_response_status_code/1.

Specs

process_status_code(integer()) :: any()

Callback implementation for HTTPoison.Base.process_status_code/1.

Specs

process_url(url()) :: url()

Callback implementation for HTTPoison.Base.process_url/1.

Specs

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.

Specs

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.

Specs

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)

Specs

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"}])

Specs

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.

Starts HTTPoison and its dependencies.

Specs

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.

Specs

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}