Class: WhopSDK::Resources::Reviews

Inherits:
Object
  • Object
show all
Defined in:
lib/whop_sdk/resources/reviews.rb

Overview

Reviews

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Reviews

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Reviews.

Parameters:



71
72
73
 
# File 'lib/whop_sdk/resources/reviews.rb', line 71

def initialize(client:)
  @client = client
end

Instance Method Details

#list(product_id:, after: nil, before: nil, created_after: nil, created_before: nil, first: nil, last: nil, max_stars: nil, min_stars: nil, request_options: {}) ⇒ WhopSDK::Internal::CursorPage<WhopSDK::Models::ReviewListResponse>

Returns a paginated list of customer reviews for a specific product, with optional filtering by star rating and creation date.

Parameters:

  • product_id (String) —

    The unique identifier of the product to list reviews for.

  • after (String, nil) —

    Returns the elements in the list that come after the specified cursor.

  • before (String, nil) —

    Returns the elements in the list that come before the specified cursor.

  • created_after (Time, nil) —

    Only return reviews created after this timestamp.

  • created_before (Time, nil) —

    Only return reviews created before this timestamp.

  • first (Integer, nil) —

    Returns the first n elements from the list.

  • last (Integer, nil) —

    Returns the last n elements from the list.

  • max_stars (Integer, nil) —

    The maximum star rating to include in results, from 1 to 5 inclusive.

  • min_stars (Integer, nil) —

    The minimum star rating to include in results, from 1 to 5 inclusive.

  • request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/whop_sdk/resources/reviews.rb', line 55

def list(params)
  parsed, options = WhopSDK::ReviewListParams.dump_request(params)
  query = WhopSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "reviews",
    query: query,
    page: WhopSDK::Internal::CursorPage,
    model: WhopSDK::Models::ReviewListResponse,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ WhopSDK::Models::ReviewRetrieveResponse

Retrieves the details of an existing review.

Parameters:

  • id (String) —

    The unique identifier of the review to retrieve.

  • request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



18
19
20
21
22
23
24
25
 
# File 'lib/whop_sdk/resources/reviews.rb', line 18

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["reviews/%1$s", id],
    model: WhopSDK::Models::ReviewRetrieveResponse,
    options: params[:request_options]
  )
end