-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Report events to FunBot over a JSON/HTTP API.
--   
--   This is a library for reporting events to a running instance of
--   <a>FunBot</a>, so that the bot can announce the event to IRC. For
--   example, if you are writing a paste server, you can add support for
--   IRC announcments of new pastes by reporting the paste to a running
--   bot.
@package funbot-client
@version 0.1.0.0


-- | Using this module, you can send external events (such as git commits)
--   to a running FunBot instance over HTTP.
--   
--   Constructing events requires using types from the
--   <tt>funbot-ext-events</tt> package. But you should not use the
--   <tt>ExtEvent</tt> constructors from there, because if they change, it
--   will break your code. Instead, use the functions provided below. This
--   way new events can be added without breaking old code.
module FunBot.Client

-- | Reference to running FunBot instance to which you can send events.
data Bot

-- | An event coming from one of the external event sources.
data ExtEvent :: *

-- | Create a reference to a FunBot instance.
--   
--   You can parse the URL at runtime using <a>parseURI</a> or at compile
--   time using <a>staticURI</a> (or the <tt>uri</tt> quasi quoter in the
--   same package).
mkBot :: URI -> Bool -> Bot

-- | Send an event to a bot over HTTP. If successfully sent, return
--   <a>Nothing</a>. If an error occurs, return <a>Just</a> the error
--   details.
sendExtEvent :: Bot -> ExtEvent -> IO (Maybe ConnError)

-- | Construct a git push event.
mkPushEvent :: Push -> ExtEvent

-- | Construct a git tag event.
mkTagEvent :: Tag -> ExtEvent

-- | Construct a merge request event.
mkMergeRequestEvent :: MergeRequest -> ExtEvent

-- | Construct a news item event.
mkNewsEvent :: NewsItem -> ExtEvent

-- | Construct a paste event.
mkPasteEvent :: Paste -> ExtEvent