Module: Singleplatform::Client::Locations

Included in:
Singleplatform::Client
Defined in:
lib/singleplatform/client/locations.rb

Instance Method Summary collapse

Instance Method Details

#all_for(id) ⇒ Singleplatform::Response

Fetch location, menus and photo data for a specific location

Parameters:

  • id (String)

Returns:

Raises:



18
19
20
21
22
 
# File 'lib/singleplatform/client/locations.rb', line 18

def all_for(id)
  raise Error::InvalidLocationError unless valid_params?(id)
  url = generate_url("/locations/#{id}/all")
  Request.get(url)
end

#location(id) ⇒ Singleplatform::Response

Fetch information about a specific location

Parameters:

  • id (String)

Returns:

Raises:



8
9
10
11
12
 
# File 'lib/singleplatform/client/locations.rb', line 8

def location(id)
  raise Error::InvalidLocationError unless valid_params?(id)
  url = generate_url("/locations/#{id}/")
  Request.get(url)
end

#locations_updated_since(date, options = {}) ⇒ Singleplatform::Response

Fetch all locations updated since a given date

Parameters:

  • date (String)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :limit (Fixnum) —

    Maximum (default) 5000 per page

Returns:

Raises:



30
31
32
33
34
35
36
37
 
# File 'lib/singleplatform/client/locations.rb', line 30

def locations_updated_since(date, options = {})
  raise Error::InvalidDateError unless valid_date?(date)
  url = generate_url(
    '/locations/updated_since/',
    { date: date }.merge(options)
  )
  Request.get(url)
end