Module: PagerDuty::Client::Vendors

Included in:

PagerDuty::Client

Defined in:

lib/pager_duty/client/vendors.rb

Overview

Module encompassing interactions with the vendors API endpoint

A PagerDuty vendor represents a specific type of integration.

AWS Cloudwatch, Splunk, Datadog, etc are all examples of vendors that can be integrated in PagerDuty by making an integration.

Vendored integrations (when compared to generic email and API integrations) are automatically configured with the right API or email filtering settings for inbound events from that vendor.

Some vendors also have associated integration guides on the PagerDuty support site.

See Also:

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

Instance Method Summary

• #vendor(id, options = {}) ⇒ Sawyer::Resource (also: #get_vendor)

  Get details about one specific vendor.

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

  List all vendors.

Instance Method Details

#vendor(id, options = {}) ⇒ Sawyer::Resource Also known as: get_vendor

Get details about one specific vendor.

Parameters:

• id (String) —

  A vendor id (required)

• options (Sawyer::Resource) (defaults to: {}) —

  A customizable set of options.

Returns:

• (Sawyer::Resource) —

  A hash representing vendor

See Also:

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

# File 'lib/pager_duty/client/vendors.rb', line 31

def vendor(id, options = {})
  response = get "/vendors/#{id}", options
  response[:vendor]
end

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

List all vendors.

Parameters:

• options (Sawyer::Resource) (defaults to: {}) —

  A customizable set of options.

Returns:

• (Array<Sawyer::Resource>) —

  An array of hashes representing vendors

See Also:

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

# File 'lib/pager_duty/client/vendors.rb', line 19

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