DripDrop.Channel behaviour (DripDrop v0.1.0)

Uniform contract implemented by DripDrop channel providers.

Summary

delivery_error()

error_kind()

webhook_route()

@type credential_errors() :: [{atom(), binary()}]

@type delivery_error() :: %{kind: error_kind(), reason: term()}

@type delivery_success() :: %{
  optional(:provider_message_id) => binary() | nil,
  optional(:response) => map()
}

@type error_kind() :: :temporary | :permanent

@type webhook_route() :: {atom(), binary(), module()}

@callback deliver(Ecto.Schema.t(), term(), Ecto.Schema.t()) ::
  {:ok, delivery_success()} | {:error, delivery_error()}

@callback validate_credentials(map()) :: :ok | {:error, credential_errors()}

@callback verify_signature(Ecto.Schema.t(), term()) :: :ok | {:error, term()}

@callback webhook_routes(Ecto.Schema.t()) :: [webhook_route()]