esi

v0.1.1

esi v0.1.1 ESI.Request

Summary

Types

request_opt()
request_opts()

Additional request options

t()

Functions

encode_options(request)
options(req, opts)

Add query options to a request

opts_by_location(request)
run(request)

Run a request

stream!(request)
validate(request)

Validate that the request is ready

Types

request_opt() 
request_opt ::
  {:datasource, :tranquility | :singularity} |
  {:user_agent, String.t} |
  {atom, any}
request_opts() 
request_opts() :: [request_opt]

Additional request options.

You can provide any options that the API accepts, and/or these common options:

  • datasource — (DEFAULT: :tranquility) — The server name you would like data from
  • user_agent — Client identifier
t() 
t() :: %ESI.Request{opts: %{optional(atom) => any}, opts_schema: %{optional(atom) => {:body | :query, :required | :optional}}, path: String.t, verb: :get | :post | :put | :delete}

Functions

encode_options(request) 
encode_options(request :: t) :: %{optional(:body | :query) => String.t}
options(req, opts) 
options(req :: ESI.Request.t, opts :: request_opts) :: ESI.Request.t

Add query options to a request

opts_by_location(request) 
opts_by_location(request :: t) :: %{optional(:body | :query) => %{optional(atom) => any}}
run(request) 
run(t) :: {:ok, any} | {:error, any}

Run a request.

stream!(request)
validate(request) 
validate(request :: t) :: :ok | {:error, String.t}

Validate that the request is ready.