1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Network.PagerDuty.REST.Alerts</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
2window.onload = function () {pageLoad();setSynopsis("mini_Network-PagerDuty-REST-Alerts.html");};
4</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">pagerduty-0.0.1.1: Client library for PagerDuty Integration and REST APIs.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Network.PagerDuty.REST.Alerts</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">List Alerts</a></li><li><a href="#g:2">Types</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>When an incident is triggered or when it is escalated it creates an alert
5 (also known as a notification). Alerts are messages containing the details
6 of the incident, and can be sent through SMS, email, phone calls,
7 and push notifications.</p><p>This API allows you to access read-only data regarding what alerts have been
8 sent to your users.</p><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/rest/alerts">http://developer.pagerduty.com/documentation/rest/alerts</a></p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:ListAlerts">ListAlerts</a></li><li class="src short"><a href="#v:listAlerts">listAlerts</a> :: Date -> Date -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Alerts.html#t:ListAlerts">ListAlerts</a> s [<a href="Network-PagerDuty-REST-Alerts.html#t:Alert">Alert</a>]</li><li class="src short"><a href="#v:laSince">laSince</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Alerts.html#t:ListAlerts">ListAlerts</a> s b) UTCTime</li><li class="src short"><a href="#v:laUntil">laUntil</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Alerts.html#t:ListAlerts">ListAlerts</a> s b) UTCTime</li><li class="src short"><a href="#v:laFilter">laFilter</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Alerts.html#t:ListAlerts">ListAlerts</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Network-PagerDuty-REST-Alerts.html#t:AlertType">AlertType</a>)</li><li class="src short"><a href="#v:laTimeZone">laTimeZone</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Alerts.html#t:ListAlerts">ListAlerts</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> TimeZone)</li><li class="src short"><span class="keyword">data</span> <a href="#t:AlertType">AlertType</a><ul class="subs"><li>= <a href="#v:SMS">SMS</a></li><li>| <a href="#v:Email">Email</a></li><li>| <a href="#v:Phone">Phone</a></li><li>| <a href="#v:Push">Push</a></li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Alert">Alert</a></li><li class="src short"><a href="#v:alertId">alertId</a> :: Lens' <a href="Network-PagerDuty-REST-Alerts.html#t:Alert">Alert</a> <a href="Network-PagerDuty-Integration.html#t:AlertId">AlertId</a></li><li class="src short"><a href="#v:alertType">alertType</a> :: Lens' <a href="Network-PagerDuty-REST-Alerts.html#t:Alert">Alert</a> <a href="Network-PagerDuty-REST-Alerts.html#t:AlertType">AlertType</a></li><li class="src short"><a href="#v:alertStartedAt">alertStartedAt</a> :: Lens' <a href="Network-PagerDuty-REST-Alerts.html#t:Alert">Alert</a> Date</li><li class="src short"><a href="#v:alertUser">alertUser</a> :: Lens' <a href="Network-PagerDuty-REST-Alerts.html#t:Alert">Alert</a> <a href="Network-PagerDuty-REST-Users.html#t:User">User</a></li><li class="src short"><a href="#v:alertAddress">alertAddress</a> :: Lens' <a href="Network-PagerDuty-REST-Alerts.html#t:Alert">Alert</a> <a href="Network-PagerDuty-Integration.html#t:Address">Address</a></li></ul></div><div id="interface"><h1 id="g:1">List Alerts</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ListAlerts" class="def">ListAlerts</a></p><div class="subs instances"><p id="control.i:ListAlerts" class="caption collapser" onclick="toggleSection('i:ListAlerts')">Instances</p><div id="section.i:ListAlerts" class="show"><table><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Eq.html#t:Eq">Eq</a> <a href="Network-PagerDuty-REST-Alerts.html#t:ListAlerts">ListAlerts</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Text-Show.html#t:Show">Show</a> <a href="Network-PagerDuty-REST-Alerts.html#t:ListAlerts">ListAlerts</a></td><td class="doc empty"> </td></tr><tr><td class="src">ToJSON <a href="Network-PagerDuty-REST-Alerts.html#t:ListAlerts">ListAlerts</a></td><td class="doc empty"> </td></tr><tr><td class="src">HasDatatypeInfo <a href="Network-PagerDuty-REST-Alerts.html#t:ListAlerts">ListAlerts</a></td><td class="doc empty"> </td></tr><tr><td class="src">Generic <a href="Network-PagerDuty-REST-Alerts.html#t:ListAlerts">ListAlerts</a></td><td class="doc empty"> </td></tr><tr><td class="src">QueryLike <a href="Network-PagerDuty-REST-Alerts.html#t:ListAlerts">ListAlerts</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Network-PagerDuty-Integration.html#t:Paginate">Paginate</a> <a href="Network-PagerDuty-REST-Alerts.html#t:ListAlerts">ListAlerts</a></td><td class="doc empty"> </td></tr><tr><td class="src"><span class="keyword">type</span> Code <a href="Network-PagerDuty-REST-Alerts.html#t:ListAlerts">ListAlerts</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:listAlerts" class="def">listAlerts</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: Date</td><td class="doc"><p><code><a href="Network-PagerDuty-REST-Alerts.html#v:laSince">laSince</a></code></p></td></tr><tr><td class="src">-> Date</td><td class="doc"><p><code><a href="Network-PagerDuty-REST-Alerts.html#v:laUntil">laUntil</a></code></p></td></tr><tr><td class="src">-> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Alerts.html#t:ListAlerts">ListAlerts</a> s [<a href="Network-PagerDuty-REST-Alerts.html#t:Alert">Alert</a>]</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>List existing alerts for a given time range, optionally filtered by type
9 (SMS, Email, Phone, or Push).</p><pre>GET /alerts</pre><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/rest/alerts/list">http://developer.pagerduty.com/documentation/rest/alerts/list</a></p></div></div><div class="top"><p class="src"><a name="v:laSince" class="def">laSince</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Alerts.html#t:ListAlerts">ListAlerts</a> s b) UTCTime</p><div class="doc"><p>The start of the date range over which you want to search.</p></div></div><div class="top"><p class="src"><a name="v:laUntil" class="def">laUntil</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Alerts.html#t:ListAlerts">ListAlerts</a> s b) UTCTime</p><div class="doc"><p>The end of the date range over which you want to search.
10 This should be in the same format as <code>since</code>.</p><p>The size of the date range must be less than 3 months.</p></div></div><div class="top"><p class="src"><a name="v:laFilter" class="def">laFilter</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Alerts.html#t:ListAlerts">ListAlerts</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Network-PagerDuty-REST-Alerts.html#t:AlertType">AlertType</a>)</p><div class="doc"><p>Returns only the alerts of the said <code><a href="Network-PagerDuty-REST-Alerts.html#t:AlertType">AlertType</a></code> type.</p></div></div><div class="top"><p class="src"><a name="v:laTimeZone" class="def">laTimeZone</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Alerts.html#t:ListAlerts">ListAlerts</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> TimeZone)</p><div class="doc"><p>Time zone in which dates in the result will be rendered.</p><p><em>Default:</em> account time zone.</p></div></div><h1 id="g:2">Types</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:AlertType" class="def">AlertType</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:SMS" class="def">SMS</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Email" class="def">Email</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Phone" class="def">Phone</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Push" class="def">Push</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:AlertType" class="caption collapser" onclick="toggleSection('i:AlertType')">Instances</p><div id="section.i:AlertType" class="show"><table><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Eq.html#t:Eq">Eq</a> <a href="Network-PagerDuty-REST-Alerts.html#t:AlertType">AlertType</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Text-Show.html#t:Show">Show</a> <a href="Network-PagerDuty-REST-Alerts.html#t:AlertType">AlertType</a></td><td class="doc empty"> </td></tr><tr><td class="src">ToJSON <a href="Network-PagerDuty-REST-Alerts.html#t:AlertType">AlertType</a></td><td class="doc empty"> </td></tr><tr><td class="src">FromJSON <a href="Network-PagerDuty-REST-Alerts.html#t:AlertType">AlertType</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Alert" class="def">Alert</a></p><div class="subs instances"><p id="control.i:Alert" class="caption collapser" onclick="toggleSection('i:Alert')">Instances</p><div id="section.i:Alert" class="show"><table><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Eq.html#t:Eq">Eq</a> <a href="Network-PagerDuty-REST-Alerts.html#t:Alert">Alert</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Text-Show.html#t:Show">Show</a> <a href="Network-PagerDuty-REST-Alerts.html#t:Alert">Alert</a></td><td class="doc empty"> </td></tr><tr><td class="src">ToJSON <a href="Network-PagerDuty-REST-Alerts.html#t:Alert">Alert</a></td><td class="doc empty"> </td></tr><tr><td class="src">FromJSON <a href="Network-PagerDuty-REST-Alerts.html#t:Alert">Alert</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:alertId" class="def">alertId</a> :: Lens' <a href="Network-PagerDuty-REST-Alerts.html#t:Alert">Alert</a> <a href="Network-PagerDuty-Integration.html#t:AlertId">AlertId</a></p></div><div class="top"><p class="src"><a name="v:alertType" class="def">alertType</a> :: Lens' <a href="Network-PagerDuty-REST-Alerts.html#t:Alert">Alert</a> <a href="Network-PagerDuty-REST-Alerts.html#t:AlertType">AlertType</a></p></div><div class="top"><p class="src"><a name="v:alertStartedAt" class="def">alertStartedAt</a> :: Lens' <a href="Network-PagerDuty-REST-Alerts.html#t:Alert">Alert</a> Date</p></div><div class="top"><p class="src"><a name="v:alertUser" class="def">alertUser</a> :: Lens' <a href="Network-PagerDuty-REST-Alerts.html#t:Alert">Alert</a> <a href="Network-PagerDuty-REST-Users.html#t:User">User</a></p></div><div class="top"><p class="src"><a name="v:alertAddress" class="def">alertAddress</a> :: Lens' <a href="Network-PagerDuty-REST-Alerts.html#t:Alert">Alert</a> <a href="Network-PagerDuty-Integration.html#t:Address">Address</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.14.3</p></div></body></html>
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list