module Skittles::Client::Tip
Define methods related to tips. @see developer.foursquare.com/docs/tips/tips.html
Public Instance Methods
Allows a user to add a new tip at a venue.
@param id [String] The venue where you want to add this tip. @param text [String] The text of the tip. @param options [Hash] A customizable set of options. @option options [String] url A URL related to this tip. @return [Hashie::Mash] The newly-added tip. @requires_acting_user Yes @see developer.foursquare.com/docs/tips/add.html
# File lib/skittles/client/tip.rb, line 15 def add_tip(id, text, options = {}) post("tips/add", { :venueId => id, :text => text }.merge(options)).tip end
Gives details about a tip, including which users (especially friends) have marked the tip to-do or done.
@param id [String] Id of tip to retrieve. @return [Hashie::Mash] A complete tip. @requires_acting_user No @see developer.foursquare.com/docs/tips/tips.html
# File lib/skittles/client/tip.rb, line 29 def tip(id) get("tips/#{id}").tip end
The lists that a tip appears on.
@param id [String] The tip to get lists for. @param options [Hash] A customizable set of options. @option options [String] group Either created, edited, followed, friends or suggested. @return The lists a tip appears on. @require_acting_user Yes @see developer.foursquare.com/docs/tips/listed.html
# File lib/skittles/client/tip.rb, line 41 def tip_listed(id, options = {}) get("tips/#{id}/listed", options).lists end
Allows the acting user to mark a tip done.
@deprecated @param id [String] The tip you want to mark done. @return [Hashie::Mash] The marked to-do. @requires_acting_user Yes @see developer.foursquare.com/docs/tips/markdone.html
# File lib/skittles/client/tip.rb, line 52 def tip_markdone(id) post("tips/#{id}/markdone").todo end
Allows you to mark a tip to-do.
@deprecated @param id [String] The tip you want to mark to-do. @return [Hashie::Mash] The newly-added to-do. @requires_acting_user Yes @see developer.foursquare.com/docs/tips/marktodo.html
# File lib/skittles/client/tip.rb, line 63 def tip_marktodo(id) post("tips/#{id}/marktodo").todo end
Returns a list of tips near the area specified.
@param ll [String] Latitude and longitude of the user's location. @param options [Hash] A customizable set of options. @option options [Integer] limit Number of results to return, up to 500. @option options [Integer] offset Used to page through results. @option options [String] filter If set to friends, only show nearby tips from friends. @option options [String] query Only find tips matching the given term, cannot be used in conjunction with friends filter. @return [Hashie::Mash] An array of tips, each of which contain a user and venue. @requires_acting_user No @see developer.foursquare.com/docs/tips/search.html
# File lib/skittles/client/tip.rb, line 78 def tip_search(ll, options = {}) get("tips/search", { :ll => ll }.merge(options)).tips end
Allows you to remove a tip from your to-do list or done list.
@deprecated @param id [String] The tip you want to unmark. @return [Hashie::Mash] The tip being acted on. @requires_acting_user No @see developer.foursquare.com/docs/tips/unmark.html
# File lib/skittles/client/tip.rb, line 89 def tip_unmark(id) post("tips/#{id}/unmark").tip end