Module: PagerDuty::Client::Abilities

Included in:

PagerDuty::Client

Defined in:

lib/pager_duty/client/abilities.rb

Overview

This describes your account’s abilities by feature name, like teams.

An ability may be available to your account based on things like your pricing plan or account state.

See Also:

• https://v2.developer.pagerduty.com/v2/page/api-reference#!/Abilities

Instance Method Summary

• #abilities(options = {}) ⇒ Array<Sawyer::Resource> (also: #list_abilities)

  List all of your account’s abilities, by name.

• #ability(ability, options = {}) ⇒ Boolean (also: #has_ability)

  Test whether your account has a given ability.

Instance Method Details

#abilities(options = {}) ⇒ Array<Sawyer::Resource> Also known as: list_abilities

List all of your account’s abilities, by name.

Returns:

• (Array<Sawyer::Resource>) —

  An array of strings representing abilities

See Also:

• https://v2.developer.pagerduty.com/v2/page/api-reference#!/Abilities/get_abilities

# File 'lib/pager_duty/client/abilities.rb', line 12

def abilities(options = {})
  response = get "/abilities", options
  response[:abilities]
end

#ability(ability, options = {}) ⇒ Boolean Also known as: has_ability

Test whether your account has a given ability.

Parameters:

• ability (String) —

  Ability to check

Returns:

• (Boolean) —

  Whether your account has the ability

See Also:

• https://v2.developer.pagerduty.com/v2/page/api-reference#!/Abilities/get_abilities_id

# File 'lib/pager_duty/client/abilities.rb', line 23

def ability(ability, options = {})
  boolean_from_response :get, "/abilities/#{ability}", options
end