StripeAPI.Operations.GetReviews

Contains the different functions to run the operation getReviews

Documentation

getReviews

Arguments

:: forall m. MonadHTTP m

=> GetReviewsParameters

Contains all available parameters of this operation (query and path parameters)

-> ClientT m (Response GetReviewsResponse)

Monadic computation which returns 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 GetReviewsParameters

Defines the object schema located at paths./v1/reviews.GET.parameters in the specification.

Constructors

GetReviewsParameters

Fields

• getReviewsParametersQueryCreated :: Maybe GetReviewsParametersQueryCreated'Variants

  queryCreated: Represents the parameter named 'created'

• getReviewsParametersQueryEndingBefore :: Maybe Text

  queryEnding_before: Represents the parameter named '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
• getReviewsParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

• getReviewsParametersQueryLimit :: Maybe Int

  queryLimit: Represents the parameter named 'limit'

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

• getReviewsParametersQueryStartingAfter :: Maybe Text

  queryStarting_after: Represents the parameter named '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

Instances

Eq GetReviewsParameters

Defined in StripeAPI.Operations.GetReviews

Methods

(==) :: GetReviewsParameters -> GetReviewsParameters -> Bool

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

Show GetReviewsParameters

Defined in StripeAPI.Operations.GetReviews

Methods

showsPrec :: Int -> GetReviewsParameters -> ShowS

show :: GetReviewsParameters -> String

showList :: [GetReviewsParameters] -> ShowS

ToJSON GetReviewsParameters

Defined in StripeAPI.Operations.GetReviews

Methods

toJSON :: GetReviewsParameters -> Value

toEncoding :: GetReviewsParameters -> Encoding

toJSONList :: [GetReviewsParameters] -> Value

toEncodingList :: [GetReviewsParameters] -> Encoding

FromJSON GetReviewsParameters

Defined in StripeAPI.Operations.GetReviews

Methods

parseJSON :: Value -> Parser GetReviewsParameters

parseJSONList :: Value -> Parser [GetReviewsParameters]

mkGetReviewsParameters :: GetReviewsParameters

Create a new GetReviewsParameters with all required fields.

data GetReviewsParametersQueryCreated'OneOf1

Defines the object schema located at paths./v1/reviews.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

GetReviewsParametersQueryCreated'OneOf1

Fields

• getReviewsParametersQueryCreated'OneOf1Gt :: Maybe Int

  gt

• getReviewsParametersQueryCreated'OneOf1Gte :: Maybe Int

  gte

• getReviewsParametersQueryCreated'OneOf1Lt :: Maybe Int

  lt

• getReviewsParametersQueryCreated'OneOf1Lte :: Maybe Int

  lte

Instances

Eq GetReviewsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetReviews

Methods

(==) :: GetReviewsParametersQueryCreated'OneOf1 -> GetReviewsParametersQueryCreated'OneOf1 -> Bool

(/=) :: GetReviewsParametersQueryCreated'OneOf1 -> GetReviewsParametersQueryCreated'OneOf1 -> Bool

Show GetReviewsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetReviews

Methods

showsPrec :: Int -> GetReviewsParametersQueryCreated'OneOf1 -> ShowS

show :: GetReviewsParametersQueryCreated'OneOf1 -> String

showList :: [GetReviewsParametersQueryCreated'OneOf1] -> ShowS

ToJSON GetReviewsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetReviews

Methods

toJSON :: GetReviewsParametersQueryCreated'OneOf1 -> Value

toEncoding :: GetReviewsParametersQueryCreated'OneOf1 -> Encoding

toJSONList :: [GetReviewsParametersQueryCreated'OneOf1] -> Value

toEncodingList :: [GetReviewsParametersQueryCreated'OneOf1] -> Encoding

FromJSON GetReviewsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetReviews

Methods

parseJSON :: Value -> Parser GetReviewsParametersQueryCreated'OneOf1

parseJSONList :: Value -> Parser [GetReviewsParametersQueryCreated'OneOf1]

mkGetReviewsParametersQueryCreated'OneOf1 :: GetReviewsParametersQueryCreated'OneOf1

Create a new GetReviewsParametersQueryCreated'OneOf1 with all required fields.

data GetReviewsParametersQueryCreated'Variants

Defines the oneOf schema located at paths./v1/reviews.GET.parameters.properties.queryCreated.anyOf in the specification.

Represents the parameter named 'created'

Constructors

GetReviewsParametersQueryCreated'GetReviewsParametersQueryCreated'OneOf1 GetReviewsParametersQueryCreated'OneOf1

GetReviewsParametersQueryCreated'Int Int

Instances

Eq GetReviewsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetReviews

Methods

(==) :: GetReviewsParametersQueryCreated'Variants -> GetReviewsParametersQueryCreated'Variants -> Bool

(/=) :: GetReviewsParametersQueryCreated'Variants -> GetReviewsParametersQueryCreated'Variants -> Bool

Show GetReviewsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetReviews

Methods

showsPrec :: Int -> GetReviewsParametersQueryCreated'Variants -> ShowS

show :: GetReviewsParametersQueryCreated'Variants -> String

showList :: [GetReviewsParametersQueryCreated'Variants] -> ShowS

ToJSON GetReviewsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetReviews

Methods

toJSON :: GetReviewsParametersQueryCreated'Variants -> Value

toEncoding :: GetReviewsParametersQueryCreated'Variants -> Encoding

toJSONList :: [GetReviewsParametersQueryCreated'Variants] -> Value

toEncodingList :: [GetReviewsParametersQueryCreated'Variants] -> Encoding

FromJSON GetReviewsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetReviews

Methods

parseJSON :: Value -> Parser GetReviewsParametersQueryCreated'Variants

parseJSONList :: Value -> Parser [GetReviewsParametersQueryCreated'Variants]

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 object schema located at paths./v1/reviews.GET.responses.200.content.application/json.schema in the specification.

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.

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

mkGetReviewsResponseBody200

Arguments

:: [Review]

getReviewsResponseBody200Data

-> Bool

getReviewsResponseBody200HasMore

-> Text

getReviewsResponseBody200Url

-> GetReviewsResponseBody200

Create a new GetReviewsResponseBody200 with all required fields.