Cleanup Notifications functionality

Author: phadej

CHANGELOG.md

@@ -10,6 +10,8 @@
 - Add extension point for (preview) media types
 - Add missing webhook event types
   [#359](https://github.com/phadej/github/pull/359)
+- Add notifications endpoints
+  [#324](https://github.com/phadej/github/pull/324)
 - Update dependencies
   [#364](https://github.com/phadej/github/pull/364)
   [#368](https://github.com/phadej/github/pull/368)

src/GitHub.hs

@@ -16,9 +16,16 @@ module GitHub (
     -- | See <https://developer.github.com/v3/activity/>
 
     -- ** Events
-    -- | See https://developer.github.com/v3/activity/events/#events
+    -- | See <https://developer.github.com/v3/activity/events/>
     repositoryEventsR,
     userEventsR,
+
+    -- ** Notifications
+    -- | See <https://developer.github.com/v3/activity/notifications/>
+    getNotificationsR,
+    markNotificationAsReadR,
+    markAllNotificationsAsReadR,
+
     -- ** Starring
     -- | See <https://developer.github.com/v3/activity/starring/>
     --
@@ -374,6 +381,7 @@ module GitHub (
 
 import GitHub.Data
 import GitHub.Endpoints.Activity.Events
+import GitHub.Endpoints.Activity.Notifications
 import GitHub.Endpoints.Activity.Starring
 import GitHub.Endpoints.Activity.Watching
 import GitHub.Endpoints.Gists

src/GitHub/Endpoints/Activity/Notifications.hs

@@ -15,25 +15,31 @@ import Prelude ()
 
 getNotifications :: Auth -> IO (Either Error (Vector Notification))
 getNotifications auth =
-  executeRequest auth $ getNotificationsR FetchAll
+    executeRequest auth $ getNotificationsR FetchAll
 
+-- | List your notifications.
+-- See <https://developer.github.com/v3/activity/notifications/#list-your-notifications>
 getNotificationsR :: FetchCount -> Request 'RA (Vector Notification)
-getNotificationsR =
-  pagedQuery ["notifications"] []
+getNotificationsR = pagedQuery ["notifications"] []
 
 markNotificationAsRead :: Auth -> Id Notification -> IO (Either Error ())
-markNotificationAsRead auth notificationId =
-  executeRequest auth $ markNotificationAsReadR notificationId
+markNotificationAsRead auth nid =
+    executeRequest auth $ markNotificationAsReadR nid
 
-markNotificationAsReadR :: Id Notification -> Request 'RW ()
-markNotificationAsReadR notificationId = SimpleQuery $
-  Command Patch ["notifications", "threads", toPathPart notificationId]
-            (encode ())
+-- | Mark a thread as read.
+-- See <https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read>
+markNotificationAsReadR :: Id Notification -> GenRequest 'MtUnit 'RW ()
+markNotificationAsReadR nid = Command
+    Patch
+    ["notifications", "threads", toPathPart nid]
+    (encode ())
 
 markNotificationsAsRead :: Auth -> IO (Either Error ())
 markNotificationsAsRead auth =
   executeRequest auth markAllNotificationsAsReadR
 
-markAllNotificationsAsReadR :: Request 'RW ()
-markAllNotificationsAsReadR = SimpleQuery $
-  Command Put ["notifications"] $ encode emptyObject
+-- | Mark as read.
+-- See <https://developer.github.com/v3/activity/notifications/#mark-as-read>
+markAllNotificationsAsReadR :: GenRequest 'MtUnit 'RW ()
+markAllNotificationsAsReadR =
+    Command Put ["notifications"] $ encode emptyObject