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

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

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

@spec delete(binary(), headers(), Keyword.t()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.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.

@spec delete!(binary(), headers(), Keyword.t()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.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}

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

@spec 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.

@spec 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.

@spec 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.

@spec 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.

@spec options(binary(), headers(), Keyword.t()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.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.

@spec options!(binary(), headers(), Keyword.t()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.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.

@spec patch(binary(), any(), headers(), Keyword.t()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.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.

@spec patch!(binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.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.

@spec post(binary(), any(), headers(), Keyword.t()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.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.

@spec post!(binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.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.

@spec process_headers(list()) :: any()

Callback implementation for HTTPoison.Base.process_headers/1.

@spec process_request_body(body()) :: body()

Callback implementation for HTTPoison.Base.process_request_body/1.

@spec process_request_headers(headers()) :: headers()

Callback implementation for HTTPoison.Base.process_request_headers/1.

@spec process_request_options(options()) :: options()

Callback implementation for HTTPoison.Base.process_request_options/1.

@spec process_request_params(params()) :: params()

Callback implementation for HTTPoison.Base.process_request_params/1.

@spec process_request_url(url()) :: url()

Callback implementation for HTTPoison.Base.process_request_url/1.

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

Callback implementation for HTTPoison.Base.process_response/1.

@spec process_response_body(binary()) :: any()

Callback implementation for HTTPoison.Base.process_response_body/1.

@spec process_response_chunk(binary()) :: any()

Callback implementation for HTTPoison.Base.process_response_chunk/1.

@spec process_response_headers(list()) :: any()

Callback implementation for HTTPoison.Base.process_response_headers/1.

@spec process_response_status_code(integer()) :: any()

Callback implementation for HTTPoison.Base.process_response_status_code/1.

@spec process_status_code(integer()) :: any()

Callback implementation for HTTPoison.Base.process_status_code/1.

@spec process_url(url()) :: url()

Callback implementation for HTTPoison.Base.process_url/1.

@spec put(binary(), any(), headers(), Keyword.t()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.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.

@spec put!(binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.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.

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

Issues an HTTP request using an HTTPoison.Request struct.

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

Redirect handling

If the option :follow_redirect is given, HTTP redirects are automatically follow if the method is set to :get or :head and the response's status_code is 301, 302 or 307.

If the method is set to :post, then the only status_code that get's automatically followed is 303.

If any other method or status_code is returned, then this function returns a returns a {:ok, %HTTPoison.MaybeRedirect{}} containing the redirect_url for you to re-request with the method set to :get.

Examples

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

request(request)

@spec request(method(), binary(), any(), headers(), Keyword.t()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.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}, {:ok, async_response}, or {:ok, maybe_redirect} if the request is successful, {:error, reason} otherwise.

Redirect handling

If the option :follow_redirect is given, HTTP redirects are automatically follow if the method is set to :get or :head and the response's status_code is 301, 302 or 307.

If the method is set to :post, then the only status_code that get's automatically followed is 303.

If any other method or status_code is returned, then this function returns a returns a {:ok, %HTTPoison.MaybeRedirect{}} containing the redirect_url for you to re-request with the method set to :get.

Examples

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

@spec request!(HTTPoison.Request.t()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

Issues an HTTP request an HTTPoison.Request struct. exception in case of failure.

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

@spec request!(method(), binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.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.

@spec 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.

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