Safe Haskell	None
Language	Haskell2010

StripeAPI.Types.Review

Description

Contains the types generated from the schema Review

Synopsis

data Review = Review {
- reviewBillingZip :: Maybe Text
- reviewCharge :: Maybe ReviewCharge'Variants
- reviewClosedReason :: Maybe ReviewClosedReason'
- reviewCreated :: Int
- reviewId :: Text
- reviewIpAddress :: Maybe Text
- reviewIpAddressLocation :: Maybe ReviewIpAddressLocation'
- reviewLivemode :: Bool
- reviewOpen :: Bool
- reviewOpenedReason :: ReviewOpenedReason'
- reviewPaymentIntent :: Maybe ReviewPaymentIntent'Variants
- reviewReason :: Text
- reviewSession :: Maybe ReviewSession'
}
mkReview :: Int -> Text -> Bool -> Bool -> ReviewOpenedReason' -> Text -> Review
data ReviewCharge'Variants
- = ReviewCharge'Text Text
- | ReviewCharge'Charge Charge
data ReviewClosedReason'
data ReviewIpAddressLocation' = ReviewIpAddressLocation' {
}
mkReviewIpAddressLocation' :: ReviewIpAddressLocation'
data ReviewOpenedReason'
data ReviewPaymentIntent'Variants
- = ReviewPaymentIntent'Text Text
- | ReviewPaymentIntent'PaymentIntent PaymentIntent
data ReviewSession' = ReviewSession' {
- reviewSession'Browser :: Maybe Text
- reviewSession'Device :: Maybe Text
- reviewSession'Platform :: Maybe Text
- reviewSession'Version :: Maybe Text
}
mkReviewSession' :: ReviewSession'

Documentation

data Review Source #

Defines the object schema located at components.schemas.review in the specification.

Reviews can be used to supplement automated fraud detection with human expertise.

Learn more about Radar and reviewing payments here.

Constructors

Review

Fields

reviewBillingZip :: Maybe Text
billing_zip: The ZIP or postal code of the card used, if applicable.
Constraints:
- Maximum length of 5000
reviewCharge :: Maybe ReviewCharge'Variants
charge: The charge associated with this review.
reviewClosedReason :: Maybe ReviewClosedReason'
closed_reason: The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, or `disputed`.
reviewCreated :: Int
created: Time at which the object was created. Measured in seconds since the Unix epoch.
reviewId :: Text
id: Unique identifier for the object.
Constraints:
- Maximum length of 5000
reviewIpAddress :: Maybe Text
ip_address: The IP address where the payment originated.
Constraints:
- Maximum length of 5000
reviewIpAddressLocation :: Maybe ReviewIpAddressLocation'
ip_address_location: Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.
reviewLivemode :: Bool
livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
reviewOpen :: Bool
open: If `true`, the review needs action.
reviewOpenedReason :: ReviewOpenedReason'
opened_reason: The reason the review was opened. One of `rule` or `manual`.
reviewPaymentIntent :: Maybe ReviewPaymentIntent'Variants
payment_intent: The PaymentIntent ID associated with this review, if one exists.
reviewReason :: Text
reason: The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, or `disputed`.
Constraints:
- Maximum length of 5000
reviewSession :: Maybe ReviewSession'
session: Information related to the browsing session of the user who initiated the payment.

Instances

Instances details

Eq Review Source #
Instance details Defined in StripeAPI.Types.Review Methods (==) :: Review -> Review -> Bool # (/=) :: Review -> Review -> Bool #
Show Review Source #
Instance details Defined in StripeAPI.Types.Review Methods showsPrec :: Int -> Review -> ShowS # show :: Review -> String # showList :: [Review] -> ShowS #
ToJSON Review Source #
Instance details Defined in StripeAPI.Types.Review Methods toJSON :: Review -> Value # toEncoding :: Review -> Encoding # toJSONList :: [Review] -> Value # toEncodingList :: [Review] -> Encoding #
FromJSON Review Source #
Instance details Defined in StripeAPI.Types.Review Methods parseJSON :: Value -> Parser Review # parseJSONList :: Value -> Parser [Review] #

mkReview Source #

Arguments

:: Int	`reviewCreated`
-> Text	`reviewId`
-> Bool	`reviewLivemode`
-> Bool	`reviewOpen`
-> ReviewOpenedReason'	`reviewOpenedReason`
-> Text	`reviewReason`
-> Review

Create a new Review with all required fields.

data ReviewCharge'Variants Source #

Defines the oneOf schema located at components.schemas.review.properties.charge.anyOf in the specification.

The charge associated with this review.

Constructors

ReviewCharge'Text Text
ReviewCharge'Charge Charge

Instances

Instances details

Eq ReviewCharge'Variants Source #
Instance details Defined in StripeAPI.Types.Review Methods (==) :: ReviewCharge'Variants -> ReviewCharge'Variants -> Bool # (/=) :: ReviewCharge'Variants -> ReviewCharge'Variants -> Bool #
Show ReviewCharge'Variants Source #
Instance details Defined in StripeAPI.Types.Review Methods showsPrec :: Int -> ReviewCharge'Variants -> ShowS # show :: ReviewCharge'Variants -> String # showList :: [ReviewCharge'Variants] -> ShowS #
ToJSON ReviewCharge'Variants Source #
Instance details Defined in StripeAPI.Types.Review Methods toJSON :: ReviewCharge'Variants -> Value # toEncoding :: ReviewCharge'Variants -> Encoding # toJSONList :: [ReviewCharge'Variants] -> Value # toEncodingList :: [ReviewCharge'Variants] -> Encoding #
FromJSON ReviewCharge'Variants Source #
Instance details Defined in StripeAPI.Types.Review Methods parseJSON :: Value -> Parser ReviewCharge'Variants # parseJSONList :: Value -> Parser [ReviewCharge'Variants] #

data ReviewClosedReason' Source #

Defines the enum schema located at components.schemas.review.properties.closed_reason in the specification.

The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, or `disputed`.

Constructors

ReviewClosedReason'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
ReviewClosedReason'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
ReviewClosedReason'EnumApproved	Represents the JSON value `"approved"`
ReviewClosedReason'EnumDisputed	Represents the JSON value `"disputed"`
ReviewClosedReason'EnumRefunded	Represents the JSON value `"refunded"`
ReviewClosedReason'EnumRefundedAsFraud	Represents the JSON value `"refunded_as_fraud"`

Instances

Instances details

Eq ReviewClosedReason' Source #
Instance details Defined in StripeAPI.Types.Review Methods (==) :: ReviewClosedReason' -> ReviewClosedReason' -> Bool # (/=) :: ReviewClosedReason' -> ReviewClosedReason' -> Bool #
Show ReviewClosedReason' Source #
Instance details Defined in StripeAPI.Types.Review Methods showsPrec :: Int -> ReviewClosedReason' -> ShowS # show :: ReviewClosedReason' -> String # showList :: [ReviewClosedReason'] -> ShowS #
ToJSON ReviewClosedReason' Source #
Instance details Defined in StripeAPI.Types.Review Methods toJSON :: ReviewClosedReason' -> Value # toEncoding :: ReviewClosedReason' -> Encoding # toJSONList :: [ReviewClosedReason'] -> Value # toEncodingList :: [ReviewClosedReason'] -> Encoding #
FromJSON ReviewClosedReason' Source #
Instance details Defined in StripeAPI.Types.Review Methods parseJSON :: Value -> Parser ReviewClosedReason' # parseJSONList :: Value -> Parser [ReviewClosedReason'] #

data ReviewIpAddressLocation' Source #

Defines the object schema located at components.schemas.review.properties.ip_address_location.anyOf in the specification.

Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.

Constructors

ReviewIpAddressLocation'

Fields

reviewIpAddressLocation'City :: Maybe Text
city: The city where the payment originated.
Constraints:
- Maximum length of 5000
reviewIpAddressLocation'Country :: Maybe Text
country: Two-letter ISO code representing the country where the payment originated.
Constraints:
- Maximum length of 5000
reviewIpAddressLocation'Latitude :: Maybe Double
latitude: The geographic latitude where the payment originated.
reviewIpAddressLocation'Longitude :: Maybe Double
longitude: The geographic longitude where the payment originated.
reviewIpAddressLocation'Region :: Maybe Text
region: The state/county/province/region where the payment originated.
Constraints:
- Maximum length of 5000

Instances

Instances details

Eq ReviewIpAddressLocation' Source #
Instance details Defined in StripeAPI.Types.Review Methods (==) :: ReviewIpAddressLocation' -> ReviewIpAddressLocation' -> Bool # (/=) :: ReviewIpAddressLocation' -> ReviewIpAddressLocation' -> Bool #
Show ReviewIpAddressLocation' Source #
Instance details Defined in StripeAPI.Types.Review Methods showsPrec :: Int -> ReviewIpAddressLocation' -> ShowS # show :: ReviewIpAddressLocation' -> String # showList :: [ReviewIpAddressLocation'] -> ShowS #
ToJSON ReviewIpAddressLocation' Source #
Instance details Defined in StripeAPI.Types.Review Methods toJSON :: ReviewIpAddressLocation' -> Value # toEncoding :: ReviewIpAddressLocation' -> Encoding # toJSONList :: [ReviewIpAddressLocation'] -> Value # toEncodingList :: [ReviewIpAddressLocation'] -> Encoding #
FromJSON ReviewIpAddressLocation' Source #
Instance details Defined in StripeAPI.Types.Review Methods parseJSON :: Value -> Parser ReviewIpAddressLocation' # parseJSONList :: Value -> Parser [ReviewIpAddressLocation'] #

mkReviewIpAddressLocation' :: ReviewIpAddressLocation' Source #

Create a new ReviewIpAddressLocation' with all required fields.

data ReviewOpenedReason' Source #

Defines the enum schema located at components.schemas.review.properties.opened_reason in the specification.

The reason the review was opened. One of `rule` or `manual`.

Constructors

ReviewOpenedReason'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
ReviewOpenedReason'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
ReviewOpenedReason'EnumManual	Represents the JSON value `"manual"`
ReviewOpenedReason'EnumRule	Represents the JSON value `"rule"`

Instances

Instances details

Eq ReviewOpenedReason' Source #
Instance details Defined in StripeAPI.Types.Review Methods (==) :: ReviewOpenedReason' -> ReviewOpenedReason' -> Bool # (/=) :: ReviewOpenedReason' -> ReviewOpenedReason' -> Bool #
Show ReviewOpenedReason' Source #
Instance details Defined in StripeAPI.Types.Review Methods showsPrec :: Int -> ReviewOpenedReason' -> ShowS # show :: ReviewOpenedReason' -> String # showList :: [ReviewOpenedReason'] -> ShowS #
ToJSON ReviewOpenedReason' Source #
Instance details Defined in StripeAPI.Types.Review Methods toJSON :: ReviewOpenedReason' -> Value # toEncoding :: ReviewOpenedReason' -> Encoding # toJSONList :: [ReviewOpenedReason'] -> Value # toEncodingList :: [ReviewOpenedReason'] -> Encoding #
FromJSON ReviewOpenedReason' Source #
Instance details Defined in StripeAPI.Types.Review Methods parseJSON :: Value -> Parser ReviewOpenedReason' # parseJSONList :: Value -> Parser [ReviewOpenedReason'] #

data ReviewPaymentIntent'Variants Source #

Defines the oneOf schema located at components.schemas.review.properties.payment_intent.anyOf in the specification.

The PaymentIntent ID associated with this review, if one exists.

Constructors

ReviewPaymentIntent'Text Text
ReviewPaymentIntent'PaymentIntent PaymentIntent

Instances

Instances details

Eq ReviewPaymentIntent'Variants Source #
Instance details Defined in StripeAPI.Types.Review Methods (==) :: ReviewPaymentIntent'Variants -> ReviewPaymentIntent'Variants -> Bool # (/=) :: ReviewPaymentIntent'Variants -> ReviewPaymentIntent'Variants -> Bool #
Show ReviewPaymentIntent'Variants Source #
Instance details Defined in StripeAPI.Types.Review Methods showsPrec :: Int -> ReviewPaymentIntent'Variants -> ShowS # show :: ReviewPaymentIntent'Variants -> String # showList :: [ReviewPaymentIntent'Variants] -> ShowS #
ToJSON ReviewPaymentIntent'Variants Source #
Instance details Defined in StripeAPI.Types.Review Methods toJSON :: ReviewPaymentIntent'Variants -> Value # toEncoding :: ReviewPaymentIntent'Variants -> Encoding # toJSONList :: [ReviewPaymentIntent'Variants] -> Value # toEncodingList :: [ReviewPaymentIntent'Variants] -> Encoding #
FromJSON ReviewPaymentIntent'Variants Source #
Instance details Defined in StripeAPI.Types.Review Methods parseJSON :: Value -> Parser ReviewPaymentIntent'Variants # parseJSONList :: Value -> Parser [ReviewPaymentIntent'Variants] #

data ReviewSession' Source #

Defines the object schema located at components.schemas.review.properties.session.anyOf in the specification.

Information related to the browsing session of the user who initiated the payment.

Constructors

ReviewSession'

Fields

reviewSession'Browser :: Maybe Text
browser: The browser used in this browser session (e.g., `Chrome`).
Constraints:
- Maximum length of 5000
reviewSession'Device :: Maybe Text
device: Information about the device used for the browser session (e.g., `Samsung SM-G930T`).
Constraints:
- Maximum length of 5000
reviewSession'Platform :: Maybe Text
platform: The platform for the browser session (e.g., `Macintosh`).
Constraints:
- Maximum length of 5000
reviewSession'Version :: Maybe Text
version: The version for the browser session (e.g., `61.0.3163.100`).
Constraints:
- Maximum length of 5000

Instances

Instances details

Eq ReviewSession' Source #
Instance details Defined in StripeAPI.Types.Review Methods (==) :: ReviewSession' -> ReviewSession' -> Bool # (/=) :: ReviewSession' -> ReviewSession' -> Bool #
Show ReviewSession' Source #
Instance details Defined in StripeAPI.Types.Review Methods showsPrec :: Int -> ReviewSession' -> ShowS # show :: ReviewSession' -> String # showList :: [ReviewSession'] -> ShowS #
ToJSON ReviewSession' Source #
Instance details Defined in StripeAPI.Types.Review Methods toJSON :: ReviewSession' -> Value # toEncoding :: ReviewSession' -> Encoding # toJSONList :: [ReviewSession'] -> Value # toEncodingList :: [ReviewSession'] -> Encoding #
FromJSON ReviewSession' Source #
Instance details Defined in StripeAPI.Types.Review Methods parseJSON :: Value -> Parser ReviewSession' # parseJSONList :: Value -> Parser [ReviewSession'] #

mkReviewSession' :: ReviewSession' Source #

Create a new ReviewSession' with all required fields.