ExFtx.HTTPClient (ex_ftx v0.0.14)

Link to this section Summary

Link to this section Types

Link to this type

auth_response()

Specs

auth_response() :: {:ok, ExFtx.JsonResponse.t()} | {:error, error_reason()}
Link to this type

credentials()

Specs

credentials() :: ExFtx.Credentials.t()
Link to this type

error_reason()

Specs

Link to this type

non_auth_response()

Specs

non_auth_response() :: {:ok, ExFtx.JsonResponse.t()} | {:error, error_reason()}

Specs

params() :: map()

Specs

path() :: String.t()

Specs

uri() :: String.t()

Specs

verb() :: :get | :post | :put | :delete

Link to this section Functions

Specs

api_path() :: String.t()
Link to this function

auth_delete(path, credentials, params \\ %{})

Specs

auth_delete(path(), credentials(), params()) :: auth_response()
Link to this function

auth_get(path, credentials, params)

Specs

auth_get(path(), credentials(), params()) :: auth_response()
Link to this function

auth_post(path, credentials, params)

Specs

auth_post(path(), credentials(), params()) :: auth_response()
Link to this function

auth_request(verb, uri, credentials, body)

Specs

auth_request(verb(), uri(), credentials(), term()) :: auth_response()

Specs

domain() :: String.t()
Link to this function

non_auth_get(path, params \\ %{})

Specs

non_auth_get(path(), params()) :: non_auth_response()
Link to this function

non_auth_request(verb, uri)

Specs

non_auth_request(verb(), uri()) :: non_auth_response()

Specs

origin() :: String.t()

Specs

protocol() :: String.t()

Specs

url(uri()) :: String.t()