Module: Pagerduty::Requests::Alerts
- Extended by:
- Core
- Defined in:
- lib/pagerduty/requests/alerts.rb
Class Method Summary collapse
-
.alerts(options = {}) ⇒ Object
List existing alerts for a given time range, optionally filtered by type (SMS, Email, Phone, or Push).
Methods included from Core
Class Method Details
.alerts(options = {}) ⇒ Object
List existing alerts for a given time range, optionally filtered by type (SMS, Email, Phone, or Push)
Parameters
-
params<~Hash>
-
‘since’<~String>: The start of the date range over which you want to search. The time element is optional.
-
‘until’<~String>: 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.
-
‘filter’<~String>: Returns only the alerts of the said types. Can be one of SMS, Email, Phone, or Push.
-
‘time_zone’<~TimeZone>: Time zone in which dates in the result will be rendered. Defaults to account time zone.
-
Returns
-
‘alerts’<~Array><~Alerts>
-
‘id’<~String>
-
‘type’<~String>
-
‘started_at’<~String>
-
‘user’<~Pagerduty::User>
-
‘id’<~String>
-
‘name’<~String>
-
‘email’<~String>
-
‘time_zone’<~String>
-
‘color’<~String>
-
‘avatar_url’<~String>
-
‘user_url’<~String>
-
‘invitation_sent’<~Boolean>
-
‘marketing’<~String>
-
‘marketing_opt_out’<~String>
-
‘type’<~String>
-
-
35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/pagerduty/requests/alerts.rb', line 35 def self.alerts(={}) unless has_requirements? [:since, :until], puts "#> This function requires arguments :since, :until" puts "Please see: http://developer.pagerduty.com/documentation/rest/alerts/list" return end Pagerduty::Alerts.new(curl({ uri: "https://#{Pagerduty.class_variable_get(:@@subdomain)}.pagerduty.com/api/v1/alerts", params: , method: 'GET' })) end |