Module: Singleplatform::Client::Photos

Included in:: Singleplatform::Client

Defined in:: lib/singleplatform/client/photos.rb

Instance Method Summary collapse

#photos_for(id, options = {}) ⇒ Hashie::Mash

Fetch photos for a given location.
#photos_updated_since(date, options = {}) ⇒ Hashie::Mash

Fetch photos added/updated since a given date.

Instance Method Details

#photos_for(id, options = {}) ⇒ `Hashie::Mash`

Fetch photos for a given location

Parameters:

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

Options Hash (options):

:height (Fixnum)
:width (Fixnum)
:type (String) — default: interior, exterior, item, logo, uncategorized

Returns:

(Hashie::Mash)

Raises:

(Error::InvalidLocationError)

# File 'lib/singleplatform/client/photos.rb', line 12

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

#photos_updated_since(date, options = {}) ⇒ `Hashie::Mash`

Fetch photos added/updated since a given date

Parameters:

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

Options Hash (options):

:limit (Fixnum) —

Maximum (default) 5000 per page

Returns:

(Hashie::Mash)

Raises:

(Error::InvalidDateError)

# File 'lib/singleplatform/client/photos.rb', line 24

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