cozy_oss v0.2.0

View Source CozyOSS.ApiClient behaviour (cozy_oss v0.2.0)

Specification for a CozyOSS API client.

It can be set to a client provided by CozyOSS, such as:

config :cozy_oss, :api_client, CozyOSS.ApiClient.Finch

Or, set it to your own API client, such as:

config :cozy_oss, :api_client, MyApiClient

Link to this section Summary

Types

body()
headers()
response()

The response of a request.

status()

Callbacks

init()

Callback to initialize the given API client.

request(t)

Callback to send a request.

Functions

request(req)

Send a struct %CozyOSS.ApiRequest{} as an HTTP request by the given API client.

Link to this section Types

Link to this type

body()

View Source 
@type body() :: binary() | map()
Link to this type

headers()

View Source 
@type headers() :: [{binary(), binary()}]
Link to this type

response()

View Source 
@type response() :: {:ok, status(), headers(), body()} | {:error, term()}

The response of a request.

Link to this type

status()

View Source 
@type status() :: pos_integer()

Link to this section Callbacks

Link to this callback

init()

View Source (optional) 
@callback init() :: :ok

Callback to initialize the given API client.

Link to this callback

request(t)

View Source 
@callback request(CozyOSS.ApiRequest.t()) :: response()

Callback to send a request.

Link to this section Functions

Link to this function

request(req)

View Source 
@spec request(CozyOSS.ApiRequest.t()) :: response()

Send a struct %CozyOSS.ApiRequest{} as an HTTP request by the given API client.

When the Content-Type header of the response is "application/xml", this function will try to convert the XML content to a map with snaked-cased keys.