ExCwmanage v0.3.5 ExCwmanage.Api.Behaviour behaviour View Source

Raw API commands

Link to this section Summary

Link to this section Callbacks

Link to this callback

delete(path)

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

delete(path, params)

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

get(path)

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

get(path, params)

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

get_page(path)

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

get_page(path, params)

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

get_raw(path)

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

get_raw(path, params)

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

get_stream(path)

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

get_stream(path, params)

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

patch(path)

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

patch(path, payload)

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

post(path)

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

post(path, payload)

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

put(path)

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

put(path, payload)

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