@spec decode(Req.Response.t() | map(), module() | false | %{}) ::
  struct() | map() | Req.Response.t()

Decode a JSON response body into a struct.

Parameters

• response - The Req.Response struct or a map
• module - The module to decode the response body into (or false to skip decoding)

Returns

The decoded struct, map, or response.

@spec deserialize(
  struct(),
  atom(),
  :date | :datetime | :list | :map | :struct,
  module()
) :: struct()

Update the provided model with a deserialization of a nested value.

@spec evaluate_response(
  {:ok, Req.Response.t()} | {:error, term()},
  response_mapping()
) ::
  {:ok, struct() | Req.Response.t()} | {:error, Req.Response.t() | term()}

Evaluate the response from a Req request.

Parameters

• result - The result from Req.request/2
• mapping - A list of {status_code, module} tuples for response decoding

Returns

• {:ok, struct} or {:ok, Req.Response.t()} on success
• {:error, term} on failure

@spec raw_to_struct(map(), module()) :: struct()

Build a struct of module from a raw string-keyed map.

Used by generated decode/1 discriminator dispatch clause to construct a concrete struct without triggering discriminator re-dispatch.