ex_open_sea v0.0.7

ExOpenSea.Http.Request (ex_open_sea v0.0.7)

Link to this section Summary

Types

api_key()
domain()
http_method()
params()
path()
protocol()
query_encoder()
t()

Functions

for_path(path)
url(request)
with_auth(request, api_key)
with_domain(request, domain)
with_method(request, method)
with_protocol(request, protocol)
with_query(request, params, query_encoder \\ ExOpenSea.QueryEncoders.WwwForm)

Link to this section Types

Link to this type

api_key()

@type api_key() :: String.t()
Link to this type

domain()

@type domain() :: String.t()
Link to this type

http_method()

@type http_method() :: :get | :post | :put | :delete
Link to this type

params()

@type params() :: map()
Link to this type

path()

@type path() :: String.t()
Link to this type

protocol()

@type protocol() :: String.t()
Link to this type

query_encoder()

@type query_encoder() :: module()
Link to this type

t()

@type t() :: %ExOpenSea.Http.Request{
  api_key: api_key() | nil,
  body: String.t() | nil,
  domain: domain() | nil,
  headers: keyword(),
  method: http_method() | nil,
  path: path(),
  protocol: protocol() | nil,
  query: String.t() | nil
}

Link to this section Functions

Link to this function

for_path(path)

@spec for_path(path()) :: t()
Link to this function

url(request)

@spec url(t()) :: String.t()
Link to this function

with_auth(request, api_key)

@spec with_auth(t(), api_key()) :: t()
Link to this function

with_domain(request, domain)

@spec with_domain(t(), domain()) :: t()
Link to this function

with_method(request, method)

@spec with_method(t(), http_method()) :: t()
Link to this function

with_protocol(request, protocol)

@spec with_protocol(t(), protocol()) :: t()
Link to this function

with_query(request, params, query_encoder \\ ExOpenSea.QueryEncoders.WwwForm)

@spec with_query(t(), params(), query_encoder()) :: t()