Network.API.Builder.Send

Documentation

class Sendable s where

Class for types that can be sent with api-builder. Given a Builder, a Route, and an instance of Sendable, we should be able to construct a Request for the API's server. If we can't, send returns Nothing and APIT complains about being unable to send the given data.

Minimal complete definition

send

Methods

send :: Builder -> Route -> s -> Maybe Request

Instances

Sendable ()

Methods

send :: Builder -> Route -> () -> Maybe Request

Sendable ByteString

Methods

send :: Builder -> Route -> ByteString -> Maybe Request

Sendable Value

Methods

send :: Builder -> Route -> Value -> Maybe Request

Sendable PostQuery

Methods

send :: Builder -> Route -> PostQuery -> Maybe Request

basicSend :: Builder -> Route -> Maybe Request

useToJSON :: ToJSON a => Builder -> Route -> a -> Maybe Request

data PostQuery

By default, the '()' instance for Sendable moves the query parameters of the Route into the body of the POST request. Most APIs handle both, but some will complain if they aren't sent in the actual query. If you send PostQuery instead of '()', the query params won't move from the actual query string when constructing the request.

Constructors

PostQuery

Instances

Show PostQuery

Methods

showsPrec :: Int -> PostQuery -> ShowS

show :: PostQuery -> String

showList :: [PostQuery] -> ShowS

Sendable PostQuery

Methods

send :: Builder -> Route -> PostQuery -> Maybe Request