module Nearmiss::Client::Bookmarks

Methods for the Bookmarks API

Public Instance Methods

bookmark(bookmark, options={}) click to toggle source

Get a single bookmark

@param bookmark [String] ID of bookmark to fetch @return [Sawyer::Resource] Bookmark information

# File lib/nearmiss-ruby/client/bookmarks.rb, line 21
def bookmark(bookmark, options={})
  get "bookmarks/#{bookmark}", options
end
bookmarks(options = {}) click to toggle source

List bookmarks

@return [Array<Sawyer::Resource>] List of bookmarks

# File lib/nearmiss-ruby/client/bookmarks.rb, line 11
def bookmarks(options = {})
  paginate "bookmarks", options
end
Also aliased as: list_bookmarks
delete_bookmark(bookmark_id, options={}) click to toggle source

Delete a bookmark

@param bookmark_id [String] Id of the bookmark. @return [Boolean] True if bookmark deleted, false otherwise. @example

@client.delete_bookmark('208sdaz3')
# File lib/nearmiss-ruby/client/bookmarks.rb, line 32
def delete_bookmark(bookmark_id, options={})
  boolean_from_response(:delete, "bookmarks/#{bookmark_id}", options)

end
list_bookmarks(options = {})
Alias for: bookmarks