{-# 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 UsageRecord
module StripeAPI.Types.UsageRecord 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 qualified Prelude as GHC.Integer.Type
import qualified Prelude as GHC.Maybe

-- | Defines the object schema located at @components.schemas.usage_record@ in the specification.
--
-- Usage records allow you to report customer usage and metrics to Stripe for
-- metered billing of subscription prices.
--
-- Related guide: [Metered Billing](https:\/\/stripe.com\/docs\/billing\/subscriptions\/metered-billing).
data UsageRecord = UsageRecord
  { -- | id: Unique identifier for the object.
    --
    -- Constraints:
    --
    -- * Maximum length of 5000
    UsageRecord -> Text
usageRecordId :: Data.Text.Internal.Text,
    -- | livemode: Has the value \`true\` if the object exists in live mode or the value \`false\` if the object exists in test mode.
    UsageRecord -> Bool
usageRecordLivemode :: GHC.Types.Bool,
    -- | quantity: The usage quantity for the specified date.
    UsageRecord -> Int
usageRecordQuantity :: GHC.Types.Int,
    -- | subscription_item: The ID of the subscription item this usage record contains data for.
    --
    -- Constraints:
    --
    -- * Maximum length of 5000
    UsageRecord -> Text
usageRecordSubscriptionItem :: Data.Text.Internal.Text,
    -- | timestamp: The timestamp when this usage occurred.
    UsageRecord -> Int
usageRecordTimestamp :: GHC.Types.Int
  }
  deriving
    ( Int -> UsageRecord -> ShowS
[UsageRecord] -> ShowS
UsageRecord -> String
(Int -> UsageRecord -> ShowS)
-> (UsageRecord -> String)
-> ([UsageRecord] -> ShowS)
-> Show UsageRecord
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [UsageRecord] -> ShowS
$cshowList :: [UsageRecord] -> ShowS
show :: UsageRecord -> String
$cshow :: UsageRecord -> String
showsPrec :: Int -> UsageRecord -> ShowS
$cshowsPrec :: Int -> UsageRecord -> ShowS
GHC.Show.Show,
      UsageRecord -> UsageRecord -> Bool
(UsageRecord -> UsageRecord -> Bool)
-> (UsageRecord -> UsageRecord -> Bool) -> Eq UsageRecord
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: UsageRecord -> UsageRecord -> Bool
$c/= :: UsageRecord -> UsageRecord -> Bool
== :: UsageRecord -> UsageRecord -> Bool
$c== :: UsageRecord -> UsageRecord -> Bool
GHC.Classes.Eq
    )

instance Data.Aeson.Types.ToJSON.ToJSON UsageRecord where
  toJSON :: UsageRecord -> Value
toJSON UsageRecord
obj = [Pair] -> Value
Data.Aeson.Types.Internal.object (Text
"id" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= UsageRecord -> Text
usageRecordId UsageRecord
obj Pair -> [Pair] -> [Pair]
forall a. a -> [a] -> [a]
: Text
"livemode" Text -> Bool -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= UsageRecord -> Bool
usageRecordLivemode UsageRecord
obj Pair -> [Pair] -> [Pair]
forall a. a -> [a] -> [a]
: Text
"quantity" Text -> Int -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= UsageRecord -> Int
usageRecordQuantity UsageRecord
obj Pair -> [Pair] -> [Pair]
forall a. a -> [a] -> [a]
: Text
"subscription_item" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= UsageRecord -> Text
usageRecordSubscriptionItem UsageRecord
obj Pair -> [Pair] -> [Pair]
forall a. a -> [a] -> [a]
: Text
"timestamp" Text -> Int -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= UsageRecord -> Int
usageRecordTimestamp UsageRecord
obj Pair -> [Pair] -> [Pair]
forall a. a -> [a] -> [a]
: Text
"object" Text -> Value -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= Text -> Value
Data.Aeson.Types.Internal.String Text
"usage_record" Pair -> [Pair] -> [Pair]
forall a. a -> [a] -> [a]
: [Pair]
forall a. Monoid a => a
GHC.Base.mempty)
  toEncoding :: UsageRecord -> Encoding
toEncoding UsageRecord
obj = Series -> Encoding
Data.Aeson.Encoding.Internal.pairs ((Text
"id" Text -> Text -> Series
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= UsageRecord -> Text
usageRecordId UsageRecord
obj) Series -> Series -> Series
forall a. Semigroup a => a -> a -> a
GHC.Base.<> ((Text
"livemode" Text -> Bool -> Series
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= UsageRecord -> Bool
usageRecordLivemode UsageRecord
obj) Series -> Series -> Series
forall a. Semigroup a => a -> a -> a
GHC.Base.<> ((Text
"quantity" Text -> Int -> Series
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= UsageRecord -> Int
usageRecordQuantity UsageRecord
obj) Series -> Series -> Series
forall a. Semigroup a => a -> a -> a
GHC.Base.<> ((Text
"subscription_item" Text -> Text -> Series
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= UsageRecord -> Text
usageRecordSubscriptionItem UsageRecord
obj) Series -> Series -> Series
forall a. Semigroup a => a -> a -> a
GHC.Base.<> ((Text
"timestamp" Text -> Int -> Series
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= UsageRecord -> Int
usageRecordTimestamp UsageRecord
obj) Series -> Series -> Series
forall a. Semigroup a => a -> a -> a
GHC.Base.<> (Text
"object" Text -> Value -> Series
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= Text -> Value
Data.Aeson.Types.Internal.String Text
"usage_record"))))))

instance Data.Aeson.Types.FromJSON.FromJSON UsageRecord where
  parseJSON :: Value -> Parser UsageRecord
parseJSON = String
-> (Object -> Parser UsageRecord) -> Value -> Parser UsageRecord
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.Aeson.Types.FromJSON.withObject String
"UsageRecord" (\Object
obj -> (((((Text -> Bool -> Int -> Text -> Int -> UsageRecord)
-> Parser (Text -> Bool -> Int -> Text -> Int -> UsageRecord)
forall (f :: * -> *) a. Applicative f => a -> f a
GHC.Base.pure Text -> Bool -> Int -> Text -> Int -> UsageRecord
UsageRecord Parser (Text -> Bool -> Int -> Text -> Int -> UsageRecord)
-> Parser Text
-> Parser (Bool -> Int -> Text -> Int -> UsageRecord)
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
"id")) Parser (Bool -> Int -> Text -> Int -> UsageRecord)
-> Parser Bool -> Parser (Int -> Text -> Int -> UsageRecord)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
GHC.Base.<*> (Object
obj Object -> Text -> Parser Bool
forall a. FromJSON a => Object -> Text -> Parser a
Data.Aeson.Types.FromJSON..: Text
"livemode")) Parser (Int -> Text -> Int -> UsageRecord)
-> Parser Int -> Parser (Text -> Int -> UsageRecord)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
GHC.Base.<*> (Object
obj Object -> Text -> Parser Int
forall a. FromJSON a => Object -> Text -> Parser a
Data.Aeson.Types.FromJSON..: Text
"quantity")) Parser (Text -> Int -> UsageRecord)
-> Parser Text -> Parser (Int -> UsageRecord)
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
"subscription_item")) Parser (Int -> UsageRecord) -> Parser Int -> Parser UsageRecord
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
GHC.Base.<*> (Object
obj Object -> Text -> Parser Int
forall a. FromJSON a => Object -> Text -> Parser a
Data.Aeson.Types.FromJSON..: Text
"timestamp"))

-- | Create a new 'UsageRecord' with all required fields.
mkUsageRecord ::
  -- | 'usageRecordId'
  Data.Text.Internal.Text ->
  -- | 'usageRecordLivemode'
  GHC.Types.Bool ->
  -- | 'usageRecordQuantity'
  GHC.Types.Int ->
  -- | 'usageRecordSubscriptionItem'
  Data.Text.Internal.Text ->
  -- | 'usageRecordTimestamp'
  GHC.Types.Int ->
  UsageRecord
mkUsageRecord :: Text -> Bool -> Int -> Text -> Int -> UsageRecord
mkUsageRecord Text
usageRecordId Bool
usageRecordLivemode Int
usageRecordQuantity Text
usageRecordSubscriptionItem Int
usageRecordTimestamp =
  UsageRecord :: Text -> Bool -> Int -> Text -> Int -> UsageRecord
UsageRecord
    { usageRecordId :: Text
usageRecordId = Text
usageRecordId,
      usageRecordLivemode :: Bool
usageRecordLivemode = Bool
usageRecordLivemode,
      usageRecordQuantity :: Int
usageRecordQuantity = Int
usageRecordQuantity,
      usageRecordSubscriptionItem :: Text
usageRecordSubscriptionItem = Text
usageRecordSubscriptionItem,
      usageRecordTimestamp :: Int
usageRecordTimestamp = Int
usageRecordTimestamp
    }