closex v0.1.0 Closex.HTTPClient

A client wrapper around the Close.IO HTTP API.

See: https://developer.close.io/

Link to this section Summary

Functions

Create a new lead: https://developer.close.io/#leads-create-a-new-lead

Create an opportunity: https://developer.close.io/#opportunities-create-an-opportunity

Issues a DELETE request to the given url

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

List or search for leads: https://developer.close.io/#leads-list-or-search-for-leads

Issues a GET request to the given url

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

Fetch a single lead: https://developer.close.io/#leads-retrieve-a-single-lead

Fetch a custom fields details: https://developer.close.io/#custom-fields-fetch-custom-fields-details

List lead statuses for your organization: https://developer.close.io/#lead-statuses-list-lead-statuses-for-your-organization

Fetch a single opportunity: https://developer.close.io/#opportunities-retrieve-an-opportunity

List opportunity statuses for your organization: https://developer.close.io/#opportunity-statuses-list-opportunity-statuses-for-your-organization

Get an organizations details: https://developer.close.io/#organizations-get-an-organizations-details-including-its-current-members

List all users in your organization: https://developer.close.io/#users-list-all-the-users-who-are-members-of-the-same-organizations-as-you-are

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

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

Create an email activity: https://developer.close.io/#activities-create-an-email-activity

Starts HTTPoison and its dependencies

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

Update an existing lead: https://developer.close.io/#leads-update-an-existing-lead

Update an opportunity: https://developer.close.io/#opportunities-update-an-opportunity

Link to this section Types

Link to this type error()
error() :: {:error, any}
Link to this type result()
result() :: success | error
Link to this type success()
success() :: {:ok, map}

Link to this section Functions

Link to this function create_lead(payload, opts \\ [])
create_lead(map, opts) :: result

Create a new lead: https://developer.close.io/#leads-create-a-new-lead

Link to this function create_opportunity(payload, opts \\ [])
create_opportunity(map, opts) :: result

Create an opportunity: https://developer.close.io/#opportunities-create-an-opportunity

Link to this function delete(url, headers \\ [], options \\ [])

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.

Link to this function delete!(url, headers \\ [], options \\ [])

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.

Link to this function find_leads(search_term, opts \\ [])
find_leads(String.t, opts) :: result

List or search for leads: https://developer.close.io/#leads-list-or-search-for-leads

Link to this function get(url, headers \\ [], options \\ [])

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.

Link to this function get!(url, headers \\ [], options \\ [])

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.

Link to this function get_lead(lead_id, opts \\ [])
get_lead(id, opts) :: result

Fetch a single lead: https://developer.close.io/#leads-retrieve-a-single-lead

Link to this function get_lead_custom_field(custom_field_id, opts \\ [])
get_lead_custom_field(id, opts) :: result

Fetch a custom fields details: https://developer.close.io/#custom-fields-fetch-custom-fields-details

Link to this function get_lead_statuses(opts \\ [])
get_lead_statuses(opts) :: result

List lead statuses for your organization: https://developer.close.io/#lead-statuses-list-lead-statuses-for-your-organization

Link to this function get_opportunity(opportunity_id, opts \\ [])
get_opportunity(id, opts) :: result

Fetch a single opportunity: https://developer.close.io/#opportunities-retrieve-an-opportunity

Link to this function get_opportunity_statuses(opts \\ [])
get_opportunity_statuses(opts) :: result

List opportunity statuses for your organization: https://developer.close.io/#opportunity-statuses-list-opportunity-statuses-for-your-organization

Link to this function get_organization(organization_id, opts \\ [])
get_organization(id, opts) :: result

Get an organizations details: https://developer.close.io/#organizations-get-an-organizations-details-including-its-current-members

NOTE: Use American spelling of “organization” since this is how Close.IO refers to it.

Link to this function get_users(opts \\ [])
get_users(opts) :: result

List all users in your organization: https://developer.close.io/#users-list-all-the-users-who-are-members-of-the-same-organizations-as-you-are

Link to this function head(url, headers \\ [], options \\ [])

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.

Link to this function head!(url, headers \\ [], options \\ [])

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.

Link to this function options(url, headers \\ [], options \\ [])

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.

Link to this function options!(url, headers \\ [], options \\ [])

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.

Link to this function patch(url, body, headers \\ [], options \\ [])

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.

Link to this function patch!(url, body, headers \\ [], options \\ [])

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.

Link to this function post(url, body, headers \\ [], options \\ [])

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.

Link to this function post!(url, body, headers \\ [], options \\ [])

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.

Link to this function process_headers(headers)
Link to this function process_request_body(body)
process_request_body(any) :: body
Link to this function process_request_headers(headers)
process_request_headers(headers) :: headers
Link to this function process_request_options(options)
Link to this function process_response_body(body)
process_response_body(binary) :: any
Link to this function process_response_chunk(chunk)
Link to this function process_status_code(status_code)
Link to this function process_url(url)
Link to this function put(url, body \\ "", headers \\ [], options \\ [])

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.

Link to this function put!(url, body \\ "", headers \\ [], options \\ [])

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.

Link to this function request(method, url, body \\ "", headers \\ [], options \\ [])
request(atom, 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:

  • binary, char list or an iolist
  • {:form, [{K, V}, ...]} - send a form url encoded
  • {:file, "/path/to/file"} - send a file
  • {:stream, enumerable} - lazily send a stream of binaries/charlists

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
  • :async - if given :once, will only stream one message at a time, requires call to stream_next
  • :proxy - a proxy to be used for the request; it can be a regular url or a {Host, Port} 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"}])
Link to this function request!(method, url, body \\ "", headers \\ [], options \\ [])
request!(atom, binary, any, headers, Keyword.t) :: HTTPoison.Response.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.

Link to this function send_email(payload, opts \\ [])
send_email(map, opts) :: result

Create an email activity: https://developer.close.io/#activities-create-an-email-activity

Starts HTTPoison and its dependencies.

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

See request!/5 for more detailed information.

Link to this function update_lead(lead_id, payload, opts \\ [])
update_lead(id, map, opts) :: result

Update an existing lead: https://developer.close.io/#leads-update-an-existing-lead

Link to this function update_opportunity(opportunity_id, payload, opts \\ [])
update_opportunity(id, map, opts) :: result

Update an opportunity: https://developer.close.io/#opportunities-update-an-opportunity