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.Users.NotificationRules</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-Users-NotificationRules.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.Users.NotificationRules</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">List Rules</a></li><li><a href="#g:2">Create Rule</a></li><li><a href="#g:3">Get Rule</a></li><li><a href="#g:4">Update Rule</a></li><li><a href="#g:5">Delete Rule</a></li><li><a href="#g:6">Types</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>When a user is assigned an incident, the user's notification rules are
5 used to determine which contact method will be used to alert the user and how
6 long after the incident to do so.</p><p>Access and manipulate the notification rules for a user.</p><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/rest/users/notification_rules">http://developer.pagerduty.com/documentation/rest/users/notification_rules</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"><a href="#v:listRules">listRules</a> :: <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a> -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-Integration.html#t:Empty">Empty</a> s <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:Rule">Rule</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:CreateRule">CreateRule</a></li><li class="src short"><a href="#v:createRule">createRule</a> :: <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a> -> <a href="Network-PagerDuty-Integration.html#t:ContactId">ContactId</a> -> <a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Int.html#t:Int">Int</a> -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:CreateRule">CreateRule</a> s <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:Rule">Rule</a></li><li class="src short"><a href="#v:crStartDelayInMinutes">crStartDelayInMinutes</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:CreateRule">CreateRule</a> s b) <a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:crContactMethodId">crContactMethodId</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:CreateRule">CreateRule</a> s b) <a href="Network-PagerDuty-Integration.html#t:ContactId">ContactId</a></li><li class="src short"><a href="#v:getRule">getRule</a> :: <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a> -> <a href="Network-PagerDuty-Integration.html#t:NotificationRuleId">NotificationRuleId</a> -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-Integration.html#t:Empty">Empty</a> s <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:Rule">Rule</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:UpdateRule">UpdateRule</a></li><li class="src short"><a href="#v:updateRule">updateRule</a> :: <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a> -> <a href="Network-PagerDuty-Integration.html#t:NotificationRuleId">NotificationRuleId</a> -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:UpdateRule">UpdateRule</a> s <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:Rule">Rule</a></li><li class="src short"><a href="#v:urStartDelayInMinutes">urStartDelayInMinutes</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:UpdateRule">UpdateRule</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="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Int.html#t:Int">Int</a>)</li><li class="src short"><a href="#v:urContactMethodId">urContactMethodId</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:UpdateRule">UpdateRule</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-Integration.html#t:ContactId">ContactId</a>)</li><li class="src short"><a href="#v:deleteRule">deleteRule</a> :: <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a> -> <a href="Network-PagerDuty-Integration.html#t:NotificationRuleId">NotificationRuleId</a> -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-Integration.html#t:Empty">Empty</a> s <a href="Network-PagerDuty-Integration.html#t:Empty">Empty</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:Rule">Rule</a></li><li class="src short"><a href="#v:rId">rId</a> :: Lens' <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:Rule">Rule</a> <a href="Network-PagerDuty-Integration.html#t:NotificationRuleId">NotificationRuleId</a></li><li class="src short"><a href="#v:rStartDelayInMinutes">rStartDelayInMinutes</a> :: Lens' <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:Rule">Rule</a> <a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:rContactMethod">rContactMethod</a> :: Lens' <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:Rule">Rule</a> <a href="Network-PagerDuty-REST-Users-ContactMethods.html#t:Contact">Contact</a></li></ul></div><div id="interface"><h1 id="g:1">List Rules</h1><div class="top"><p class="src"><a name="v:listRules" class="def">listRules</a> :: <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a> -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-Integration.html#t:Empty">Empty</a> s <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:Rule">Rule</a></p><div class="doc"><p>List existing notification rules for the specified user.</p><pre>GET /users/:user_id/notification_rules</pre><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/rest/users/notification_rules/list">http://developer.pagerduty.com/documentation/rest/users/notification_rules/list</a></p></div></div><h1 id="g:2">Create Rule</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:CreateRule" class="def">CreateRule</a></p><div class="subs instances"><p id="control.i:CreateRule" class="caption collapser" onclick="toggleSection('i:CreateRule')">Instances</p><div id="section.i:CreateRule" 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-Users-NotificationRules.html#t:CreateRule">CreateRule</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-Users-NotificationRules.html#t:CreateRule">CreateRule</a></td><td class="doc empty"> </td></tr><tr><td class="src">ToJSON <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:CreateRule">CreateRule</a></td><td class="doc empty"> </td></tr><tr><td class="src">FromJSON <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:CreateRule">CreateRule</a></td><td class="doc empty"> </td></tr><tr><td class="src">QueryLike <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:CreateRule">CreateRule</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:createRule" class="def">createRule</a> :: <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a> -> <a href="Network-PagerDuty-Integration.html#t:ContactId">ContactId</a> -> <a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Int.html#t:Int">Int</a> -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:CreateRule">CreateRule</a> s <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:Rule">Rule</a></p><div class="doc"><p>Create a new notification rule for the specified user.</p><pre>POST /users/:user_id/notification_rules</pre><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/rest/users/notification_rules/create">http://developer.pagerduty.com/documentation/rest/users/notification_rules/create</a></p></div></div><div class="top"><p class="src"><a name="v:crStartDelayInMinutes" class="def">crStartDelayInMinutes</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:CreateRule">CreateRule</a> s b) <a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Int.html#t:Int">Int</a></p><div class="doc"><p>Number of minutes it will take for the notification rule to be activated
7 (from the time the incident is assigned to the owning user) and an alert be
8 fired.</p></div></div><div class="top"><p class="src"><a name="v:crContactMethodId" class="def">crContactMethodId</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:CreateRule">CreateRule</a> s b) <a href="Network-PagerDuty-Integration.html#t:ContactId">ContactId</a></p><div class="doc"><p>The id of the contact method.</p></div></div><h1 id="g:3">Get Rule</h1><div class="top"><p class="src"><a name="v:getRule" class="def">getRule</a> :: <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a> -> <a href="Network-PagerDuty-Integration.html#t:NotificationRuleId">NotificationRuleId</a> -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-Integration.html#t:Empty">Empty</a> s <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:Rule">Rule</a></p><div class="doc"><p>Get details for a notification rule.</p><pre>GET /users/:user_id/notification_rules/:id</pre><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/rest/users/notification_rules/show">http://developer.pagerduty.com/documentation/rest/users/notification_rules/show</a></p></div></div><h1 id="g:4">Update Rule</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:UpdateRule" class="def">UpdateRule</a></p><div class="subs instances"><p id="control.i:UpdateRule" class="caption collapser" onclick="toggleSection('i:UpdateRule')">Instances</p><div id="section.i:UpdateRule" 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-Users-NotificationRules.html#t:UpdateRule">UpdateRule</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-Users-NotificationRules.html#t:UpdateRule">UpdateRule</a></td><td class="doc empty"> </td></tr><tr><td class="src">ToJSON <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:UpdateRule">UpdateRule</a></td><td class="doc empty"> </td></tr><tr><td class="src">FromJSON <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:UpdateRule">UpdateRule</a></td><td class="doc empty"> </td></tr><tr><td class="src">QueryLike <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:UpdateRule">UpdateRule</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:updateRule" class="def">updateRule</a> :: <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a> -> <a href="Network-PagerDuty-Integration.html#t:NotificationRuleId">NotificationRuleId</a> -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:UpdateRule">UpdateRule</a> s <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:Rule">Rule</a></p><div class="doc"><p>Update an existing notification rule.</p><pre>PUT /users/:user_id/notification_rules/:id</pre><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/rest/users/notification_rules/update">http://developer.pagerduty.com/documentation/rest/users/notification_rules/update</a></p></div></div><div class="top"><p class="src"><a name="v:urStartDelayInMinutes" class="def">urStartDelayInMinutes</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:UpdateRule">UpdateRule</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="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Int.html#t:Int">Int</a>)</p><div class="doc"><p>Number of minutes it will take for the notification rule to be activated
9 (from the time the incident is assigned to the owning user) and an alert be
10 fired.</p></div></div><div class="top"><p class="src"><a name="v:urContactMethodId" class="def">urContactMethodId</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:UpdateRule">UpdateRule</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-Integration.html#t:ContactId">ContactId</a>)</p><div class="doc"><p>The id of the contact method.</p></div></div><h1 id="g:5">Delete Rule</h1><div class="top"><p class="src"><a name="v:deleteRule" class="def">deleteRule</a> :: <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a> -> <a href="Network-PagerDuty-Integration.html#t:NotificationRuleId">NotificationRuleId</a> -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-Integration.html#t:Empty">Empty</a> s <a href="Network-PagerDuty-Integration.html#t:Empty">Empty</a></p><div class="doc"><p>Remove a notification rule.</p><pre>DELETE /users/:user_id/notification_rules/:id</pre><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/rest/users/notification_rules/delete">http://developer.pagerduty.com/documentation/rest/users/notification_rules/delete</a></p></div></div><h1 id="g:6">Types</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Rule" class="def">Rule</a></p><div class="subs instances"><p id="control.i:Rule" class="caption collapser" onclick="toggleSection('i:Rule')">Instances</p><div id="section.i:Rule" 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-Users-NotificationRules.html#t:Rule">Rule</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-Users-NotificationRules.html#t:Rule">Rule</a></td><td class="doc empty"> </td></tr><tr><td class="src">ToJSON <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:Rule">Rule</a></td><td class="doc empty"> </td></tr><tr><td class="src">FromJSON <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:Rule">Rule</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Network-PagerDuty-REST-Users-ContactMethods.html#t:HasContact">HasContact</a> <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:Rule">Rule</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:rId" class="def">rId</a> :: Lens' <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:Rule">Rule</a> <a href="Network-PagerDuty-Integration.html#t:NotificationRuleId">NotificationRuleId</a></p></div><div class="top"><p class="src"><a name="v:rStartDelayInMinutes" class="def">rStartDelayInMinutes</a> :: Lens' <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:Rule">Rule</a> <a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Int.html#t:Int">Int</a></p></div><div class="top"><p class="src"><a name="v:rContactMethod" class="def">rContactMethod</a> :: Lens' <a href="Network-PagerDuty-REST-Users-NotificationRules.html#t:Rule">Rule</a> <a href="Network-PagerDuty-REST-Users-ContactMethods.html#t:Contact">Contact</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