View Source Stellar.Horizon.Request (Elixir Stellar SDK v0.21.1)

A module for working with requests to the Horizon API.

Requests are composed in a functional manner. The request does not happen until it is configured and passed to perform/1.

Generally intended to be used internally, but can also be used by end-users to work around missing endpoints (if any).

At a minimum, a request must have the endpoint and method specified to be valid.

Summary

Types

body()

encoded_query()

endpoint()

headers()

method()

opts()

params()

parsed_response()

path()

query()

query_params()

response()

segment()

server()

t()

Functions

add_body(request, body)

add_headers(request, headers)

add_query(request, params \\ [], opts \\ [])

new(server, method, endpoint, opts \\ [])

perform(request)

results(arg, arg2)

Types

body()

@type body() :: Keyword.t()

encoded_query()

@type encoded_query() :: String.t() | nil

endpoint()

@type endpoint() :: String.t() | nil

headers()

@type headers() :: [{binary(), binary()}, ...] | []

method()

@type method() :: :get | :post

opts()

@type opts() :: Keyword.t()

params()

@type params() :: Keyword.t()

parsed_response()

@type parsed_response() :: {:ok, struct()} | {:error, Stellar.Horizon.Error.t()}

path()

@type path() :: String.t() | nil

query()

@type query() :: Keyword.t()

query_params()

@type query_params() :: [atom()]

response()

@type response() :: {:ok, map()} | {:error, Stellar.Horizon.Error.t()}

segment()

@type segment() :: String.t() | nil

server()

@type server() :: Stellar.Horizon.Server.t()

t()

@type t() :: %Stellar.Horizon.Request{
  body: body(),
  encoded_query: encoded_query(),
  endpoint: endpoint(),
  headers: headers(),
  method: method(),
  path: path(),
  query: query(),
  segment: segment(),
  segment_path: path(),
  server: term()
}

Functions

add_body(request, body)

@spec add_body(request :: t(), body :: body()) :: t()

add_headers(request, headers)

@spec add_headers(request :: t(), headers :: headers()) :: t()

add_query(request, params \\ [], opts \\ [])

@spec add_query(request :: t(), params :: params(), opts :: opts()) :: t()

new(server, method, endpoint, opts \\ [])

@spec new(
  server :: server(),
  method :: method(),
  endpoint :: endpoint(),
  opts :: opts()
) :: t()

perform(request)

@spec perform(request :: t()) :: response()

results(arg, arg2)

@spec results(response :: response(), resource :: Keyword.t()) :: parsed_response()