stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetReviews

Description

Contains the different functions to run the operation getReviews

Synopsis

Documentation

getReviews Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> Maybe String

created

-> Maybe String

ending_before: 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. | Constraints: Maximum length of 5000

-> Maybe String

expand: Specifies which fields in the response should be expanded.

-> Maybe Integer

limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

-> Maybe String

starting_after: 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. | Constraints: Maximum length of 5000

-> GetReviewsRequestBody

The request body to send

-> m (Either HttpException (Response GetReviewsResponse))

Monad containing the result of the operation

GET /v1/reviews

<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>

data GetReviewsResponse Source #

Represents a response of the operation getReviews.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), GetReviewsResponseError is used.

Constructors

GetReviewsResponseError String

Means either no matching case available or a parse error

GetReviewsResponse200 GetReviewsResponseBody200

Successful response.

GetReviewsResponseDefault Error

Error response.

data GetReviewsResponseBody200 Source #

Defines the data type for the schema GetReviewsResponseBody200

Constructors

GetReviewsResponseBody200 

Fields

data GetReviewsResponseBody200Object' Source #

Defines the enum schema GetReviewsResponseBody200Object'

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.