README.md in flapjack-diner-0.15 vs README.md in flapjack-diner-1.0.0.rc1
- old
+ new
@@ -31,1018 +31,705 @@
Flapjack::Diner.logger = Logger.new('logs/flapjack_diner.log')
```
## Functions
-* [entities](#entities)
-* [checks](#checks)
-* status ([single check](#status_check) / [all checks](#status) / [bulk](#status_bulk))
-* scheduled maintentance periods ([single check](#scheduled_maintenance_check) / [all checks](#scheduled_maintenance) / [bulk](#scheduled_maintenance_bulk))
-* unscheduled maintentance periods ([single check](#unscheduled_maintenance_check) / [all checks](#unscheduled_maintenance) / [bulk](#unscheduled_maintenance_bulk))
-* outages ([single check](#outages_check) / [all checks](#outages) / [bulk](#outages_bulk))
-* downtimes ([single check](#downtimes_check) / [all checks](#downtimes) / [bulk](#downtimes_bulk))
-* create scheduled maintenance period ([single check](#create_scheduled_maintenance) / [bulk](#create_scheduled_maintenance_bulk))
-* delete scheduled maintenance period ([single check](#delete_scheduled_maintenance) / [bulk](#delete_scheduled_maintenance_bulk))
-* acknowledge ([single check](#acknowledge) / [bulk](#acknowledge_bulk))
-* delete unscheduled maintenance period ([single check](#delete_unscheduled_maintenance) / [bulk](#delete_unscheduled_maintenance_bulk))
-* test notifications ([single check](#test_notifications) / [bulk](#test_notifications_bulk))
-* [get entity tags](#get_entity_tags)
-* [add entity tags](#add_entity_tags)
-* [delete entity tags](#delete_entity_tags)
-* [get contact tags](#get_contact_tags)
-* [add contact tags](#add_contact_tags)
-* [delete contact tags](#delete_contact_tags)
-* [get tags for contact's linked entities](#get_contact_entitytags)
-* [add tags to contact's linked entities](#add_contact_entitytags)
-* [delete tags from contact's linked entities](#delete_contact_entitytags)
-* [contacts](#contacts)
-* [contact](#contact)
-* [notification rules](#notification_rules)
-* [notification rule](#notification_rule)
-* [create notification rule](#create_notification_rule)
-* [update notification rule](#update_notification_rule)
-* [delete notification rule](#delete_notification_rule)
-* [notification media](#notification_media)
-* [notification medium](#notification_medium)
-* [update notification medium](#update_notification_medium)
-* [delete notification medium](#delete_notification_medium)
-* [contact timezone](#contact_timezone)
-* [update contact timezone](#update_contact_timezone)
-* [delete contact timezone](#delete_contact_timezone)
+Parameters for all of **flapjack-diner**'s functions are organised into three categories:
----
+* Ids -- One or more String or Integer values
+* Query parameters -- Top-level hash values
+* Payload data -- Arrays of Hashes
-<a name="entities"> </a>
-Return an array of monitored entities, and their statuses for all associated checks:
+While these can be passed in in any order, the convention is that they will be ordered as listed above.
-```ruby
-Flapjack::Diner.entities
-```
+If any operation fails, `Flapjack::Diner.last_error` will contain an error message regarding the failure.
-The data is returned as an array where each element is a hash representing an entity.
+### Contacts
-```
-// ID is an integer, to hold e.g. database id from an external system
-// NAME is a string
-// STATUS is a hash with the format returned from Flapjack::Diner.status(entity, check)
-[{'id' => ID,
- 'name' => NAME,
- 'checks' => [STATUS, STATUS, ...]},
- {},
- ...]
-```
+* [create_contacts](#create_contacts)
+* [contacts](#contacts)
+* [update_contacts](#update_contacts)
+* [delete_contacts](#delete_contacts)
----
+### Media
-<a name="checks"> </a>
-Return an array of checks for an entity:
+* [create_contact_media](#create_contact_media)
+* [media](#media)
+* [update_media](#update_media)
+* [delete_media](#delete_media)
-```ruby
-Flapjack::Diner.checks('example.com')
-```
+### Pagerduty credentials
-The data is returned as an array of strings, where each element is a check name for the provided entity.
+* [create_contact_pagerduty_credentials](#create_contact_pagerduty_credentials)
+* [pagerduty_credentials](#pagerduty_credentials)
+* [update_pagerduty_credentials](#update_pagerduty_credentials)
+* [delete_pagerduty_credentials](#delete_pagerduty_credentials)
-```
-// CHECK is a string, e.g. 'ssh', 'ping'
-[CHECK, CHECK, ...]
-```
+### Notification rules
----
-<a name="status_check"> </a>
-Return the status for a check on an entity
+* [create_contact_notification_rules](#create_contact_notification_rules)
+* [notification_rules](#notification_rules)
+* [update_notification_rules](#update_notification_rules)
+* [delete_notification_rules](#delete_notification_rules)
-```ruby
-Flapjack::Diner.status('example.com', :check => 'ping')
-```
+### Entities
-The data is returned as a hash:
+* [create_entities](#create_entities)
+* [entities](#entities)
+* [update_entities](#update_entities)
-```
-// CHECK is a string, e.g. 'ssh', 'ping'
-// STATE is a string, one of 'critical', 'warning', 'ok', 'unknown'
-// the TIMESTAMPs are integers representing UTC times for the named events
-{'name' => CHECK,
- 'state' => STATE,
- 'in_unscheduled_maintenance' => BOOLEAN,
- 'in_scheduled_maintenance' => BOOLEAN,
- 'last_update' => TIMESTAMP,
- 'last_problem_notification' => TIMESTAMP,
- 'last_recovery_notification' => TIMESTAMP,
- 'last_acknowledgement_notification' => TIMESTAMP}
- ```
+* [create_scheduled_maintenances_entities](#create_scheduled_maintenances_entities)
+* [delete_scheduled_maintenances_entities](#delete_scheduled_maintenances_entities)
----
-<a name="status"> </a>
-Return the statuses for all checks on an entity
+* [create_unscheduled_maintenances_entities](#create_unscheduled_maintenances_entities)
+* [update_unscheduled_maintenances_entities](#update_unscheduled_maintenances_entities)
-```ruby
-Flapjack::Diner.status('example.com')
-```
+* [create_test_notifications_entities](#create_test_notifications_entities)
-The data is returned as an array of checks, where each element is a hash with the format returned from Flapjack::Diner.status(entity, check)
+### Checks
-```
-// STATUS is a hash with the format returned from Flapjack::Diner.status(entity, check)
-[STATUS, STATUS, ...]
-```
+* [create_scheduled_maintenances_checks](#create_scheduled_maintenances_checks)
+* [delete_scheduled_maintenances_checks](#delete_scheduled_maintenances_checks)
----
-<a name="status_bulk"> </a>
-Return the statuses for all checks on some entities and specified checks on others.
+* [create_unscheduled_maintenances_checks](#create_unscheduled_maintenances_checks)
+* [update_unscheduled_maintenances_checks](#update_unscheduled_maintenances_checks)
-```ruby
-# :entity - optional, may be a String or an Array of Strings (entity names)
-# :check - optional, Hash, keys are Strings (entity names), values are Strings or Arrays of Strings (check names)
-# At least one of the :entity or :check arguments must be provided
-Flapjack::Diner.bulk_status(:entity => 'example.com',
- :check => {'example2.com' => ['PING', 'SSH'],
- 'example3.com' => 'PING'})
-```
+* [create_test_notifications_checks](#create_test_notifications_checks)
-The data is returned as an array, where each element is a hash with the format
+### Reports
-```
-// ENTITY is a string, one of the entity names provided in the entity or check arguments.
-// CHECK is a string, e.g. 'ssh', 'ping'
-// STATUS is a hash with the format returned from Flapjack::Diner.status(entity, check)
-{'entity' => ENTITY
- 'check' => CHECK,
- 'status' => STATUS}
-```
+* [status_report_entities](#status_report_entities)
+* [scheduled_maintenance_report_entities](#scheduled_maintenance_report_entities)
+* [unscheduled_maintenance_report_entities](#unscheduled_maintenance_report_entities)
+* [downtime_report_entities](#downtime_report_entities)
+* [outage_report_entities](#outage_report_entities)
+* [status_report_checks](#status_report_checks)
+* [scheduled_maintenance_report_checks](#scheduled_maintenance_report_checks)
+* [unscheduled_maintenance_report_checks](#unscheduled_maintenance_report_checks)
+* [downtime_report_checks](#downtime_report_checks)
+* [outage_report_checks](#outage_report_checks)
+
---
-<a name="scheduled_maintenance_check"> </a>
-Return an array of scheduled maintenance periods for a check on an entity:
-```ruby
-# start time (Time object, optional)
-# end time (Time object, optional)
-Flapjack::Diner.scheduled_maintenances('example.com', :check => 'ping',
- :start_time => Time.local(2012, 08, 01),
- :end_time => Time.local(2012, 09, 01))
-```
+<a name="create_contacts"> </a>
+#### create_contacts
-The data is returned as an array of scheduled maintenance periods, with each element of the array being a hash containing data about that maintenance period.
+Create one or more contacts.
-```
-// the TIMESTAMPs are integers representing UTC times for the named events
-// DURATION is an integer representing the length of the period in seconds
-// SUMMARY is a string providing a description of the period, may be empty
-[{'start_time' => TIMESTAMP,
- 'duration' => DURATION,
- 'summary' => SUMMARY,
- 'end_time' => TIMESTAMP},
- {...},
- ...]
-```
-
----
-<a name="scheduled_maintenance"> </a>
-Return lists of scheduled maintenance periods for all checks on an entity:
-
```ruby
-# start time (Time object, optional)
-# end time (Time object, optional)
-Flapjack::Diner.scheduled_maintenances('example.com',
- :start_time => Time.local(2012, 08, 01),
- :end_time => Time.local(2012, 09, 01))
+Flapjack::Diner.create_contacts([CONTACT, ...])
```
-The data is returned as an array of hashes, where each hash represents the scheduled maintenance periods for a check under the entity :
-
```
-// CHECK is a string, e.g. 'ssh', 'ping'
-// SCHED_MAINT is a hash with the same format as an individual element of
-// the array returned from Flapjack::Diner.scheduled_maintenances(entity, check)
-[{'check' => CHECK,
- 'scheduled_maintenance' => [SCHED_MAINT, ...]
- },
- {'check' => CHECK,
- 'scheduled_maintenance' => [SCHED_MAINT, ...]
- }]
+CONTACT
+{
+ :id => STRING,
+ :first_name => STRING,
+ :last_name => STRING,
+ :email => STRING,
+ :tags => [STRING, ...]
+}
```
----
-<a name="scheduled_maintenance_bulk"> </a>
-Return lists of scheduled maintenance periods for all checks on some entities and specified checks on others.
+Returns true if creation succeeded or false if creation failed.
-```ruby
-# :entity - optional, may be a String or an Array of Strings (entity names)
-# :check - optional, Hash, keys are Strings (entity names), values are Strings
-# or Arrays of Strings (check names)
-# At least one of the :entity or :check arguments must be provided
-Flapjack::Diner.bulk_scheduled_maintenances(:entity => 'example.com',
- :check => {'example2.com' => ['PING', 'SSH'],
- 'example3.com' => 'PING'})
-```
+<a name="contacts"> </a>
+#### contacts
-The data is returned as an array, where each element is a hash with the format
+Return data for one, some or all contacts.
+```ruby
+contact = Flapjack::Diner.contacts(ID)
+some_contacts = Flapjack::Diner.contacts(ID1, ID2, ...)
+all_contacts = Flapjack::Diner.contacts
```
-// ENTITY is a string, one of the entity names provided in the entity or check arguments
-// CHECK is a string, e.g. 'ssh', 'ping'
-// SCHED_MAINT is a hash with the same format as an individual element of the array returned from Flapjack::Diner.scheduled_maintenances(entity, check)
-{'entity' => ENTITY
- 'check' => CHECK,
- 'scheduled_maintenances' => [SCHED_MAINT, ...]}
-```
-Please note the plural for the 'scheduled_maintenances' hash key, which is different to
-the other methods.
+<a name="update_contacts"> </a>
+#### update_contacts
----
-<a name="unscheduled_maintenance_check"> </a>
-Return an array of unscheduled maintenance periods for a check on an entity:
+Update data for one or more contacts.
```ruby
-# start time (Time object, optional)
-# end time (Time object, optional)
-Flapjack::Diner.unscheduled_maintenances('example.com', :check => 'ping',
- :start_time => Time.local(2012, 08, 01),
- :end_time => Time.local(2012, 09, 01))
+# update values for one contact
+Flapjack::Diner.update_contacts(ID, :key => value, ...)
+
+# update values for multiple contacts
+Flapjack::Diner.update_contacts(ID1, ID2, ..., :key => value, ...)
```
-The data is returned as an array of unscheduled maintenance periods, with each element of the array being a hash containing data about that maintenance period.
+Acceptable update field keys are
-```
-// the TIMESTAMPs are integers representing UTC times for the named events
-// DURATION is an integer representing the length of the period in seconds
-// SUMMARY is a string providing a description of the period, may be empty
-[{'start_time' => TIMESTAMP,
- 'duration' => DURATION,
- 'summary' => SUMMARY,
- 'end_time' => TIMESTAMP},
- {...},
- ...]
-```
+`:first_name`, `:last_name`, `:email`, and `:tags`
----
-<a name="unscheduled_maintenance"> </a>
-Return lists of unscheduled maintenance periods for all checks on an entity:
+as well as the linkage operations
-```ruby
-# start time (Time object, optional)
-# end time (Time object, optional)
-Flapjack::Diner.unscheduled_maintenances('example.com',
- :start_time => Time.local(2012, 08, 01),
- :end_time => Time.local(2012, 09, 01))
-```
+`:add_entity`, `:remove_entity`
+`:add_notification_rule`, `:remove_notification_rule`
-The data is returned as an array of hashes, where each hash represents the unscheduled maintenance periods for a check under the entity:
+which take the id of the relevant resource as the value.
-```
-// CHECK is a string, e.g. 'ssh', 'ping'
-// UNSCHED_MAINT is a hash with the same format as an individual element of
-// the array returned from Flapjack::Diner.unscheduled_maintenances(entity, check)
-[{'check' => CHECK,
- 'unscheduled_maintenance' => [UNSCHED_MAINT, ...]
- },
- {'check' => CHECK,
- 'unscheduled_maintenance' => [UNSCHED_MAINT, ...]
- }]
-```
+(NB: `:add_medium` and `:remove_medium` are not supported in Flapjack v1.0 but should be in future versions.)
----
-<a name="unscheduled_maintenance_bulk"> </a>
-Return lists of unscheduled maintenance periods for all checks on some entities and specified checks on others.
+Returns true if updating succeeded or false if updating failed.
-```ruby
-# :entity - optional, may be a String or an Array of Strings (entity names)
-# :check - optional, Hash, keys are Strings (entity names), values are Strings
-# or Arrays of Strings (check names)
-# At least one of the :entity or :check arguments must be provided
-Flapjack::Diner.bulk_unscheduled_maintenances(:entity => 'example.com',
- :check => {'example2.com' => ['PING', 'SSH'],
- 'example3.com' => 'PING'})
-```
+<a name="delete_contacts"> </a>
+#### delete_contacts
-The data is returned as an array, where each element is a hash with the format
+Delete one or more contacts.
+```ruby
+# delete one contact
+Flapjack::Diner.delete_contacts(ID)
+
+# delete multiple contacts
+Flapjack::Diner.delete_contacts(ID1, ID2, ...)
```
-// ENTITY is a string, one of the entity names provided in the entity or check arguments
-// CHECK is a string, e.g. 'ssh', 'ping'
-// UNSCHED_MAINT is a hash with the same format as an individual element of the
-// array returned from Flapjack::Diner.unscheduled_maintenances(entity, check)
-{'entity' => ENTITY
- 'check' => CHECK,
- 'unscheduled_maintenances' => [UNSCHED_MAINT, ...]
-}
-```
-Please note the plural for the 'unscheduled_maintenances' hash key, which is different to
-the other methods.
+Returns true if deletion succeeded or false if deletion failed.
---
-<a name="outages_check"> </a>
-Return an array of outages for a check on an entity (all times for which the check was failing):
+<a name="create_contact_media"> </a>
+#### create_contact_media
+
+Create one or more notification media.
+
```ruby
-# start time (Time object, optional)
-# end time (Time object, optional)
-Flapjack::Diner.outages('example.com', :check => 'ping',
- :start_time => Time.local(2012, 08, 01),
- :end_time => Time.local(2012, 09, 01))
+Flapjack::Diner.create_contact_media(CONTACT_ID, [MEDIUM, ...])
```
-The data is returned as an array of outage periods, with each element of the array being a hash containing data about that outage period.
-
```
-// STATE is a string, one of 'critical', 'warning', 'ok', 'unknown'
-// the TIMESTAMPs are integers representing UTC times for the named events
-// SUMMARY is a string providing a description of the period, may be empty
-[{'state' => STATE,
- 'start_time' => TIMESTAMP,
- 'end_time' => TIMESTAMP,
- 'summary' => SUMMARY},
- {...},
- ...]
+MEDIUM
+{
+ :type => STRING,
+ :address => STRING,
+ :interval => INTEGER,
+ :rollup_threshold => INTEGER
+}
```
----
-<a name="outages"> </a>
-Return lists of outages for all checks on an entity (all times for which said checks were failing):
+Returns true if creation succeeded or false if creation failed.
-```ruby
-# start time (Time object, optional)
-# end time (Time object, optional)
-Flapjack::Diner.outages('example.com', :start_time => Time.local(2012, 08, 01),
- :end_time => Time.local(2012, 09, 01))
-```
+<a name="media"> </a>
+#### media
-The data is returned as an array of hashes, where each hash represents the outages for a check under the entity:
+Return data for one, some or all notification media. Notification media ids are formed by compounding their linked contact's ID and their type in a string (e.g. '23_sms')
+```ruby
+medium = Flapjack::Diner.media(ID)
+some_media = Flapjack::Diner.media(ID1, ID2, ...)
+all_media = Flapjack::Diner.media
```
-// CHECK is a string, e.g. 'ssh', 'ping'
-// OUTAGE is a hash with the same format as an individual element of the array returned from Flapjack::Diner.outages(entity, check)
-[{'check' => CHECK,
- 'outages' => [OUTAGE, ...]
- },
- {'check' => CHECK,
- 'outages' => [OUTAGE, ...]
- }]
-```
----
-<a name="outages_bulk"> </a>
-Return lists of outages for all checks on some entities and specified checks on others.
+<a name="update_media"> </a>
+#### update_media
+Update data for one or more notification media.
+
```ruby
-# :entity - optional, may be a String or an Array of Strings (entity names)
-# :check - optional, Hash, keys are Strings (entity names), values are Strings
-# or Arrays of Strings (check names)
-# At least one of the :entity or :check arguments must be provided
-Flapjack::Diner.bulk_outages(:entity => 'example.com',
- :check => {'example2.com' => ['PING', 'SSH'],
- 'example3.com' => 'PING'})
-```
+# update values for one medium
+Flapjack::Diner.update_media(ID, :key => value, ...)
-The data is returned as an array, where each element is a hash with the format
-
+# update values for multiple media
+Flapjack::Diner.update_media(ID1, ID2, ..., :key => value, ...)
```
-// ENTITY is a string, one of the entity names provided in the entity or check arguments
-// CHECK is a string, e.g. 'ssh', 'ping'
-// OUTAGE is a hash with the same format as an individual element of the array
-// returned from Flapjack::Diner.outages(entity, check)
-{'entity' => ENTITY
- 'check' => CHECK,
- 'outages' => [OUTAGE, ...]
-}
-```
----
-<a name="downtimes_check"> </a>
-Return an array of downtimes for a check on an entity (outages outside of scheduled maintenance periods):
+Acceptable update field keys are
-```ruby
-# start time (Time object, optional)
-# end time (Time object, optional)
-Flapjack::Diner.downtime('example.com', :check => 'ping',
- :start_time => Time.local(2012, 08, 01),
- :end_time => Time.local(2012, 09, 01))
-```
+`:address`, `:interval`, `:rollup_threshold`
-Returns a hash with some statistics about the downtimes, including an array of the downtimes themselves. This may not be the same as would be returned from the 'outages' call for the same time period, as if scheduled maintenance periods overlap any of those times then they will be reduced, split or discarded to fit.
+Returns true if updating succeeded or false if updating failed.
-```
-// TOTAL SECONDS gives the sum of the time spent in that state for each check state.
-// PERCENTAGES represents the proportion of the total time that the check was
-// in each state. Will be null if either start or end time were not provided
-// in the request.
-// OUTAGE is a hash with the same format as an individual element of the array
-// returned from Flapjack::Diner.outages(entity, check).
-{'total_seconds' => {STATE => INTEGER, ...},
- 'percentages' => {STATE => INTEGER, ...},
- 'downtime' => [OUTAGE, ...]
-}
-```
+<a name="delete_media"> </a>
+#### delete_media
----
-<a name="downtimes"> </a>
-Return an array of downtimes for all checks on an entity (outages outside of scheduled maintenance periods):
+Delete one or more notification media.
```ruby
-# start time (Time object, optional)
-# end time (Time object, optional)
-Flapjack::Diner.downtime('example.com', :start_time => Time.local(2012, 08, 01),
- :end_time => Time.local(2012, 09, 01))
-```
+# delete one medium
+Flapjack::Diner.delete_media(ID)
-The data is returned as an array of hashes, where each hash represents a downtime report for a check under the entity:
-
+# delete multiple media
+Flapjack::Diner.delete_media(ID1, ID2, ...)
```
-// CHECK is a string, e.g. 'ssh', 'ping'
-// DOWNTIME is a hash with the same format those returned from
-// Flapjack::Diner.downtime(entity, check)
-[{'check' => CHECK,
- 'downtime' => [DOWNTIME, ...]
- },
- {'check' => CHECK,
- 'downtime' => [DOWNTIME, ...]
- }]
-```
+Returns true if deletion succeeded or false if deletion failed.
+
---
-<a name="downtimes_bulk"> </a>
-Return lists of downtimes for all checks on some entities and specified checks on others.
+<a name="create_contact_pagerduty_credentials"> </a>
+#### create_contact_media
+Create pagerduty credentials for a contact.
+
```ruby
-# :entity - optional, may be a String or an Array of Strings (entity names)
-# :check - optional, Hash, keys are Strings (entity names), values are Strings
-# or Arrays of Strings (check names)
-# At least one of the :entity or :check arguments must be provided
-Flapjack::Diner.bulk_downtime(:entity => ['example.com', 'example4.com'],
- :check => {'example2.com' => ['PING', 'SSH'],
- 'example3.com' => 'PING'})
+Flapjack::Diner.create_contact_pagerduty_credentials(CONTACT_ID, PAGERDUTY_CREDENTIALS)
```
-The data is returned as an array, where each element is a hash with the format
-
```
-// ENTITY is a string, one of the entity names provided in the entity or check arguments
-// CHECK is a string, e.g. 'ssh', 'ping'
-// DOWNTIME is a hash with the same format as an individual element of the array
-// returned from Flapjack::Diner.downtime(entity, check)
-{'entity' => ENTITY
- 'check' => CHECK,
- 'downtime' => [DOWNTIME, ...]
+PAGERDUTY_CREDENTIALS
+{
+ :service_key => STRING,
+ :subdomain => STRING,
+ :username => STRING,
+ :password => STRING
}
```
----
-<a name="create_scheduled_maintenance"> </a>
-Create a scheduled maintenance period for a check on an entity:
+Returns true if creation succeeded or false if creation failed.
-```ruby
-# start_time (Time object, required)
-# duration (Integer, required) is measured in seconds
-# summary (String, optional)
-Flapjack::Diner.create_scheduled_maintenance!('example.com', 'ping',
- :start_time => Time.local(2012, 12, 01), :duration => (60 * 60),
- :summary => 'changing stuff')
-```
+<a name="pagerduty_credentials"> </a>
+#### pagerduty_credentials
-Returns a boolean value representing the success or otherwise of the creation of the scheduled maintenance period by the server.
+Return pagerduty credentials for a contact.
----
-<a name="create_scheduled_maintenance_bulk"> </a>
-Create scheduled maintenance periods for all checks on some entities and specified checks on others.
-
```ruby
-# start_time (Time object, required)
-# duration (Integer, required) is measured in seconds
-# summary (String, optional)
-Flapjack::Diner.bulk_create_scheduled_maintenance!(:entity => ['example.com', 'example2.com'],
- :check => {'example3.com' => 'ping'}, :start_time => Time.local(2012, 12, 01),
- :duration => (60 * 60), :summary => 'changing stuff')
+pagerduty_credentials = Flapjack::Diner.pagerduty_credentials(CONTACT_ID)
+some_pagerduty_credentials = Flapjack::Diner.pagerduty_credentials(CONTACT_ID1, CONTACT_ID2, ...)
+all_pagerduty_credentials = Flapjack::Diner.pagerduty_credentials
```
-Returns a boolean value representing the success or otherwise of the creation of the scheduled maintenance periods by the server.
+<a name="update_pagerduty_credentials"> </a>
+#### update_pagerduty_credentials
----
-<a name="delete_scheduled_maintenance"> </a>
-Delete a scheduled maintenance period for a check on an entity:
+Update pagerduty credentials for one or more contacts.
```ruby
-# start_time (Time object, required)
-Flapjack::Diner.delete_scheduled_maintenance!('example.com', 'ping',
- :start_time => Time.local(2012, 12, 01))
+# update pagerduty_credentials for one contact
+Flapjack::Diner.update_pagerduty_credentials(CONTACT_ID, :key => value, ...)
+
+# update pagerduty_credentials for multiple contacts
+Flapjack::Diner.update_pagerduty_credentials(CONTACT_ID1, CONTACT_ID2, ..., :key => value, ...)
```
-Returns a boolean value representing the success or otherwise of the deletion of the scheduled maintenance periods by the server.
+Acceptable update field keys are
----
-<a name="delete_scheduled_maintenance_bulk"> </a>
-Delete a scheduled maintenance period for all checks on some entities and specified checks on others.
+`:service_key`, `:subdomain`, `:username`, `:password`
-```ruby
-# start_time (Time object, required)
-Flapjack::Diner.bulk_delete_scheduled_maintenance!(:check => {'example.com' => ['ping', 'ssh']},
- :start_time => Time.local(2012, 12, 01))
-```
+Returns true if updating succeeded or false if updating failed.
-Returns a boolean value representing the success or otherwise of the deletion of the scheduled maintenance periods by the server.
+<a name="delete_pagerduty_credentials"> </a>
+#### delete_pagerduty_credentials
----
-<a name="acknowledge"> </a>
-Acknowledge the current state for a check on an entity:
+Delete pagerduty credentials for one or more contacts
```ruby
-# summary (String, optional)
-Flapjack::Diner.acknowledge!('example.com', 'ping', :summary => 'ack')
+# delete pagerduty_credentials for one contact
+Flapjack::Diner.delete_pagerduty_credentials(CONTACT_ID)
+
+# delete pagerduty_credentials for multiple contacts
+Flapjack::Diner.delete_pagerduty_credentials(CONTACT_ID1, CONTACT_ID2, ...)
```
-Returns a boolean value representing the success or otherwise of the creation of the acknowledgement by the server.
+Returns true if deletion succeeded or false if deletion failed.
---
-<a name="acknowledge_bulk"> </a>
-Acknowledge the current state for all checks on some entities and specified checks on others.
-```ruby
-# summary (String, optional)
-Flapjack::Diner.bulk_acknowledge!(:entity => 'example.com',
- :check => {'example2.com' => 'ping'}, :summary => 'ack')
-```
+<a name="create_contact_notification_rules"> </a>
+#### create_contact_notification_rules
-Returns a boolean value representing the success or otherwise of the creation of the acknowledgements by the server.
+Create one or more notification rules.
----
-<a name="delete_unscheduled_maintenance"> </a>
-Delete an unscheduled maintenance period for a check on an entity:
-
```ruby
-# end_time (Time object, optional)
-Flapjack::Diner.delete_unscheduled_maintenance!('example.com', 'ping',
- :end_time => Time.local(2012, 12, 01))
+Flapjack::Diner.create_contact_notification_rules(CONTACT_ID, [NOTIFICATION_RULE, ...])
```
-Returns a boolean value representing the success or otherwise of the deletion of the scheduled maintenance periods by the server.
+```
+NOTIFICATION_RULE
+{
+ :id => STRING,
+ :entities => [STRING, ...],
+ :regex_entities => [STRING, ...],
+ :tags => [STRING, ...],
+ :regex_tags => [STRING, ...],
+ :time_restrictions => TODO,
+ :unknown_media => [STRING, ...],
+ :warning_media => [STRING, ...],
+ :critical_media => [STRING, ...],
+ :unknown_blackhole => BOOLEAN,
+ :warning_blackhole => BOOLEAN,
+ :critical_blackhole => BOOLEAN
+}
+```
----
-<a name="delete_unscheduled_maintenance_bulk"> </a>
-Delete unscheduled maintenance periods for all checks on some entities and specified checks on others.
+Returns true if creation succeeded or false if creation failed.
+<a name="notification_rules"> </a>
+#### notification_rules
+
+Return data for one, some or all notification rules.
+
```ruby
-# end_time (Time object, optional)
-Flapjack::Diner.bulk_delete_unscheduled_maintenance!(:check => {'example.com' => ['ping', 'ssh']},
- :end_time => Time.local(2012, 12, 01))
+notification_rule = Flapjack::Diner.notification_rules(ID)
+some_notification_rules = Flapjack::Diner.notification_rules(ID1, ID2, ...)
+all_notification_rules = Flapjack::Diner.notification_rules
```
-Returns a boolean value representing the success or otherwise of the deletion of the scheduled maintenance periods by the server.
+<a name="update_notification_rules"> </a>
+#### update_notification_rules
----
-<a name="test_notifications"> </a>
-Generate test notifications for a check on an entity:
+Update data for one or more notification rules.
```ruby
-# summary (String, optional)
-Flapjack::Diner.test_notifications!('example.com', 'HOST',
- :summary => 'Testing notifications to all contacts interested in the HOST check on example.com')
+# update values for one notification rule
+Flapjack::Diner.update_notification_rules(ID, :key => value, ...)
+
+# update values for multiple notification rules
+Flapjack::Diner.update_notification_rules(ID1, ID2, ..., :key => value, ...)
```
-Returns a boolean value representing the success or otherwise of the creation of the notifications by the server.
+Acceptable update field keys are
----
-<a name="test_notifications_bulk"> </a>
-Generate test notifications for all checks on some entities and specified checks on others.
+`:entities`, `:regex_entities`, `:tags`, `:regex_tags`, `:time_restrictions`, `:unknown_media`, `:warning_media`, `:critical_media`, `:unknown_blackhole`, `:warning_blackhole`, and `:critical_blackhole`
-```ruby
-# summary (String, optional)
-Flapjack::Diner.bulk_test_notifications!(:entity => 'example.com',
- :check => {'example2.com' => 'ping'}, :summary => 'Testing notifications')
-```
+Returns true if updating succeeded or false if updating failed.
-Returns a boolean value representing the success or otherwise of the creation of the notifications by the server.
+<a name="delete_notification_rules"> </a>
+#### delete_contacts
----
-<a name="get_entity_tags"> </a>
-Get all tags for an entity.
+Delete one or more notification rules.
```ruby
-# entity name (String, required)
-Flapjack::Diner.entity_tags('example.com')
+# delete one medium
+Flapjack::Diner.delete_notification_rules(ID)
+
+# delete multiple contacts
+Flapjack::Diner.delete_notification_rules(ID1, ID2, ...)
```
-The data is returned as an array of strings; each string is a named tag set on the entity. The array may be empty.
+Returns true if deletion succeeded or false if deletion failed.
---
-<a name="add_entity_tags"> </a>
-Add one or more tags to an entity.
+<a name="create_entities"> </a>
+### create_entities
+
+Create one or more entities.
+
```ruby
-# entity name (String, required)
-# *tags (at least one String)
-Flapjack::Diner.add_entity_tags!('example.com', 'tag1', 'tag2')
+Flapjack::Diner.create_entities([ENTITY, ...])
```
-The data is returned as an array of strings; each string is a named tag set on the entity. The array will, at a minimum, contain the tag(s) added by the request.
+```
+ENTITY
+{
+ :id => STRING,
+ :name => STRING,
+ :tags => [STRING, ...]
+}
+```
----
-<a name="delete_entity tags"> </a>
-Delete one or more tags from an entity.
+Returns true if creation succeeded or false if creation failed.
+<a name="entities"> </a>
+### entities
+
+Return data for one, some or all entities.
+
```ruby
-# entity name (String, required)
-# *tags (at least one String)
-Flapjack::Diner.delete_entity_tags!('example.com', 'tag1')
+entity = Flapjack::Diner.entities(ID)
+some_entities = Flapjack::Diner.entities(ID1, ID2, ...)
+all_entities = Flapjack::Diner.entities
```
-Returns a boolean representing the success (or otherwise) of the tag deletion.
+<a name="update_entities"> </a>
+### update_entities
----
-<a name="get_contact_tags"> </a>
-Get all tags for a contact.
+Update data for one or more entities.
```ruby
-# contact ID (String, required)
-Flapjack::Diner.contact_tags('21')
+# update values for one entity
+Flapjack::Diner.update_entities(ID, :key => value, ...)
+
+# update values for multiple entities
+Flapjack::Diner.update_entities(ID1, ID2, ..., :key => value, ...)
```
-The data is returned as an array of strings; each string is a named tag set on the contact. The array may be empty.
+Acceptable update field keys are
----
-<a name="add_contact_tags"> </a>
-Add one or more tags to a contact.
+`:name` and `:tags`
-```ruby
-# contact ID (String, required)
-# *tags (at least one String)
-Flapjack::Diner.add_contact_tags!('21', 'tag1', 'tag2')
-```
+as well as the linkage operations
-The data is returned as an array of strings; each string is a named tag set on the contact. The array will, at a minimum, contain the tag(s) added by the request.
+`:add_contact` and `:remove_contact`
----
-<a name="delete_contact_tags"> </a>
-Delete one or more tags from a contact.
+which take the id of the relevant contact as the value.
-```ruby
-# contact ID (String, required)
-# *tags (at least one String)
-Flapjack::Diner.delete_contact_tags!('21', 'tag1')
-```
+Returns true if updating succeeded or false if updating failed.
-Returns a boolean representing the success (or otherwise) of the tag deletion.
----
-<a name="get_contact_entitytags"> </a>
-Get all tags for entities linked to a contact.
+<a name="create_scheduled_maintenances_entities"> </a>
+### create_scheduled_maintenances_entities
+Create one or more scheduled maintenance periods (`duration` seconds in length) on all checks for the provided entities.
+
```ruby
-# contact ID (String, required)
-Flapjack::Diner.contact_entitytags('21')
+Flapjack::Diner.create_scheduled_maintenances_entities(ENTITY_ID(S), [SCHEDULED_MAINTENANCE, ...])
```
-The data is returned as a Hash, with String keys representing entity names, and Arrays of String values representing the tags for each named entity.
-
```
+SCHEDULED_MAINTENANCE
{
- ENTITY => [TAG, ...],
- ENTITY => [TAG, ...],
- ...
+ :start_time => DATETIME,
+ :duration => INTEGER,
+ :summary => STRING
}
```
----
-<a name="add_contact_entitytags"> </a>
-Add one or more tags to entities linked to a contact.
+Returns true if creation succeeded or false if creation failed.
-```ruby
-# contact ID (String, required)
-# entity_tags (Hash, required - similar format as returned by 'contact_entitytags')
-Flapjack::Diner.add_contact_entitytags!('21', {'entity1' => ['web'], 'entity2' => ['app']})
-```
+<a name="delete_scheduled_maintenances_entities"> </a>
+### delete_scheduled_maintenances_entities
-The data is returned as a Hash, reflecting the current tags for the contact's linked entities. This is in the same format as the ```contact_entitytags``` call returns.
+Delete scheduled maintenance periods starting at a specific time for checks across one or more entities.
----
-<a name="delete_contact_entitytags"> </a>
-Delete one or more tags from entities linked to a contact.
-
```ruby
-# contact ID (String, required)
-# entity_tags (Hash, required - similar format as returned by 'contact_entitytags')
-Flapjack::Diner.add_contact_entitytags!('21', {'entity1' => ['web'], 'entity2' => ['app']})
+Flapjack::Diner.delete_scheduled_maintenances_entities(ENTITY_ID(S), :start_time => DATETIME)
```
-Returns a boolean representing the success (or otherwise) of the tag deletion.
+Returns true if deletion succeeded or false if deletion failed. Raises an exception if the `:start_time` parameter is not supplied.
----
-<a name="contacts"> </a>
-Gets all contact records.
+<a name="create_unscheduled_maintenances_entities"> </a>
+### create_unscheduled_maintenances_entities
-```ruby
-Flapjack::Diner.contacts
-```
+Acknowledges any failing checks on the passed entities and sets up unscheduled maintenance (`duration` seconds long) on them.
-The data is returned as an array of hashes, where each hash represents a contact. The tags array will be empty if the associated contact has no tags.
-
```ruby
-[
- {
- 'id' => STRING,
- 'first_name' => STRING,
- 'last_name' => STRING,
- 'email' => STRING,
- 'tags' => [STRING, ...]
- },
- ...
-]
+Flapjack::Diner.create_unscheduled_maintenances_entities(ENTITY_ID(S), [SCHEDULED_MAINTENANCE, ...])
```
----
-<a name="contact"> </a>
-Get a single contact record.
-
-```ruby
-# contact_id (String, required)
-Flapjack::Diner.contact('contact23')
```
-
-The contact record is returned as a hash (a singular instance of what is returned in the full contact list). The tags array will be empty if the contact has no tags
-
-```ruby
+UNSCHEDULED_MAINTENANCE
{
- 'id' => STRING,
- 'first_name' => STRING,
- 'last_name' => STRING,
- 'email' => STRING,
- 'tags' => [STRING, ...]
+ :duration => INTEGER,
+ :summary => STRING
}
```
----
-<a name="notification_rules"> </a>
-Gets the notification rules belonging to a contact.
+Returns true if creation succeeded or false if creation failed.
-```ruby
-# contact_id (String, required)
-Flapjack::Diner.notification_rules('contact23')
-```
+<a name="update_unscheduled_maintenances_entities"> </a>
+### update_unscheduled_maintenances_entities
-Returns an array of hashes, where a single hash represents a notification rule record. NB 'time_restrictions' have not yet been implemented, but we're noting the use of the field name here as it will be meaningful in the future.
+Finalises currently existing unscheduled maintenance periods for all acknowledged checks in the provided entities. The periods end at the time provided in the `:end_time` parameter.
```ruby
-# contact_id (String, as provided in the request)
-# rule_id (String, allocated on creation, immutable)
-[
- {
- 'id' => RULE_ID,
- 'contact_id' => CONTACT_ID,
- 'entity_tags' => [STRING, ...]
- 'entities' => [STRING, ...],
- 'time_restrictions' => [],
- 'warning_media' => [STRING, ...],
- 'critical_media' => [STRING, ...],
- 'warning_blackhole' => BOOLEAN,
- 'critical_blackhole' => BOOLEAN
- },
- ...
-]
+Flapjack::Diner.update_unscheduled_maintenances_entities(ENTITY_ID(S), :end_time => DATETIME)
```
----
-<a name="notification_rule"> </a>
-Gets a single notification rule belonging to a contact.
+Returns true if the finalisation succeeded or false if deletion failed.
-```ruby
-# rule_id (String, required)
-Flapjack::Diner.notification_rule('08f607c7-618d-460a-b3fe-868464eb6045')
-```
+<a name="create_test_notifications_entities"> </a>
+### create_test_notifications_entities
-Returns a hash representing a notification rule record (a singular instance of what is returned in a list of a contact's notification rules). NB 'time_restrictions' have not yet been implemented, but we're noting the use of the field name here as it will be meaningful in the future.
+Instructs Flapjack to issue test notifications on all checks for the passed entities. These notifications will be sent to contacts configured to receive notifications for those checks.
```ruby
-# RULE_ID (String, as provided in the request)
-# CONTACT_ID (String)
+Flapjack::Diner.create_test_notifications_entities(ENTITY_ID(S), [TEST_NOTIFICATION, ...])
+```
+
+```
+TEST_NOTIFICATION
{
- 'id' => RULE_ID,
- 'contact_id' => CONTACT_ID,
- 'entity_tags' => [STRING, ...]
- 'entities' => [STRING, ...],
- 'time_restrictions' => [],
- 'warning_media' => [STRING, ...],
- 'critical_media' => [STRING, ...],
- 'warning_blackhole' => BOOLEAN,
- 'critical_blackhole' => BOOLEAN
+ :summary => STRING
}
```
+Returns true if creation succeeded or false if creation failed.
+
---
-<a name="create_notification_rule"> </a>
-Creates a notification rule for a contact.
-```ruby
-# rule_data (Hash, will be converted via to_json)
-# contact_id (String, required)
-# entity_tags (Array of Strings, may be empty; either this or 'entities' must have some content)
-# entities (Array of Strings, may be empty; either this or 'entity_tags' must have some content)
-# time_restrictions (TBD)
-# warning_media (Array of Strings, may be empty; each represents a media type)
-# critical_media (Array of Strings, may be empty; each represents a media type)
-# warning_blackhole (Boolean, required)
-# critical_blackhole (Boolean, required)
-Flapjack::Diner.create_notification_rule!({
- 'contact_id' => 'contact23',
- 'entity_tags' => ['database'],
- 'entities' => ['app-1.example.com']
- 'time_restrictions' => [],
- 'warning_media' => ['email'],
- 'critical_media' => ['email', 'sms'],
- 'warning_blackhole' => false,
- 'critical_blackhole' => false
-}
-})
-```
+<a name="create_scheduled_maintenances_checks"> </a>
+### create_scheduled_maintenances_checks
-Returns a hash represeting the created notification rule. This is the same data you would receive from ```Flapjack::Diner.notification_rule(rule_id)```.
+Create one or more scheduled maintenance periods (`duration` seconds in length) on one or more checks. (Check ids are composed by joining together the check's entity's name, the character ':' and the check's name.)
```ruby
-# RULE_ID (String, as provided in the request)
-# CONTACT_ID (String)
+Flapjack::Diner.create_scheduled_maintenances_checks(CHECK_ID(S), [SCHEDULED_MAINTENANCE, ...])
+```
+
+```
+SCHEDULED_MAINTENANCE
{
- 'id' => RULE_ID,
- 'contact_id' => CONTACT_ID,
- 'entity_tags' => [STRING, ...]
- 'entities' => [STRING, ...],
- 'time_restrictions' => [],
- 'warning_media' => [STRING, ...],
- 'critical_media' => [STRING, ...],
- 'warning_blackhole' => BOOLEAN,
- 'critical_blackhole' => BOOLEAN
+ :start_time => DATETIME,
+ :duration => INTEGER,
+ :summary => STRING
}
```
----
-<a name="update_notification_rule"> </a>
-Updates a notification rule for a contact.
+Returns true if creation succeeded or false if creation failed.
+<a name="delete_scheduled_maintenances_checks"> </a>
+### delete_scheduled_maintenances_checks
+
+Delete scheduled maintenance periods starting at a specific time for one or more checks. (Check ids are composed by joining together the check's entity's name, the character ':' and the check's name.)
+
```ruby
-# rule_id (String, required)
-# rule_data (Hash, will be converted via to_json)
-# contact_id (String, required)
-# entity_tags (Array of Strings, may be empty; either this or 'entities' must have some content)
-# entities (Array of Strings, may be empty; either this or 'entity_tags' must have some content)
-# time_restrictions (TBD)
-# warning_media (Array of Strings, may be empty; each represents a media type)
-# critical_media (Array of Strings, may be empty; each represents a media type)
-# warning_blackhole (Boolean, required)
-# critical_blackhole (Boolean, required)
-Flapjack::Diner.update_notification_rule!('08f607c7-618d-460a-b3fe-868464eb6045', {
- 'contact_id' => 'contact23',
- 'entity_tags' => ['database'],
- 'entities' => ['app-1.example.com']
- 'time_restrictions' => [],
- 'warning_media' => ['email'],
- 'critical_media' => ['email', 'sms'],
- 'warning_blackhole' => false,
- 'critical_blackhole' => false
-})
+Flapjack::Diner.delete_scheduled_maintenances_checks(CHECK_ID(S), :start_time => DATETIME)
```
-Returns a hash represeting the updated notification rule. This is the same data you would receive from ```Flapjack::Diner.notification_rule(rule_id)```.
+Returns true if deletion succeeded or false if deletion failed. Raises an exception if the `:start_time` parameter is not supplied.
+<a name="create_unscheduled_maintenances_checks"> </a>
+### create_unscheduled_maintenances_checks
+
+Acknowledges any failing checks from those passed and sets up unscheduled maintenance (`duration` seconds long) on them. (Check ids are composed by joining together the check's entity's name, the character ':' and the check's name.)
+
```ruby
-# RULE_ID (String, as provided in the request)
-# CONTACT_ID (String)
+Flapjack::Diner.create_unscheduled_maintenances_checks(CHECK_ID(S), [SCHEDULED_MAINTENANCE, ...])
+```
+
+```
+UNSCHEDULED_MAINTENANCE
{
- 'id' => RULE_ID,
- 'contact_id' => CONTACT_ID,
- 'entity_tags' => [STRING, ...]
- 'entities' => [STRING, ...],
- 'time_restrictions' => [],
- 'warning_media' => [STRING, ...],
- 'critical_media' => [STRING, ...],
- 'warning_blackhole' => BOOLEAN,
- 'critical_blackhole' => BOOLEAN
+ :duration => INTEGER,
+ :summary => STRING
}
```
----
-<a name="delete_notification_rule"> </a>
-Deletes a notification rule from a contact.
+Returns true if creation succeeded or false if creation failed.
+<a name="update_unscheduled_maintenances_checks"> </a>
+### update_unscheduled_maintenances_checks
+
+Finalises currently existing unscheduled maintenance periods for acknowledged checks. The periods end at the time provided in the `:end_time` parameter. (Check ids are composed by joining together the check's entity's name, the character ':' and the check's name.)
+
```ruby
-# rule_id (String, required)
-Flapjack::Diner.delete_notification_rule!('08f607c7-618d-460a-b3fe-868464eb6045')
+Flapjack::Diner.update_unscheduled_maintenances_checks(CHECK_ID(S), :end_time => DATETIME)
```
-Returns a boolean value representing the success or otherwise of the deletion of the notification rule.
+Returns true if the finalisation succeeded or false if deletion failed.
----
-<a name="notification_media"> </a>
-Return a list of a contact's notification media values.
+<a name="create_test_notifications_checks"> </a>
+### create_test_notifications_checks
+Instructs Flapjack to issue test notifications on the passed checks. These notifications will be sent to contacts configured to receive notifications for those checks. (Check ids are composed by joining together the check's entity's name, the character ':' and the check's name.)
+
```ruby
-# contact_id (String, required)
-Flapjack::Diner.contact_media('contact23')
+Flapjack::Diner.create_test_notifications_checks(CHECK_ID(S), [TEST_NOTIFICATION, ...])
```
-Returns a hash of hashes, where the first layer of keys are the media types (e.g. 'email', 'sms') and the
-hashes for each of those media type keys contain address and notification interval values.
-
-```ruby
-# interval (Integer, in seconds - notifications will not be sent more often than this through this medium)
+```
+TEST_NOTIFICATION
{
- MEDIA_TYPE => { 'address' => STRING,
- 'interval' => INTEGER },
- ...
+ :summary => STRING
}
```
+Returns true if creation succeeded or false if creation failed.
+
---
-<a name="notification_medium"> </a>
-Get the values for a contact's notification medium.
+<a name="status_report_entities"> </a>
+### status_report_entities
+
+Return a report on status data for checks in one, some or all entities.
+
```ruby
-# contact_id (String, required)
-# media_type (String, required)
-Flapjack::Diner.contact_medium('contact23', 'sms')
+report = Flapjack::Diner.status_report_entities(ENTITY_ID)
+report_some = Flapjack::Diner.status_report_entities(ENTITY_ID1, ENTITY_ID2, ...)
+report_all = Flapjack::Diner.status_report_entities
```
-Returns a hash corresponding to a single hash of medium values from those returned by ```Flapjack::Diner.contact_media()```.
+<a name="scheduled_maintenance_report_entities"> </a>
+### scheduled_maintenance_report_entities
+Return a report on scheduled maintenance periods for checks in one, some or all entities.
+
```ruby
-# interval (Integer, in seconds - notifications will not be sent more often than this through this medium)
-{ 'address' => STRING,
- 'interval' => INTEGER },
+report = Flapjack::Diner.scheduled_maintenance_report_entities(ENTITY_ID)
+report_some = Flapjack::Diner.scheduled_maintenance_report_entities(ENTITY_ID1, ENTITY_ID2, ...)
+report_all = Flapjack::Diner.scheduled_maintenance_report_entities
```
----
-<a name="update_notification_medium"> </a>
-Update the values for a contact's notification medium.
+<a name="unscheduled_maintenance_report_entities"> </a>
+### unscheduled_maintenance_report_entities
+Return a report on unscheduled maintenance periods for checks in one, some or all entities.
+
```ruby
-# contact_id (String, required)
-# media_type (String, required)
-Flapjack::Diner.update_contact_medium!('contact23', 'email', {
- 'address' => 'example@example.com',
- 'interval' => 300
-})
+report = Flapjack::Diner.unscheduled_maintenance_report_entities(ENTITY_ID)
+report_some = Flapjack::Diner.unscheduled_maintenance_report_entities(ENTITY_ID1, ENTITY_ID2, ...)
+report_all = Flapjack::Diner.unscheduled_maintenance_report_entities
```
-Returns the hash that was submitted.
+<a name="downtime_report_entities"> </a>
+### downtime_report_entities
+Return a report on downtime data for checks in one, some or all entities.
+
```ruby
-# interval (Integer, in seconds - notifications will not be sent more often than this through this medium)
-{ 'address' => STRING,
- 'interval' => INTEGER },
+report = Flapjack::Diner.downtime_report_entities(ENTITY_ID)
+report_some = Flapjack::Diner.downtime_report_entities(ENTITY_ID1, ENTITY_ID2, ...)
+report_all = Flapjack::Diner.downtime_report_entities
```
----
-<a name="delete_notification_medium"> </a>
-Delete a contact's notification medium.
+<a name="outage_report_entities"> </a>
+### outage_report_entities
+Return a report on outage data for checks in one, some or all entities.
+
```ruby
-# contact_id (String, required)
-# media_type (String, required)
-Flapjack::Diner.delete_contact_medium!('contact23', 'sms')
+report = Flapjack::Diner.outage_report_entities(ENTITY_ID)
+report_some = Flapjack::Diner.outage_report_entities(ENTITY_ID1, ENTITY_ID2, ...)
+report_all = Flapjack::Diner.outage_report_entities
```
-Returns a boolean value representing the success or otherwise of the deletion of the notification medium values.
+<a name="status_report_checks"> </a>
+### status_report_checks
----
-<a name="contact_timezone"> </a>
-Get a contact's timezone.
+Return a report on status data for one, some or all checks. (Check ids are composed by joining together the check's entity's name, the character ':' and the check's name.)
```ruby
-# contact_id (String, required)
-Flapjack::Diner.contact_timezone('contact23')
+report = Flapjack::Diner.status_report_checks(CHECK_ID)
+report_some = Flapjack::Diner.status_report_checks(CHECK_ID1, CHECK_ID2, ...)
+report_all = Flapjack::Diner.status_report_checks
```
-Returns a timezone string, as defined in the [timezone database](http://www.twinsun.com/tz/tz-link.htm).
+<a name="scheduled_maintenance_report_checks"> </a>
+### scheduled_maintenance_report_checks
+Return a report on scheduled maintenance periods for one, some or all checks. (Check ids are composed by joining together the check's entity's name, the character ':' and the check's name.)
+
```ruby
-'Australia/Perth'
+report = Flapjack::Diner.scheduled_maintenance_report_checks(CHECK_ID)
+report_some = Flapjack::Diner.scheduled_maintenance_report_checks(CHECK_ID1, CHECK_ID2, ...)
+report_all = Flapjack::Diner.scheduled_maintenance_report_checks
```
----
-<a name="update_contact_timezone"> </a>
-Update a contact's timezone.
+<a name="unscheduled_maintenance_report_checks"> </a>
+### unscheduled_maintenance_report_checks
+Return a report on unscheduled maintenance periods for one, some or all checks. (Check ids are composed by joining together the check's entity's name, the character ':' and the check's name.)
+
```ruby
-# contact_id (String, required)
-# timezone (String, required)
-Flapjack::Diner.update_contact_timezone!('contact23', 'Australia/Sydney')
+report = Flapjack::Diner.unscheduled_maintenance_report_checks(CHECK_ID)
+report_some = Flapjack::Diner.unscheduled_maintenance_report_checks(CHECK_ID1, CHECK_ID2, ...)
+report_all = Flapjack::Diner.unscheduled_maintenance_report_checks
```
-Returns the timezone string provided as a parameter.
+<a name="downtime_report_checks"> </a>
+### downtime_report_checks
+Return a report on downtim data for one, some or all checks. (Check ids are composed by joining together the check's entity's name, the character ':' and the check's name.)
+
```ruby
-'Australia/Sydney'
+report = Flapjack::Diner.downtime_report_checks(CHECK_ID)
+report_some = Flapjack::Diner.downtime_report_checks(CHECK_ID1, CHECK_ID2, ...)
+report_all = Flapjack::Diner.downtime_report_checks
```
----
-<a name="delete_contact_timezone"> </a>
-Delete a contact's timezone. (If a contact's timezone is unknown they will be assumed to share the Flapjack server's timezone.)
+<a name="outage_report_checks"> </a>
+### outage_report_checks
+Return a report on outage data for one, some or all checks. (Check ids are composed by joining together the check's entity's name, the character ':' and the check's name.)
+
```ruby
-# contact_id (String, required)
-Flapjack::Diner.delete_contact_timezone!('contact_23')
+report = Flapjack::Diner.outage_report_checks(CHECK_ID)
+report_some = Flapjack::Diner.outage_report_checks(CHECK_ID1, CHECK_ID2, ...)
+report_all = Flapjack::Diner.outage_report_checks
```
-
-Returns a boolean value representing the success or otherwise of the deletion of the contact's timezone.
---
## Contributing