Module: AngellistApi::Client::Reviews

Included in:
AngellistApi::Client
Defined in:
lib/angellist_api/client/reviews.rb

Overview

Defines methods related to URLs

Instance Method Summary collapse

Instance Method Details

#get_review(id) ⇒ Object

Shows details for a specific review

Examples:

Get information for a review.

AngellistApi.get_review(1098)

Parameters:

  • id (Integer)

    ID of the review to fetch.



35
36
37
# File 'lib/angellist_api/client/reviews.rb', line 35

def get_review(id)
  get("1/reviews/#{id}")
end

#get_reviews(options = {}) ⇒ Object

Return reviews for the given user. If no user given, the authenticated user is used. Reviews are paginated and ordered by most recent first. Also returns the total count of positive reviews.

Examples:

Get reviews for the authenticated user.

AngellistApi.get_reviews

Get reviews for a given user ID.

AngellistApi.get_reviews(:user_id => 1234)

Parameters:

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

    A customizable set of options.

Options Hash (options):

  • :user_id (Integer)

    user_id of the desired user. If none given, defaults to the authenticated user.



23
24
25
# File 'lib/angellist_api/client/reviews.rb', line 23

def get_reviews(options={})
  get("1/reviews", options)
end