module PagerDuty::Client::Vendors

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 v2.developer.pagerduty.com/v2/page/api-reference#!/Vendors

Public Instance Methods

get_vendor(id, options = {})
Alias for: vendor
list_vendors(options = {})
Alias for: vendors
vendor(id, options = {}) click to toggle source

Get details about one specific vendor.

@param id [String] A vendor id (required) @param options [Sawyer::Resource] A customizable set of options. @return [Sawyer::Resource] A hash representing vendor @see 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
Also aliased as: get_vendor
vendors(options = {}) click to toggle source

List all vendors. @param options [Sawyer::Resource] A customizable set of options. @return [Array<Sawyer::Resource>] An array of hashes representing vendors @see 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
Also aliased as: list_vendors