Dnsimple.Client (dnsimple v3.1.0) View Source

Link to this section Summary

Functions

Issues a DELETE request to the given url.

Returns the representation of an empty body in a request.

Issues a GET request to the given url.

Issues a PATCH request to the given url.

Issues a POST request to the given url.

Issues a PUT request to the given url.

Prepends the correct API version to path.

Link to this section Types

Specs

body() :: binary() | {:form, [{atom(), any()}]} | {:file, binary()}

Specs

headers() :: [{binary(), binary()}] | %{required(binary()) => binary()}

Specs

t() :: %Dnsimple.Client{
  access_token: String.t(),
  base_url: String.t(),
  user_agent: String.t()
}

Link to this section Functions

Link to this function

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

View Source

Specs

delete(t(), binary(), Keyword.t()) ::
  {:ok | :error, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}

Issues a DELETE request to the given url.

Specs

empty_body() :: nil

Returns the representation of an empty body in a request.

Examples

iex> Dnsimple.Client.empty_body() nil

Link to this function

execute(client, method, url, body \\ "", all_options \\ [])

View Source
Link to this function

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

View Source

Specs

get(t(), binary(), Keyword.t()) ::
  {:ok | :error, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}

Issues a GET request to the given url.

Link to this function

patch(client, url, body, options \\ [])

View Source

Specs

patch(t(), binary(), body(), Keyword.t()) ::
  {:ok | :error, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}

Issues a PATCH request to the given url.

Link to this function

post(client, url, body, options \\ [])

View Source

Specs

post(t(), binary(), body(), Keyword.t()) ::
  {:ok | :error, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}

Issues a POST request to the given url.

Link to this function

put(client, url, body, options \\ [])

View Source

Specs

put(t(), binary(), body(), Keyword.t()) ::
  {:ok | :error, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}

Issues a PUT request to the given url.

Specs

versioned(String.t()) :: String.t()

Prepends the correct API version to path.

Examples

iex> Dnsimple.Client.versioned "/whoami"
"/v2/whoami"