Flickrex.Operation.Rest (flickrex v0.8.1) View Source

Holds data necessary for an operation on the Flickr REST service.

The :format must be one of :json or :rest, the latter returning XML. The default is :json.

The parser must be a 1- or 2-arity function, accepting an :ok or :error response, and optionally a Flickrex.Config struct.

Link to this section Summary

Types

config()

error_t()

format()

http_headers()

http_method()

method()

params()

parser()

path()

results()

service()

success_t()

t()

Link to this section Types

config()

Specs

config() :: Flickrex.Config.t()

error_t()

Specs

error_t() :: Flickrex.Request.HttpClient.error_t()

format()

Specs

format() :: :json | :rest

http_headers()

Specs

http_headers() :: %{optional(String.t()) => String.t()}

http_method()

Specs

http_method() :: atom()

method()

Specs

method() :: String.t()

params()

Specs

params() :: %{optional(String.Chars.t()) => String.Chars.t()}

parser()

Specs

parser() :: (results() -> results()) | (results(), config() -> results())

path()

Specs

path() :: String.t()

results()

Specs

results() :: success_t() | error_t()

service()

Specs

service() :: atom()

success_t()

Specs

success_t() :: Flickrex.Request.HttpClient.success_t()

t()

Specs

t() :: %Flickrex.Operation.Rest{
  default_params: params(),
  format: format(),
  http_headers: http_headers(),
  http_method: http_method(),
  method: method(),
  params: params(),
  parser: parser(),
  path: path(),
  service: service()
}