StripeAPI.Operations.GetReviews

Contains the different functions to run the operation getReviews

Documentation

getReviews

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Text

created

-> Maybe Text

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 Text

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 Text

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

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

getReviewsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetReviewsRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/reviews

The same as getReviews but returns the raw ByteString

getReviewsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetReviewsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetReviewsResponse))

GET /v1/reviews

Monadic version of getReviews (use with runWithConfiguration)

getReviewsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetReviewsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/reviews

Monadic version of getReviewsRaw (use with runWithConfiguration)

data GetReviewsRequestBody

Defines the data type for the schema getReviewsRequestBody

Constructors

GetReviewsRequestBody

Instances

Eq GetReviewsRequestBody

Defined in StripeAPI.Operations.GetReviews

Methods

(==) :: GetReviewsRequestBody -> GetReviewsRequestBody -> Bool

(/=) :: GetReviewsRequestBody -> GetReviewsRequestBody -> Bool

Show GetReviewsRequestBody

Defined in StripeAPI.Operations.GetReviews

Methods

showsPrec :: Int -> GetReviewsRequestBody -> ShowS

show :: GetReviewsRequestBody -> String

showList :: [GetReviewsRequestBody] -> ShowS

ToJSON GetReviewsRequestBody

Defined in StripeAPI.Operations.GetReviews

Methods

toJSON :: GetReviewsRequestBody -> Value

toEncoding :: GetReviewsRequestBody -> Encoding

toJSONList :: [GetReviewsRequestBody] -> Value

toEncodingList :: [GetReviewsRequestBody] -> Encoding

FromJSON GetReviewsRequestBody

Defined in StripeAPI.Operations.GetReviews

Methods

parseJSON :: Value -> Parser GetReviewsRequestBody

parseJSONList :: Value -> Parser [GetReviewsRequestBody]

data GetReviewsResponse

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.

Instances

Eq GetReviewsResponse

Defined in StripeAPI.Operations.GetReviews

Methods

(==) :: GetReviewsResponse -> GetReviewsResponse -> Bool

(/=) :: GetReviewsResponse -> GetReviewsResponse -> Bool

Show GetReviewsResponse

Defined in StripeAPI.Operations.GetReviews

Methods

showsPrec :: Int -> GetReviewsResponse -> ShowS

show :: GetReviewsResponse -> String

showList :: [GetReviewsResponse] -> ShowS

data GetReviewsResponseBody200

Defines the data type for the schema GetReviewsResponseBody200

Constructors

GetReviewsResponseBody200

Fields

• getReviewsResponseBody200Data :: [] Review

  data

• getReviewsResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getReviewsResponseBody200Object :: GetReviewsResponseBody200Object'

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

• getReviewsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/reviews'

Instances

Eq GetReviewsResponseBody200

Defined in StripeAPI.Operations.GetReviews

Methods

(==) :: GetReviewsResponseBody200 -> GetReviewsResponseBody200 -> Bool

(/=) :: GetReviewsResponseBody200 -> GetReviewsResponseBody200 -> Bool

Show GetReviewsResponseBody200

Defined in StripeAPI.Operations.GetReviews

Methods

showsPrec :: Int -> GetReviewsResponseBody200 -> ShowS

show :: GetReviewsResponseBody200 -> String

showList :: [GetReviewsResponseBody200] -> ShowS

ToJSON GetReviewsResponseBody200

Defined in StripeAPI.Operations.GetReviews

Methods

toJSON :: GetReviewsResponseBody200 -> Value

toEncoding :: GetReviewsResponseBody200 -> Encoding

toJSONList :: [GetReviewsResponseBody200] -> Value

toEncodingList :: [GetReviewsResponseBody200] -> Encoding

FromJSON GetReviewsResponseBody200

Defined in StripeAPI.Operations.GetReviews

Methods

parseJSON :: Value -> Parser GetReviewsResponseBody200

parseJSONList :: Value -> Parser [GetReviewsResponseBody200]

data GetReviewsResponseBody200Object'

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

Constructors

GetReviewsResponseBody200Object'EnumOther Value

GetReviewsResponseBody200Object'EnumTyped Text

GetReviewsResponseBody200Object'EnumStringList

Instances

Eq GetReviewsResponseBody200Object'

Defined in StripeAPI.Operations.GetReviews

Methods

(==) :: GetReviewsResponseBody200Object' -> GetReviewsResponseBody200Object' -> Bool

(/=) :: GetReviewsResponseBody200Object' -> GetReviewsResponseBody200Object' -> Bool

Show GetReviewsResponseBody200Object'

Defined in StripeAPI.Operations.GetReviews

Methods

showsPrec :: Int -> GetReviewsResponseBody200Object' -> ShowS

show :: GetReviewsResponseBody200Object' -> String

showList :: [GetReviewsResponseBody200Object'] -> ShowS

ToJSON GetReviewsResponseBody200Object'

Defined in StripeAPI.Operations.GetReviews

Methods

toJSON :: GetReviewsResponseBody200Object' -> Value

toEncoding :: GetReviewsResponseBody200Object' -> Encoding

toJSONList :: [GetReviewsResponseBody200Object'] -> Value

toEncodingList :: [GetReviewsResponseBody200Object'] -> Encoding

FromJSON GetReviewsResponseBody200Object'

Defined in StripeAPI.Operations.GetReviews

Methods

parseJSON :: Value -> Parser GetReviewsResponseBody200Object'

parseJSONList :: Value -> Parser [GetReviewsResponseBody200Object']