IntercomX v0.0.1 IntercomX.User View Source

Link to this section Summary

Functions

Archive an user by id, user_id or email

Issues a DELETE request to the given url.

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

User Delete Requests allow you to irrevocably remove data about a User.

Find an User by id, user_id or email

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.

List all the users. The user list is sorted by the created_at field and by default is ordered descending, most recently created first.

List users by email to find all users with the same email address.

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.

Callback implementation for HTTPoison.Base.process_headers/1.

process_url(url) deprecated

Callback implementation for HTTPoison.Base.process_url/1.

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 using a Request struct.

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.

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

Link to this section Types

Link to this section Functions

Archive an user by id, user_id or email

Default

  • id, String - the user's id field

Parameters as map

  • email, String - The email you have defined for the user
  • user_id, String - The user id you have defined for the user

Example

iex> IntercomX.User.archive("5d88be2a75daed4ad2cadccf") // By id iex> IntercomX.User.archive(%{user_id => "ck0wei7ak001p0776yf1o62uu"})

Link to this function

create_friendly_error(body)

View Source
Link to this function

delete(url, headers \\ [], options \\ [])

View Source

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

View Source

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.

User Delete Requests allow you to irrevocably remove data about a User.

After creating a User Delete Request, the User’s data will be hard-deleted within 90 days. This deletion cannot be cancelled or reversed.

Parameters

  • intercom_user_id, String - (Required) The internal ID of the User to irrevocably delete

Example

iex> IntercomX.User.deleteRequest("5d88be2a75daed4ad2cadccf")

Find an User by id, user_id or email

Default

  • id, String - the value of the user's id field

Parameters as map

  • user_id, String - The user id you have defined for the user
  • email, String - The email you have defined for the user

Example

iex> IntercomX.User.find("5d88be2a75daed4ad2cadccf") // by id iex> IntercomX.User.find(%{user_id: "ck0wei7ak001p0776yf1o62uu"}) // by params

Link to this function

get(url, headers \\ [], options \\ [])

View Source

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.

Link to this function

head(url, headers \\ [], options \\ [])

View Source

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

View Source

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.

List all the users. The user list is sorted by the created_at field and by default is ordered descending, most recently created first.

Parameters

  • page, Interger - what page of results to fetch defaults to first page.
  • per_page, Interger - how many results per page defaults to 50, max is 60.
  • order, String - asc or desc. Return the users in ascending or descending order, defaults to desc.
  • sort, String - what field to sort the results by. Valid values: created_at, last_request_at, signed_up_at, updated_at,
  • created_since, String - limit results to users that were created in that last number of days.

Example

iex> IntercomX.User.list() iex> IntercomX.User.list(%{page: 1})

List users by email to find all users with the same email address.

Parameters

  • page, Interger - what page of results to fetch defaults to first page.
  • per_page, Interger - how many results per page defaults to 50, max is 60.

Example

iex> IntercomX.User.listByEmail(%{email: "signed@codaisseur.dev"})

Link to this function

options(url, headers \\ [], options \\ [])

View Source

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

View Source

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

View Source

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

View Source

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

View Source

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

View Source

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)

View Source
process_headers(list()) :: any()
This function is deprecated. Use process_response_headers/1 instead.

Callback implementation for HTTPoison.Base.process_headers/1.

Link to this function

process_request_body(body)

View Source
process_request_body(body()) :: body()

Callback implementation for HTTPoison.Base.process_request_body/1.

Link to this function

process_request_headers(headers)

View Source
process_request_headers(headers()) :: headers()

Callback implementation for HTTPoison.Base.process_request_headers/1.

Link to this function

process_request_options(options)

View Source
process_request_options(options()) :: options()

Callback implementation for HTTPoison.Base.process_request_options/1.

Link to this function

process_request_params(params)

View Source
process_request_params(params()) :: params()

Callback implementation for HTTPoison.Base.process_request_params/1.

Link to this function

process_request_url(url)

View Source
process_request_url(url()) :: url()

Callback implementation for HTTPoison.Base.process_request_url/1.

Link to this function

process_response(response)

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

Callback implementation for HTTPoison.Base.process_response/1.

Link to this function

process_response_body(body)

View Source
process_response_body(binary()) :: any()

Callback implementation for HTTPoison.Base.process_response_body/1.

Link to this function

process_response_chunk(chunk)

View Source
process_response_chunk(binary()) :: any()

Callback implementation for HTTPoison.Base.process_response_chunk/1.

Link to this function

process_response_headers(headers)

View Source
process_response_headers(list()) :: any()

Callback implementation for HTTPoison.Base.process_response_headers/1.

Link to this function

process_response_status_code(status_code)

View Source
process_response_status_code(integer()) :: any()

Callback implementation for HTTPoison.Base.process_response_status_code/1.

Link to this function

process_status_code(status_code)

View Source
process_status_code(integer()) :: any()
This function is deprecated. Use process_response_status_code/1 instead.

Callback implementation for HTTPoison.Base.process_status_code/1.

Link to this function

process_url(url)

View Source
process_url(url()) :: url()
This function is deprecated. Use process_request_url/1 instead.

Callback implementation for HTTPoison.Base.process_url/1.

Link to this function

put(url, body \\ "", headers \\ [], options \\ [])

View Source

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

View Source

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.

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)
Link to this function

request(method, url, body \\ "", headers \\ [], options \\ [])

View Source
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: 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"}])
Link to this function

request!(method, url, body \\ "", headers \\ [], options \\ [])

View Source

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.

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

See request!/5 for more detailed information.

Documentation: https://developers.intercom.com/intercom-api-reference/reference#create-or-update-user

Parameters

  • user_id, String - (Required if no emial is supplied) A unique string identifier for the user. It is required on creation if an email is not supplied.
  • email, String - (Required if no user_id is supplied) The user's email address. It is required on creation if a user_id is not supplied.
  • phone, String - The user's phone number.
  • id, String - The id may be used for user updates.
  • signed_up_at, String - The time the user signed up
  • name, String - The user's full name
  • custom_attributes, Map - A hash of key/value pairs to represent custom data you want to attribute to a user. The key must be an existing Data Attribute.
  • companies, Array - Identifies the companies this user belongs to.
  • last_request_at, String - A UNIX timestamp (in seconds) representing the date the user last visited your application.
  • unsubscribed_from_emails, Boolean - A boolean value representing the users unsubscribed status. default value if not sent is false.
  • update_last_request_at, Boolean - A boolean value, which if true, instructs Intercom to update the users' last_request_at value to the current API service time in UTC. default value if not sent is false.
  • new_session, Boolean - A boolean value, which if true, instructs Intercom to register the request as a session.

Example

iex> IntercomX.User.create(%{user_id => "20", name => "Elix Map"})