class Stripe::ReviewsApi
- Stripe::ReviewsApi
- Reference
- Object
Defined in:
stripe/api/reviews_api.crConstant Summary
-
GET_REVIEWS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000
-
GET_REVIEWS_MAX_LENGTH_FOR_STARTING_AFTER =
5000
-
GET_REVIEWS_REVIEW_MAX_LENGTH_FOR_REVIEW =
5000
-
POST_REVIEWS_REVIEW_APPROVE_MAX_LENGTH_FOR_REVIEW =
5000
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_get_reviews(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_reviews_review(*, review : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_reviews_review_approve(*, review : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#get_reviews(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::RadarReviewList
Returns a list of
Review
objects that haveopen
set totrue
. -
#get_reviews(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns a list of <code>Review</code> objects that have <code>open</code> set to <code>true</code>.
-
#get_reviews_review(*, review : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::Review
Retrieves a
@required @param review [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.Review
object. -
#get_reviews_review(*, review : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves a <code>Review</code> object.</p> @required @param review [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_reviews_review_with_http_info(*, review : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::Review, Int32, Hash(String, Array(String) | String))
<p>Retrieves a <code>Review</code> object.</p> @required @param review [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_reviews_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::RadarReviewList, Int32, Hash(String, Array(String) | String))
<p>Returns a list of <code>Review</code> objects that have <code>open</code> set to <code>true</code>.
-
#post_reviews_review_approve(*, review : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::Review
Approves a
@required @param review [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.Review
object, closing it and removing it from the list of reviews. -
#post_reviews_review_approve(*, review : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Approves a <code>Review</code> object, closing it and removing it from the list of reviews.</p> @required @param review [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_reviews_review_approve_with_http_info(*, review : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::Review, Int32, Hash(String, Array(String) | String))
<p>Approves a <code>Review</code> object, closing it and removing it from the list of reviews.</p> @required @param review [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
Returns a list of Review
objects that have open
set to true
. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
<p>Returns a list of <code>Review</code> objects that have <code>open</code> set to <code>true</code>. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param created [Stripe::GetAccountsCreatedParameter?] Only return reviews that were created during the given date interval.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves a Review
object.
<p>Retrieves a <code>Review</code> object.</p> @required @param review [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves a <code>Review</code> object.</p> @required @param review [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::Review, Integer, Hash)] Stripe::Review, response status code and response headers
<p>Returns a list of <code>Review</code> objects that have <code>open</code> set to <code>true</code>. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param created [Stripe::GetAccountsCreatedParameter?] Only return reviews that were created during the given date interval.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::RadarReviewList, Integer, Hash)] Stripe::RadarReviewList, response status code and response headers
Approves a Review
object, closing it and removing it from the list of reviews.
<p>Approves a <code>Review</code> object, closing it and removing it from the list of reviews.</p> @required @param review [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil
<p>Approves a <code>Review</code> object, closing it and removing it from the list of reviews.</p> @required @param review [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::Review, Integer, Hash)] Stripe::Review, response status code and response headers