Swoosh v1.5.0

Swoosh.ApiClient behaviour (Swoosh v1.5.0) View Source

Specification for a Swoosh API client.

It can be set to your own client with:

config :swoosh, :api_client, MyAPIClient

Swoosh comes with Swoosh.ApiClient.Hackney and Swoosh.ApiClient.Finch.

Link to this section Summary

Types

body()
headers()
status()
url()

Callbacks

init()

Callback to initializes the given api client.

post(url, headers, body, t)

Callback invoked when posting to a given URL.

Functions

post(url, headers, body, email)

API used by adapters to post to a given URL with headers, body, and email.

Link to this section Types

Link to this type

body()

View Source

Specs

body() :: binary()
Link to this type

headers()

View Source

Specs

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

status()

View Source

Specs

status() :: pos_integer()
Link to this type

url()

View Source

Specs

url() :: binary()

Link to this section Callbacks

Link to this callback

init()

View Source (optional)

Specs

init() :: :ok

Callback to initializes the given api client.

Link to this callback

post(url, headers, body, t)

View Source

Specs

post(url(), headers(), body(), Swoosh.Email.t()) ::
  {:ok, status(), headers(), body()} | {:error, term()}

Callback invoked when posting to a given URL.

Link to this section Functions

Link to this function

post(url, headers, body, email)

View Source

API used by adapters to post to a given URL with headers, body, and email.