Alerts.hs

{-# LANGUAGE DataKinds         #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE TemplateHaskell   #-}
{-# LANGUAGE TypeFamilies      #-}

-- Module      : Network.PagerDuty.REST.Alerts
-- Copyright   : (c) 2013-2015 Brendan Hay <brendan.g.hay@gmail.com>
-- License     : This Source Code Form is subject to the terms of
--               the Mozilla Public License, v. 2.0.
--               A copy of the MPL can be found in the LICENSE file or
--               you can obtain it at http://mozilla.org/MPL/2.0/.
-- Maintainer  : Brendan Hay <brendan.g.hay@gmail.com>
-- Stability   : experimental
-- Portability : non-portable (GHC extensions)

-- | When an incident is triggered or when it is escalated it creates an alert
-- (also known as a notification). Alerts are messages containing the details
-- of the incident, and can be sent through SMS, email, phone calls,
-- and push notifications.
--
-- This API allows you to access read-only data regarding what alerts have been
-- sent to your users.
--
-- /See:/ <http://developer.pagerduty.com/documentation/rest/alerts>
module Network.PagerDuty.REST.Alerts
    (
    -- * List Alerts
      ListAlerts
    , listAlerts
    , laSince
    , laUntil
    , laFilter
    , laTimeZone

    -- * Types
    , AlertType (..)

    , Alert
    , alertId
    , alertType
    , alertStartedAt
    , alertUser
    , alertAddress
    ) where

import           Control.Lens                     hiding (Empty)
import           Data.Aeson.Lens
import           Data.Time
import           Network.PagerDuty.Internal.TH
import           Network.PagerDuty.Internal.Types
import           Network.PagerDuty.REST.Users     (User)

alerts :: Path
alerts = "alerts"

data AlertType
    = SMS
    | Email
    | Phone
    | Push
      deriving (Eq, Show)

deriveNullary ''AlertType

data Alert = Alert
    { _alertId        :: AlertId
    , _alertType      :: AlertType
    , _alertStartedAt :: Date
    , _alertUser      :: User
    , _alertAddress   :: Address
    } deriving (Eq, Show)

deriveRecord ''Alert

data ListAlerts = ListAlerts
    { _laSince'    :: Date
    , _laUntil'    :: Date
    , _laFilter'   :: Maybe AlertType
    , _laTimeZone' :: Maybe TZ
    } deriving (Eq, Show)

instance Paginate ListAlerts

queryRequest ''ListAlerts

-- | The start of the date range over which you want to search.
laSince :: Lens' (Request ListAlerts s b) UTCTime
laSince = upd.laSince'._D

-- | The end of the date range over which you want to search.
-- This should be in the same format as 'since'.
--
-- The size of the date range must be less than 3 months.
laUntil :: Lens' (Request ListAlerts s b) UTCTime
laUntil = upd.laUntil'._D

-- | Returns only the alerts of the said 'AlertType' type.
laFilter :: Lens' (Request ListAlerts s b) (Maybe AlertType)
laFilter = upd.laFilter'

-- | Time zone in which dates in the result will be rendered.
--
-- /Default:/ account time zone.
laTimeZone :: Lens' (Request ListAlerts s b) (Maybe TimeZone)
laTimeZone = upd.laTimeZone'.mapping _TZ

-- | List existing alerts for a given time range, optionally filtered by type
-- (SMS, Email, Phone, or Push).
--
-- @GET \/alerts@
--
-- /See:/ <http://developer.pagerduty.com/documentation/rest/alerts/list>
listAlerts :: Date -- ^ 'laSince'
           -> Date -- ^ 'laUntil'
           -> Request ListAlerts s [Alert]
listAlerts s u =
    mk ListAlerts
        { _laSince'    = s
        , _laUntil'    = u
        , _laFilter'   = Nothing
        , _laTimeZone' = Nothing
        } & path   .~ alerts
          & unwrap .~ key "alerts"