{-# LANGUAGE MultiWayIf #-}
-- CHANGE WITH CAUTION: This is a generated code file generated by https://github.com/Haskell-OpenAPI-Code-Generator/Haskell-OpenAPI-Client-Code-Generator.
{-# LANGUAGE OverloadedStrings #-}

-- | Contains the types generated from the schema ChargeOutcome
module StripeAPI.Types.ChargeOutcome where

import qualified Control.Monad.Fail
import qualified Data.Aeson
import qualified Data.Aeson as Data.Aeson.Encoding.Internal
import qualified Data.Aeson as Data.Aeson.Types
import qualified Data.Aeson as Data.Aeson.Types.FromJSON
import qualified Data.Aeson as Data.Aeson.Types.Internal
import qualified Data.Aeson as Data.Aeson.Types.ToJSON
import qualified Data.ByteString.Char8
import qualified Data.ByteString.Char8 as Data.ByteString.Internal
import qualified Data.Functor
import qualified Data.Scientific
import qualified Data.Text
import qualified Data.Text.Internal
import qualified Data.Time.Calendar as Data.Time.Calendar.Days
import qualified Data.Time.LocalTime as Data.Time.LocalTime.Internal.ZonedTime
import qualified GHC.Base
import qualified GHC.Classes
import qualified GHC.Int
import qualified GHC.Show
import qualified GHC.Types
import qualified StripeAPI.Common
import StripeAPI.TypeAlias
import {-# SOURCE #-} StripeAPI.Types.Rule
import qualified Prelude as GHC.Integer.Type
import qualified Prelude as GHC.Maybe

-- | Defines the object schema located at @components.schemas.charge_outcome@ in the specification.
data ChargeOutcome = ChargeOutcome
  { -- | network_status: Possible values are \`approved_by_network\`, \`declined_by_network\`, \`not_sent_to_network\`, and \`reversed_after_approval\`. The value \`reversed_after_approval\` indicates the payment was [blocked by Stripe](https:\/\/stripe.com\/docs\/declines\#blocked-payments) after bank authorization, and may temporarily appear as \"pending\" on a cardholder\'s statement.
    --
    -- Constraints:
    --
    -- * Maximum length of 5000
    ChargeOutcome -> Maybe Text
chargeOutcomeNetworkStatus :: (GHC.Maybe.Maybe Data.Text.Internal.Text),
    -- | reason: An enumerated value providing a more detailed explanation of the outcome\'s \`type\`. Charges blocked by Radar\'s default block rule have the value \`highest_risk_level\`. Charges placed in review by Radar\'s default review rule have the value \`elevated_risk_level\`. Charges authorized, blocked, or placed in review by custom rules have the value \`rule\`. See [understanding declines](https:\/\/stripe.com\/docs\/declines) for more details.
    --
    -- Constraints:
    --
    -- * Maximum length of 5000
    ChargeOutcome -> Maybe Text
chargeOutcomeReason :: (GHC.Maybe.Maybe Data.Text.Internal.Text),
    -- | risk_level: Stripe Radar\'s evaluation of the riskiness of the payment. Possible values for evaluated payments are \`normal\`, \`elevated\`, \`highest\`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value \`not_assessed\`. In the event of an error in the evaluation, this field will have the value \`unknown\`. This field is only available with Radar.
    --
    -- Constraints:
    --
    -- * Maximum length of 5000
    ChargeOutcome -> Maybe Text
chargeOutcomeRiskLevel :: (GHC.Maybe.Maybe Data.Text.Internal.Text),
    -- | risk_score: Stripe Radar\'s evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams.
    ChargeOutcome -> Maybe Int
chargeOutcomeRiskScore :: (GHC.Maybe.Maybe GHC.Types.Int),
    -- | rule: The ID of the Radar rule that matched the payment, if applicable.
    ChargeOutcome -> Maybe ChargeOutcomeRule'Variants
chargeOutcomeRule :: (GHC.Maybe.Maybe ChargeOutcomeRule'Variants),
    -- | seller_message: A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.
    --
    -- Constraints:
    --
    -- * Maximum length of 5000
    ChargeOutcome -> Maybe Text
chargeOutcomeSellerMessage :: (GHC.Maybe.Maybe Data.Text.Internal.Text),
    -- | type: Possible values are \`authorized\`, \`manual_review\`, \`issuer_declined\`, \`blocked\`, and \`invalid\`. See [understanding declines](https:\/\/stripe.com\/docs\/declines) and [Radar reviews](https:\/\/stripe.com\/docs\/radar\/reviews) for details.
    --
    -- Constraints:
    --
    -- * Maximum length of 5000
    ChargeOutcome -> Text
chargeOutcomeType :: Data.Text.Internal.Text
  }
  deriving
    ( Int -> ChargeOutcome -> ShowS
[ChargeOutcome] -> ShowS
ChargeOutcome -> String
(Int -> ChargeOutcome -> ShowS)
-> (ChargeOutcome -> String)
-> ([ChargeOutcome] -> ShowS)
-> Show ChargeOutcome
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ChargeOutcome] -> ShowS
$cshowList :: [ChargeOutcome] -> ShowS
show :: ChargeOutcome -> String
$cshow :: ChargeOutcome -> String
showsPrec :: Int -> ChargeOutcome -> ShowS
$cshowsPrec :: Int -> ChargeOutcome -> ShowS
GHC.Show.Show,
      ChargeOutcome -> ChargeOutcome -> Bool
(ChargeOutcome -> ChargeOutcome -> Bool)
-> (ChargeOutcome -> ChargeOutcome -> Bool) -> Eq ChargeOutcome
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ChargeOutcome -> ChargeOutcome -> Bool
$c/= :: ChargeOutcome -> ChargeOutcome -> Bool
== :: ChargeOutcome -> ChargeOutcome -> Bool
$c== :: ChargeOutcome -> ChargeOutcome -> Bool
GHC.Classes.Eq
    )

instance Data.Aeson.Types.ToJSON.ToJSON ChargeOutcome where
  toJSON :: ChargeOutcome -> Value
toJSON ChargeOutcome
obj = [Pair] -> Value
Data.Aeson.Types.Internal.object (Text
"network_status" Text -> Maybe Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= ChargeOutcome -> Maybe Text
chargeOutcomeNetworkStatus ChargeOutcome
obj Pair -> [Pair] -> [Pair]
forall a. a -> [a] -> [a]
: Text
"reason" Text -> Maybe Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= ChargeOutcome -> Maybe Text
chargeOutcomeReason ChargeOutcome
obj Pair -> [Pair] -> [Pair]
forall a. a -> [a] -> [a]
: Text
"risk_level" Text -> Maybe Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= ChargeOutcome -> Maybe Text
chargeOutcomeRiskLevel ChargeOutcome
obj Pair -> [Pair] -> [Pair]
forall a. a -> [a] -> [a]
: Text
"risk_score" Text -> Maybe Int -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= ChargeOutcome -> Maybe Int
chargeOutcomeRiskScore ChargeOutcome
obj Pair -> [Pair] -> [Pair]
forall a. a -> [a] -> [a]
: Text
"rule" Text -> Maybe ChargeOutcomeRule'Variants -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= ChargeOutcome -> Maybe ChargeOutcomeRule'Variants
chargeOutcomeRule ChargeOutcome
obj Pair -> [Pair] -> [Pair]
forall a. a -> [a] -> [a]
: Text
"seller_message" Text -> Maybe Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= ChargeOutcome -> Maybe Text
chargeOutcomeSellerMessage ChargeOutcome
obj Pair -> [Pair] -> [Pair]
forall a. a -> [a] -> [a]
: Text
"type" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= ChargeOutcome -> Text
chargeOutcomeType ChargeOutcome
obj Pair -> [Pair] -> [Pair]
forall a. a -> [a] -> [a]
: [Pair]
forall a. Monoid a => a
GHC.Base.mempty)
  toEncoding :: ChargeOutcome -> Encoding
toEncoding ChargeOutcome
obj = Series -> Encoding
Data.Aeson.Encoding.Internal.pairs ((Text
"network_status" Text -> Maybe Text -> Series
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= ChargeOutcome -> Maybe Text
chargeOutcomeNetworkStatus ChargeOutcome
obj) Series -> Series -> Series
forall a. Semigroup a => a -> a -> a
GHC.Base.<> ((Text
"reason" Text -> Maybe Text -> Series
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= ChargeOutcome -> Maybe Text
chargeOutcomeReason ChargeOutcome
obj) Series -> Series -> Series
forall a. Semigroup a => a -> a -> a
GHC.Base.<> ((Text
"risk_level" Text -> Maybe Text -> Series
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= ChargeOutcome -> Maybe Text
chargeOutcomeRiskLevel ChargeOutcome
obj) Series -> Series -> Series
forall a. Semigroup a => a -> a -> a
GHC.Base.<> ((Text
"risk_score" Text -> Maybe Int -> Series
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= ChargeOutcome -> Maybe Int
chargeOutcomeRiskScore ChargeOutcome
obj) Series -> Series -> Series
forall a. Semigroup a => a -> a -> a
GHC.Base.<> ((Text
"rule" Text -> Maybe ChargeOutcomeRule'Variants -> Series
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= ChargeOutcome -> Maybe ChargeOutcomeRule'Variants
chargeOutcomeRule ChargeOutcome
obj) Series -> Series -> Series
forall a. Semigroup a => a -> a -> a
GHC.Base.<> ((Text
"seller_message" Text -> Maybe Text -> Series
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= ChargeOutcome -> Maybe Text
chargeOutcomeSellerMessage ChargeOutcome
obj) Series -> Series -> Series
forall a. Semigroup a => a -> a -> a
GHC.Base.<> (Text
"type" Text -> Text -> Series
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= ChargeOutcome -> Text
chargeOutcomeType ChargeOutcome
obj)))))))

instance Data.Aeson.Types.FromJSON.FromJSON ChargeOutcome where
  parseJSON :: Value -> Parser ChargeOutcome
parseJSON = String
-> (Object -> Parser ChargeOutcome)
-> Value
-> Parser ChargeOutcome
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.Aeson.Types.FromJSON.withObject String
"ChargeOutcome" (\Object
obj -> (((((((Maybe Text
 -> Maybe Text
 -> Maybe Text
 -> Maybe Int
 -> Maybe ChargeOutcomeRule'Variants
 -> Maybe Text
 -> Text
 -> ChargeOutcome)
-> Parser
     (Maybe Text
      -> Maybe Text
      -> Maybe Text
      -> Maybe Int
      -> Maybe ChargeOutcomeRule'Variants
      -> Maybe Text
      -> Text
      -> ChargeOutcome)
forall (f :: * -> *) a. Applicative f => a -> f a
GHC.Base.pure Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Int
-> Maybe ChargeOutcomeRule'Variants
-> Maybe Text
-> Text
-> ChargeOutcome
ChargeOutcome Parser
  (Maybe Text
   -> Maybe Text
   -> Maybe Text
   -> Maybe Int
   -> Maybe ChargeOutcomeRule'Variants
   -> Maybe Text
   -> Text
   -> ChargeOutcome)
-> Parser (Maybe Text)
-> Parser
     (Maybe Text
      -> Maybe Text
      -> Maybe Int
      -> Maybe ChargeOutcomeRule'Variants
      -> Maybe Text
      -> Text
      -> ChargeOutcome)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
GHC.Base.<*> (Object
obj Object -> Text -> Parser (Maybe Text)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Data.Aeson.Types.FromJSON..:? Text
"network_status")) Parser
  (Maybe Text
   -> Maybe Text
   -> Maybe Int
   -> Maybe ChargeOutcomeRule'Variants
   -> Maybe Text
   -> Text
   -> ChargeOutcome)
-> Parser (Maybe Text)
-> Parser
     (Maybe Text
      -> Maybe Int
      -> Maybe ChargeOutcomeRule'Variants
      -> Maybe Text
      -> Text
      -> ChargeOutcome)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
GHC.Base.<*> (Object
obj Object -> Text -> Parser (Maybe Text)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Data.Aeson.Types.FromJSON..:? Text
"reason")) Parser
  (Maybe Text
   -> Maybe Int
   -> Maybe ChargeOutcomeRule'Variants
   -> Maybe Text
   -> Text
   -> ChargeOutcome)
-> Parser (Maybe Text)
-> Parser
     (Maybe Int
      -> Maybe ChargeOutcomeRule'Variants
      -> Maybe Text
      -> Text
      -> ChargeOutcome)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
GHC.Base.<*> (Object
obj Object -> Text -> Parser (Maybe Text)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Data.Aeson.Types.FromJSON..:? Text
"risk_level")) Parser
  (Maybe Int
   -> Maybe ChargeOutcomeRule'Variants
   -> Maybe Text
   -> Text
   -> ChargeOutcome)
-> Parser (Maybe Int)
-> Parser
     (Maybe ChargeOutcomeRule'Variants
      -> Maybe Text -> Text -> ChargeOutcome)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
GHC.Base.<*> (Object
obj Object -> Text -> Parser (Maybe Int)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Data.Aeson.Types.FromJSON..:? Text
"risk_score")) Parser
  (Maybe ChargeOutcomeRule'Variants
   -> Maybe Text -> Text -> ChargeOutcome)
-> Parser (Maybe ChargeOutcomeRule'Variants)
-> Parser (Maybe Text -> Text -> ChargeOutcome)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
GHC.Base.<*> (Object
obj Object -> Text -> Parser (Maybe ChargeOutcomeRule'Variants)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Data.Aeson.Types.FromJSON..:? Text
"rule")) Parser (Maybe Text -> Text -> ChargeOutcome)
-> Parser (Maybe Text) -> Parser (Text -> ChargeOutcome)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
GHC.Base.<*> (Object
obj Object -> Text -> Parser (Maybe Text)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Data.Aeson.Types.FromJSON..:? Text
"seller_message")) Parser (Text -> ChargeOutcome)
-> Parser Text -> Parser ChargeOutcome
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
GHC.Base.<*> (Object
obj Object -> Text -> Parser Text
forall a. FromJSON a => Object -> Text -> Parser a
Data.Aeson.Types.FromJSON..: Text
"type"))

-- | Create a new 'ChargeOutcome' with all required fields.
mkChargeOutcome ::
  -- | 'chargeOutcomeType'
  Data.Text.Internal.Text ->
  ChargeOutcome
mkChargeOutcome :: Text -> ChargeOutcome
mkChargeOutcome Text
chargeOutcomeType =
  ChargeOutcome :: Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Int
-> Maybe ChargeOutcomeRule'Variants
-> Maybe Text
-> Text
-> ChargeOutcome
ChargeOutcome
    { chargeOutcomeNetworkStatus :: Maybe Text
chargeOutcomeNetworkStatus = Maybe Text
forall a. Maybe a
GHC.Maybe.Nothing,
      chargeOutcomeReason :: Maybe Text
chargeOutcomeReason = Maybe Text
forall a. Maybe a
GHC.Maybe.Nothing,
      chargeOutcomeRiskLevel :: Maybe Text
chargeOutcomeRiskLevel = Maybe Text
forall a. Maybe a
GHC.Maybe.Nothing,
      chargeOutcomeRiskScore :: Maybe Int
chargeOutcomeRiskScore = Maybe Int
forall a. Maybe a
GHC.Maybe.Nothing,
      chargeOutcomeRule :: Maybe ChargeOutcomeRule'Variants
chargeOutcomeRule = Maybe ChargeOutcomeRule'Variants
forall a. Maybe a
GHC.Maybe.Nothing,
      chargeOutcomeSellerMessage :: Maybe Text
chargeOutcomeSellerMessage = Maybe Text
forall a. Maybe a
GHC.Maybe.Nothing,
      chargeOutcomeType :: Text
chargeOutcomeType = Text
chargeOutcomeType
    }

-- | Defines the oneOf schema located at @components.schemas.charge_outcome.properties.rule.anyOf@ in the specification.
--
-- The ID of the Radar rule that matched the payment, if applicable.
data ChargeOutcomeRule'Variants
  = ChargeOutcomeRule'Text Data.Text.Internal.Text
  | ChargeOutcomeRule'Rule Rule
  deriving (Int -> ChargeOutcomeRule'Variants -> ShowS
[ChargeOutcomeRule'Variants] -> ShowS
ChargeOutcomeRule'Variants -> String
(Int -> ChargeOutcomeRule'Variants -> ShowS)
-> (ChargeOutcomeRule'Variants -> String)
-> ([ChargeOutcomeRule'Variants] -> ShowS)
-> Show ChargeOutcomeRule'Variants
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ChargeOutcomeRule'Variants] -> ShowS
$cshowList :: [ChargeOutcomeRule'Variants] -> ShowS
show :: ChargeOutcomeRule'Variants -> String
$cshow :: ChargeOutcomeRule'Variants -> String
showsPrec :: Int -> ChargeOutcomeRule'Variants -> ShowS
$cshowsPrec :: Int -> ChargeOutcomeRule'Variants -> ShowS
GHC.Show.Show, ChargeOutcomeRule'Variants -> ChargeOutcomeRule'Variants -> Bool
(ChargeOutcomeRule'Variants -> ChargeOutcomeRule'Variants -> Bool)
-> (ChargeOutcomeRule'Variants
    -> ChargeOutcomeRule'Variants -> Bool)
-> Eq ChargeOutcomeRule'Variants
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ChargeOutcomeRule'Variants -> ChargeOutcomeRule'Variants -> Bool
$c/= :: ChargeOutcomeRule'Variants -> ChargeOutcomeRule'Variants -> Bool
== :: ChargeOutcomeRule'Variants -> ChargeOutcomeRule'Variants -> Bool
$c== :: ChargeOutcomeRule'Variants -> ChargeOutcomeRule'Variants -> Bool
GHC.Classes.Eq)

instance Data.Aeson.Types.ToJSON.ToJSON ChargeOutcomeRule'Variants where
  toJSON :: ChargeOutcomeRule'Variants -> Value
toJSON (ChargeOutcomeRule'Text Text
a) = Text -> Value
forall a. ToJSON a => a -> Value
Data.Aeson.Types.ToJSON.toJSON Text
a
  toJSON (ChargeOutcomeRule'Rule Rule
a) = Rule -> Value
forall a. ToJSON a => a -> Value
Data.Aeson.Types.ToJSON.toJSON Rule
a

instance Data.Aeson.Types.FromJSON.FromJSON ChargeOutcomeRule'Variants where
  parseJSON :: Value -> Parser ChargeOutcomeRule'Variants
parseJSON Value
val = case (Text -> ChargeOutcomeRule'Variants
ChargeOutcomeRule'Text (Text -> ChargeOutcomeRule'Variants)
-> Result Text -> Result ChargeOutcomeRule'Variants
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Data.Functor.<$> Value -> Result Text
forall a. FromJSON a => Value -> Result a
Data.Aeson.Types.FromJSON.fromJSON Value
val) Result ChargeOutcomeRule'Variants
-> Result ChargeOutcomeRule'Variants
-> Result ChargeOutcomeRule'Variants
forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
GHC.Base.<|> ((Rule -> ChargeOutcomeRule'Variants
ChargeOutcomeRule'Rule (Rule -> ChargeOutcomeRule'Variants)
-> Result Rule -> Result ChargeOutcomeRule'Variants
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Data.Functor.<$> Value -> Result Rule
forall a. FromJSON a => Value -> Result a
Data.Aeson.Types.FromJSON.fromJSON Value
val) Result ChargeOutcomeRule'Variants
-> Result ChargeOutcomeRule'Variants
-> Result ChargeOutcomeRule'Variants
forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
GHC.Base.<|> String -> Result ChargeOutcomeRule'Variants
forall a. String -> Result a
Data.Aeson.Types.Internal.Error String
"No variant matched") of
    Data.Aeson.Types.Internal.Success ChargeOutcomeRule'Variants
a -> ChargeOutcomeRule'Variants -> Parser ChargeOutcomeRule'Variants
forall (f :: * -> *) a. Applicative f => a -> f a
GHC.Base.pure ChargeOutcomeRule'Variants
a
    Data.Aeson.Types.Internal.Error String
a -> String -> Parser ChargeOutcomeRule'Variants
forall (m :: * -> *) a. MonadFail m => String -> m a
Control.Monad.Fail.fail String
a