Sha256: 0565d1bab438a89c742c98334f7b52af9157ef7988cb3324fa5dad9222d5aa69

Contents?: true

Size: 917 Bytes

Versions: 4

Compression:

Stored size: 917 Bytes

Contents

module AngellistApi
  class Client
    # Defines methods related to URLs
    #
    # @see http://angel.co/api/spec/reviews
    module Reviews
      # 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.
      #
      # @requires_authentication Optional
      #
      # @param [Hash] options A customizable set of options.
      # @option options [Integer] :user_id user_id of the desired user. If none
      #   given, defaults to the authenticated user.
      #
      # @example Get reviews for the authenticated user.
      #   AngellistApi.get_reviews
      #
      # @example Get reviews for a given user ID.
      #   AngellistApi.get_reviews(:user_id => 1234)
      def get_reviews(options={})
        get("1/reviews", options)
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
angellist_api-1.0.5 lib/angellist_api/client/reviews.rb
angellist_api-1.0.4 lib/angellist_api/client/reviews.rb
angellist_api-1.0.3 lib/angellist_api/client/reviews.rb
angellist_api-1.0.2 lib/angellist_api/client/reviews.rb