salemove_http_client v1.0.1 Salemove.HttpClient.Decoder

A module, responsible for creating a EngagementRouter.HttpClient.Response from Tesla response, or, if request wasn't successful, for creating one of exception structures.

Link to this section Summary

Types

on_decode()

reason()

tesla_result()

Functions

decode(tesla_result)

Accepts result of request to Tesla client and constructs Elixir.Salemove.HttpClient.Response structure from it.

Link to this section Types

on_decode()

on_decode() :: {:ok, Salemove.HttpClient.Response.t()} | {:error, reason()}

reason()

reason() ::
  Salemove.HttpClient.JSONError.t()
  | Salemove.HttpClient.ConnectionError.t()
  | Salemove.HttpClient.UnexpectedRedirectError.t()
  | Salemove.HttpClient.ClientError.t()
  | Salemove.HttpClient.ServerError.t()
  | Salemove.HttpClient.UnavailableError.t()
  | Salemove.HttpClient.UnsupportedProtocolError.t()

tesla_result()

tesla_result() :: {:ok, Tesla.Env.t()} | {:error, reason :: any()}

Link to this section Functions

decode(tesla_result)

decode(tesla_result()) :: on_decode()

Accepts result of request to Tesla client and constructs Elixir.Salemove.HttpClient.Response structure from it.