closex v1.2.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
Creates a task for the given lead and text. Optional parameters
Issues a DELETE request to the given url, raising an exception in case of failure
Issues a DELETE request to the given url
List or search for leads: https://developer.close.io/#leads-list-or-search-for-leads
List or search for opportunities: https://developer.close.io/#opportunities-list-or-filter-opportunities
list or search for phone numbers: https://developer.close.io/#phone-numbers
Issues a GET request to the given url, raising an exception in case of failure
Issues a GET request to the given url
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
Get opportunities: https://developer.close.io/#opportunities
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, raising an exception in case of failure
Issues a HEAD request to the given url
Log a call activity manually: https://developer.close.io/#activities-log-a-call-activity-manually
Issues a OPTIONS request to the given url, raising an exception in case of failure
Issues an OPTIONS request to the given url
Issues a PATCH request to the given url, raising an exception in case of failure
Issues a PATCH request to the given url
Issues a POST request to the given url, raising an exception in case of failure
Issues a POST request to the given url
Callback implementation for HTTPoison.Base.process_headers/1
Callback implementation for HTTPoison.Base.process_request_body/1
Callback implementation for HTTPoison.Base.process_request_params/1
Callback implementation for HTTPoison.Base.process_request_url/1
Callback implementation for HTTPoison.Base.process_response/1
Callback implementation for HTTPoison.Base.process_response_chunk/1
Callback implementation for HTTPoison.Base.process_response_headers/1
Callback implementation for HTTPoison.Base.process_response_status_code/1
Callback implementation for HTTPoison.Base.process_status_code/1
Issues a PUT request to the given url, raising an exception in case of failure
Issues a PUT request to the given url
Issues an HTTP request with the given method to the given url, raising an exception in case of failure
Issues an HTTP request using a Request
struct
Issues an HTTP request with the given method to the given url
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
Updates a task. Optional parameters
Link to this section Types
Link to this section 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
Creates a task for the given lead and text. Optional parameters
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.
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.
List or search for leads: https://developer.close.io/#leads-list-or-search-for-leads
List or search for opportunities: https://developer.close.io/#opportunities-list-or-filter-opportunities
list or search for phone numbers: https://developer.close.io/#phone-numbers
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.
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.
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
Get opportunities: https://developer.close.io/#opportunities
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
NOTE: Use American spelling of “organization” since this is how Close.IO refers to it.
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
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.
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.
Log a call activity manually: https://developer.close.io/#activities-log-a-call-activity-manually
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.
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.
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.
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.
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.
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.
Callback implementation for HTTPoison.Base.process_headers/1
.
Callback implementation for HTTPoison.Base.process_request_body/1
.
Callback implementation for HTTPoison.Base.process_request_params/1
.
Callback implementation for HTTPoison.Base.process_request_url/1
.
Callback implementation for HTTPoison.Base.process_response/1
.
Callback implementation for HTTPoison.Base.process_response_chunk/1
.
Callback implementation for HTTPoison.Base.process_response_headers/1
.
Callback implementation for HTTPoison.Base.process_response_status_code/1
.
Callback implementation for HTTPoison.Base.process_status_code/1
.
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.
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.
request!(atom(), 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.
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(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 listbody
- request body. See more belowheaders
- 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"}])
Create an email activity: https://developer.close.io/#activities-create-an-email-activity
Starts HTTPoison and its dependencies.
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 an existing lead: https://developer.close.io/#leads-update-an-existing-lead
Update an opportunity: https://developer.close.io/#opportunities-update-an-opportunity
Updates a task. Optional parameters