TypeSafeAPI.HTTP.Response (TypeSafe AI v0.1.0-alpha.3)

A successful raw response: the decoded JSON body plus the metadata the typed layer and support conversations need.

TypeSafeAPI.HTTP.post/4 and get/3 return only the body, which is enough for most raw callers. TypeSafeAPI.HTTP.request/5 returns this struct so callers can also read the status, headers, and the x-typesafe-request-id header that TypeSafe support asks for.

The same metadata is on TypeSafeAPI.Error for the calls that failed, so "which request was this and how many retries did it burn" is answerable either way.

body is the decoded JSON object. A 2xx with no body at all (a 204, or an empty 200) decodes to %{} rather than an error: the call succeeded and there was simply nothing to read.

Only status and body are required, so a hand-built response in a test needs just those two:

%TypeSafeAPI.HTTP.Response{status: 200, body: %{"answers" => %{}}}

Summary

Types

t()

Functions

first_header(response, name)

The first value of a response header, trimmed, or nil.

Types

t()

@type t() :: %TypeSafeAPI.HTTP.Response{
  body: map(),
  headers: %{required(String.t()) => [String.t()]},
  request_id: String.t() | nil,
  retry_count: non_neg_integer(),
  status: pos_integer()
}

Functions

first_header(response, name)

@spec first_header(t(), String.t()) :: String.t() | nil

The first value of a response header, trimmed, or nil.

Header names are lowercase. Saves callers from knowing that Req stores headers as %{name => [value]}.

TypeSafeAPI.HTTP.Response.first_header(response, "x-typesafe-request-id")