ExTwilio v0.2.0 ExTwilio.Api
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.
Summary
Functions
Create a new resource in the Twilio API with a POST request
Issues a DELETE request to the given url
Issues a DELETE request to the given url, raising an exception in case of failure
Destroy an existing resource in the Twilio Api
Find a given resource in the Twilio API by its SID
Issues a GET request to the given url
Issues a GET request to the given url, raising an exception in case of failure
Issues a HEAD request to the given url
Issues a HEAD request to the given url, raising an exception in case of failure
Issues an OPTIONS request to the given url
Issues a OPTIONS request to the given url, raising an exception in case of failure
Issues a PATCH request to the given url
Issues a PATCH request to the given url, raising an exception in case of failure
Issues a POST request to the given url
Issues a POST request to the given url, raising an exception in case of failure
Automatically adds the correct headers to each API request
Issues a PUT request to the given url
Issues a PUT request to the given url, raising an exception in case of failure
Issues an HTTP request with the given method to the given url
Issues an HTTP request with the given method to the given url, raising an exception in case of failure
Starts HTTPoison and its dependencies
Update an existing resource in the Twilio Api
Types
Functions
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, "No 'To' number is specified", 400}
Specs
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.
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, "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, message, code}
. The code
is the HTTP status code returned by the Twilio API, for example, 404.
ExTwilio.Api.find(ExTwilio.Call, "nonexistent sid")
{:error, "The requested resource couldn't be found...", 404}
Specs
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.
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
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.
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
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.
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
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.
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
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.
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_request_headers(list) :: list
Automatically adds the correct headers to each API request.
Specs
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.
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
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: * binary, char list or an iolist * {:form, [{K, V}, ...]}
- send a form url encoded * {:file, "/path/to/file"}
- send a file
Options: * :timeout
- timeout to establish a connection, in milliseconds. Default is 8000 * :recv_timeout
- timeout used when receiving a connection. Default is 5000 * :stream_to
- a PID to stream the response to * :proxy
- a proxy to be used for the request; it can be a regular url or a {Host, Proxy}
tuple * :proxy_auth
- proxy authentication {User, Password}
tuple * :ssl
- SSL options supported by the ssl
erlang module * :follow_redirect
- a boolean that causes redirects to be followed * :max_redirect
- an integer denoting the maximum number of redirects to follow * :params
- an enumerable consisting of two-item tuples that will be appended to the url as query string parameters
Timeouts can be an integer or :infinity
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"}])
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.
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, "The requested resource ... was not found", 404}