Module: Camper::Client::Events

Included in:
Camper::Client
Defined in:
lib/camper/client/events.rb

Instance Method Summary (collapse)

Instance Method Details

- (Array, false) events(options = { since: '', page: 1 })

Get all the events

Parameters:

  • options (Hash) (defaults to: { since: '', page: 1 }) —

    GET parameters for the request

Options Hash (options):

  • :since (String) —

    Timestamp for beginning of period

  • :page (Fixnum, String) —

    page for results

Returns:

  • (Array, false) —

    if successful, returns an Array of Camper::Event objects. Otherwise, returns false.



13
14
15
 
# File 'lib/camper/client/events.rb', line 13

def events(options = { since: '', page: 1 })
  handle Camper::Event, get(["events", options])
end