Stellar.Horizon.Request (Elixir Stellar SDK v0.5.0) View Source
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.
Link to this section Summary
Link to this section Types
Specs
body() :: Keyword.t()
Specs
encoded_query() :: String.t() | nil
Specs
endpoint() :: String.t() | nil
Specs
Specs
method() :: :get | :post
Specs
opts() :: Keyword.t()
Specs
params() :: Keyword.t()
Specs
parsed_response() :: {:ok, struct()} | {:error, Stellar.Horizon.Error.t()}
Specs
path() :: String.t() | nil
Specs
query() :: Keyword.t()
Specs
query_params() :: [atom()]
Specs
response() :: {:ok, map()} | {:error, Stellar.Horizon.Error.t()}
Specs
segment() :: String.t() | nil
Specs
Link to this section Functions
Specs
Specs
Specs
Specs
Specs
Specs
results(response :: response(), resource :: function()) :: parsed_response()