Network.Api.Support.Request

Documentation

type RequestTransformer = Endo Request

A RequestTransformer allows you to build up attributes on the request. | RequestTransformer is simply an Endo, and therefore has a Monoid, so | can be combined with <>.

setApiKey :: ByteString -> RequestTransformer

Set an api key for use with basic auth.

setUrlEncodedBody :: [(ByteString, ByteString)] -> RequestTransformer

Set URL encoded form params on the request body.

setQueryParams :: [(ByteString, Maybe ByteString)] -> RequestTransformer

Set request query parameters.

setHeaders :: [(CI ByteString, ByteString)] -> RequestTransformer

Set request headers.

setHeader :: (CI ByteString, ByteString) -> RequestTransformer

Set a request headers.

addHeader :: (CI ByteString, ByteString) -> RequestTransformer

Add a request headers.

stripHeader :: CI ByteString -> RequestTransformer

Set a request headers.

setCookieJar :: CookieJar -> UTCTime -> RequestTransformer

Register all cookies in cookie jar against request.

setMethod :: ByteString -> RequestTransformer

Set the request method to be the specified name.

setBody :: ByteString -> RequestTransformer

Set the request body from the specified byte string.

setBodyLazy :: ByteString -> RequestTransformer

Set the request body from the specified lazy byte string.

setJson :: ToJSON a => a -> RequestTransformer

Set the request body from the value which can be converted to JSON.

(<>) :: Monoid m => m -> m -> m infixr 6

An infix synonym for mappend.

Since: 4.5.0.0