Module: Karatekit::Client::Events

Included in:

Karatekit::Client

Defined in:

lib/karatekit/client/events.rb

Overview

Methods for the Events API

See Also:

• https://...

Instance Method Summary

• #event(id, options = {}) ⇒ Sawyer::Resource

  Get a single event.

• #events(options = {}) ⇒ Array<Sawyer::Resource>

  List events.

Instance Method Details

#event(id, options = {}) ⇒ Sawyer::Resource

Get a single event

Parameters:

• id (Integer) —

  ID of the event

Returns:

• (Sawyer::Resource) —

  A single event

See Also:

• https://...

# File 'lib/karatekit/client/events.rb', line 22

def event(id, options = {})
  get "events/#{id}", options
end

#events(options = {}) ⇒ Array<Sawyer::Resource>

List events

Returns:

• (Array<Sawyer::Resource>) —

  An array of hashes representing events

See Also:

• https://...

# File 'lib/karatekit/client/events.rb', line 13

def events(options = {})
  paginate "events", options
end