ExX2Y2.Http.Request (ex_x2y2 v0.0.3)

Link to this section Summary

Link to this section Types

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


@type http_method() :: :get | :post | :put | :delete
@type params() :: map()
@type path() :: String.t()
@type protocol() :: String.t()
@type t() :: %ExX2Y2.Http.Request{
  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

@spec for_path(path()) :: t()
@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)

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