Chat.Flowdock.REST.Request

Request creation

parseApiUrl :: MonadThrow m => ApiUrl a -> m (Tagged a Request)

Convert a ApiUrl into a Request.

See parseUrl

Since this function uses MonadThrow, the return monad can be anything that is an instance of MonadThrow, such as IO or Maybe.

Flows

See https://www.flowdock.com/api/flows

flowsRequest :: MonadThrow m => m (Tagged [Flow] Request)

allFlowsRequest :: MonadThrow m => m (Tagged [Flow] Request)

flowRequest :: MonadThrow m => ParamName Organisation -> ParamName Flow -> m (Tagged Flow Request)

Messages

See https://www.flowdock.com/api/messages

messagesRequest :: MonadThrow m => ParamName Organisation -> ParamName Flow -> MessageOptions -> m (Tagged [Message] Request)

Options

data MessageOptions

Instances

Eq MessageOptions

Ord MessageOptions

Show MessageOptions

defMessageOptions :: MessageOptions

msgOptEvents :: Lens' MessageOptions [MessageEvent]

msgOptLimit :: Lens' MessageOptions (Maybe Int)

msgOptUntilId :: Lens' MessageOptions (Maybe MessageId)

msgOptSinceId :: Lens' MessageOptions (Maybe MessageId)

msgOptSorting :: Lens' MessageOptions Sorting

data Sorting

Constructors

Descending

Ascending

Instances

Bounded Sorting

Enum Sorting

Eq Sorting

Ord Sorting

Read Sorting

Show Sorting

sortingToString :: Sorting -> String

Users

See https://www.flowdock.com/api/users

usersRequest :: MonadThrow m => m (Tagged [User] Request)

orgUsersRequest :: MonadThrow m => ParamName Organisation -> m (Tagged [User] Request)

flowUsersRequest :: MonadThrow m => ParamName Organisation -> ParamName Flow -> m (Tagged [User] Request)

Organisations

See https://www.flowdock.com/api/organizations

organisationsRequest :: MonadThrow m => m (Tagged [Organisation] Request)

organisationRequest :: MonadThrow m => ParamName Organisation -> m (Tagged Organisation Request)