View Source Resend.Client behaviour (resend v0.4.4)

Resend API client.

Summary

response(type)

t()

request(t, t)

new(config)

Creates a new Resend client struct given a keyword list of config opts.

@type response(type) :: {:ok, type} | {:error, Resend.Error.t() | :client_error}

@type t() :: %Resend.Client{
  api_key: String.t(),
  base_url: String.t() | nil,
  client: module() | nil
}

@callback request(t(), Keyword.t()) ::
  {:ok, %{body: map(), status: pos_integer()}} | {:error, any()}

@spec delete(t(), Resend.Castable.impl(), String.t(), map(), Keyword.t()) ::
  response(any())

@spec get(t(), Resend.Castable.impl(), String.t(), Keyword.t()) :: response(any())

@spec new(Resend.config()) :: t()

Creates a new Resend client struct given a keyword list of config opts.

@spec post(t(), Resend.Castable.impl(), String.t(), map(), Keyword.t()) ::
  response(any())