Tinkex.HTTPClient behaviour (Tinkex v0.4.0)

Copy Markdown View Source

Behaviour for HTTP client implementations.

This indirection lets tests or host applications swap out the HTTP layer when needed. The default implementation is Tinkex.API.

Summary

Callbacks

delete(path, opts)
get(path, opts)
post(path, body, opts)
put(path, body, opts)

Callbacks

delete(path, opts)

@callback delete(path :: String.t(), opts :: keyword()) ::
  {:ok, map()} | {:error, Tinkex.Error.t()}

get(path, opts)

@callback get(path :: String.t(), opts :: keyword()) ::
  {:ok, map()} | {:error, Tinkex.Error.t()}

post(path, body, opts)

@callback post(path :: String.t(), body :: map(), opts :: keyword()) ::
  {:ok, map()} | {:error, Tinkex.Error.t()}

put(path, body, opts)

@callback put(path :: String.t(), body :: map(), opts :: keyword()) ::
  {:ok, map()} | {:error, Tinkex.Error.t()}