Module: Controls::Client::Events

Included in:

Controls::Client

Defined in:

lib/controls/client/events.rb

Overview

A module to encapsulate API methods related to events

Since:

• API v1.0

Version:

• v1.6.0

Event Methods

• #events(params = {}) ⇒ Hash

  Either returns a list of all events or all events by type.

Instance Method Details

#events(params = {}) ⇒ Hash

Either returns a list of all events or all events by type

Parameters:

• params (Hash) (defaults to: {}) —

  the query parameters to send with the request

Options Hash (params):

• :filter (String) — default: :all —

  the event type to filter by

Returns:

• (Hash) —

  a hash representing the matching event

Raises:

• (Controls::NotFound) —

  if the uuid didn’t match any events

Since:

• API v1.0

# File 'lib/controls/client/events.rb', line 16

def events(params = {})
  get '/events', params
end