ExCwmanage.Api.Behaviour behaviour (ExCwmanage v0.3.9) View Source

Raw API commands

Link to this section Summary

Link to this section Callbacks

Specs

delete(path :: String.t()) :: {:ok, map()} | {:error, term()}

Specs

delete(path :: String.t(), params :: list()) :: {:ok, map()} | {:error, term()}
Link to this callback

delete(path, params, http_opts)

View Source

Specs

delete(path :: String.t(), params :: list(), http_opts :: list()) ::
  {:ok, map()} | {:error, term()}

Specs

get(path :: String.t()) :: {:ok, map()} | {:error, term()}

Specs

get(path :: String.t(), params :: list()) :: {:ok, map()} | {:error, term()}
Link to this callback

get(path, params, http_opts)

View Source

Specs

get(path :: String.t(), params :: list(), http_opts :: list()) ::
  {:ok, map()} | {:error, term()}

Specs

get_page(path :: String.t()) :: {:ok, map()} | {:error, term()}

Specs

get_page(path :: String.t(), params :: list()) ::
  {:ok, map()} | {:error, term()}
Link to this callback

get_page(path, params, http_opts)

View Source

Specs

get_page(path :: String.t(), params :: list(), http_opts :: list()) ::
  {:ok, map()} | {:error, term()}

Specs

get_raw(path :: String.t()) :: {:ok, binary()} | {:error, term()}

Specs

get_raw(path :: String.t(), params :: list()) ::
  {:ok, binary()} | {:error, term()}
Link to this callback

get_raw(path, params, http_opts)

View Source

Specs

get_raw(path :: String.t(), params :: list(), http_opts :: list()) ::
  {:ok, binary()} | {:error, term()}

Specs

get_stream(path :: String.t()) :: {:ok, [map()]}
Link to this callback

get_stream(path, params)

View Source

Specs

get_stream(path :: String.t(), params :: list()) :: {:ok, [map()]}
Link to this callback

get_stream(path, params, http_opts)

View Source

Specs

get_stream(path :: String.t(), params :: list(), http_opts :: list()) ::
  {:ok, [map()]}

Specs

patch(path :: String.t()) :: {:ok, map()} | {:error, term()}

Specs

patch(path :: String.t(), payload :: String.t()) ::
  {:ok, map()} | {:error, term()}
Link to this callback

patch(path, payload, http_opts)

View Source

Specs

patch(path :: String.t(), payload :: String.t(), http_opts :: list()) ::
  {:ok, map()} | {:error, term()}

Specs

post(path :: String.t()) :: {:ok, map()} | {:error, term()}

Specs

post(path :: String.t(), payload :: String.t()) ::
  {:ok, map()} | {:error, term()}
Link to this callback

post(path, payload, http_opts)

View Source

Specs

post(path :: String.t(), payload :: String.t(), http_opts :: list()) ::
  {:ok, map()} | {:error, term()}

Specs

put(path :: String.t()) :: {:ok, map()} | {:error, term()}

Specs

put(path :: String.t(), payload :: String.t()) ::
  {:ok, map()} | {:error, term()}
Link to this callback

put(path, payload, http_opts)

View Source

Specs

put(path :: String.t(), payload :: String.t(), http_opts :: list()) ::
  {:ok, map()} | {:error, term()}