stripe checkout session status

Author: functora

nix/tools.nix

@@ -68,4 +68,5 @@ in [
   styleTest
   prettier
   pkgs.alejandra
+  pkgs.haskellPackages.cpphs
 ]

pub/stripe-hs/src/Stripe/Client.hs

@@ -1,62 +1,104 @@
-{-# OPTIONS_GHC -cpp -pgmPcpphs -optP--cpp #-}
 {-# LANGUAGE CPP #-}
+{-# OPTIONS_GHC -cpp -pgmPcpphs -optP--cpp #-}
+
 module Stripe.Client
   ( -- * Basics
-    ApiKey, StripeClient, makeStripeClient, ClientError(..)
+    ApiKey,
+    StripeClient,
+    makeStripeClient,
+    ClientError (..),
+
     -- * Helper types
-  , TimeStamp(..), StripeList(..)
+    TimeStamp (..),
+    StripeList (..),
+
     -- * Customers
-  , createCustomer, retrieveCustomer, updateCustomer, listCustomers
-  , CustomerId(..), Customer(..), CustomerCreate(..), CustomerUpdate(..)
+    createCustomer,
+    retrieveCustomer,
+    updateCustomer,
+    listCustomers,
+    CustomerId (..),
+    Customer (..),
+    CustomerCreate (..),
+    CustomerUpdate (..),
+
     -- * Product catalog
-  , ProductId(..), PriceId(..), Product(..), Price(..), PriceRecurring(..)
-  , ProductCreate(..), PriceCreate(..), PriceCreateRecurring(..)
-  , createProduct, retrieveProduct
-  , createPrice, retrievePrice, listPrices
+    ProductId (..),
+    PriceId (..),
+    Product (..),
+    Price (..),
+    PriceRecurring (..),
+    ProductCreate (..),
+    PriceCreate (..),
+    PriceCreateRecurring (..),
+    createProduct,
+    retrieveProduct,
+    createPrice,
+    retrievePrice,
+    listPrices,
+
     -- * Subscriptions
-  , SubscriptionId(..), SubscriptionItemId(..), Subscription(..), SubscriptionItem(..), SubscriptionCreate(..), SubscriptionCreateItem(..)
-  , createSubscription, retrieveSubscription, listSubscriptions
+    SubscriptionId (..),
+    SubscriptionItemId (..),
+    Subscription (..),
+    SubscriptionItem (..),
+    SubscriptionCreate (..),
+    SubscriptionCreateItem (..),
+    createSubscription,
+    retrieveSubscription,
+    listSubscriptions,
+
     -- * Customer Portal
-  , CustomerPortalId(..), CustomerPortal(..), CustomerPortalCreate(..)
-  , createCustomerPortal
+    CustomerPortalId (..),
+    CustomerPortal (..),
+    CustomerPortalCreate (..),
+    createCustomerPortal,
+
     -- * Checkout
-  , CheckoutSessionId(..), CheckoutSession(..), CheckoutSessionCreate(..), CheckoutSessionCreateLineItem(..)
-  , createCheckoutSession, retrieveCheckoutSession
+    CheckoutSessionId (..),
+    CheckoutSessionStatus (..),
+    CheckoutSession (..),
+    CheckoutSessionCreate (..),
+    CheckoutSessionCreateLineItem (..),
+    createCheckoutSession,
+    retrieveCheckoutSession,
+
     -- * Events
-  , retrieveEvent, listEvents
-  , EventId(..), Event(..), EventData(..)
+    retrieveEvent,
+    listEvents,
+    EventId (..),
+    Event (..),
+    EventData (..),
   )
 where
 
-import Stripe.Api
-import Stripe.Resources
-import Stripe.Client.Internal.Helpers
-
 import Data.Proxy
-import Servant.API
-import Servant.Client
-import Network.HTTP.Client (Manager)
 import qualified Data.Text as T
 import qualified Data.Text.Encoding as T
+import Network.HTTP.Client (Manager)
+import Servant.API
+import Servant.Client
+import Stripe.Api
+import Stripe.Client.Internal.Helpers
+import Stripe.Resources
 
 -- | Your Stripe API key. Can be obtained from the Stripe dashboard. Format: @sk_<mode>_<redacted>@
 type ApiKey = T.Text
 
 -- | Holds a 'Manager' and your API key.
-data StripeClient
-  = StripeClient
-  { scBasicAuthData :: BasicAuthData
-  , scManager :: Manager
-  , scMaxRetries :: Int
+data StripeClient = StripeClient
+  { scBasicAuthData :: BasicAuthData,
+    scManager :: Manager,
+    scMaxRetries :: Int
   }
 
 -- | Construct a 'StripeClient'. Note that the passed 'Manager' must support https (e.g. via @http-client-tls@)
 makeStripeClient ::
-  ApiKey
-  -> Manager
-  -> Int
-  -- ^ Number of automatic retries the library should attempt. See also <https://stripe.com/docs/error-handling#safely-retrying-requests-with-idempotency Stripe Error Handling>
-  -> StripeClient
+  ApiKey ->
+  Manager ->
+  -- | Number of automatic retries the library should attempt. See also <https://stripe.com/docs/error-handling#safely-retrying-requests-with-idempotency Stripe Error Handling>
+  Int ->
+  StripeClient
 makeStripeClient k = StripeClient (BasicAuthData (T.encodeUtf8 k) "")
 
 api :: Proxy StripeApi
@@ -80,35 +122,35 @@ stripeBaseUrl = BaseUrl Https "api.stripe.com" 443 ""
     N :: StripeClient -> ARG -> ARG2 -> ARG3 -> IO (Either ClientError R);\
     N sc a b c = runRequest (scMaxRetries sc) 0 $ runClientM (N##' (scBasicAuthData sc) a b c) (mkClientEnv (scManager sc) stripeBaseUrl)
 
-EP(createCustomer, CustomerCreate, Customer)
-EP(retrieveCustomer, CustomerId, Customer)
-EP2(updateCustomer, CustomerId, CustomerUpdate, Customer)
-EP(listCustomers, Maybe CustomerId, (StripeList Customer))
+EP (createCustomer, CustomerCreate, Customer)
+EP (retrieveCustomer, CustomerId, Customer)
+EP2 (updateCustomer, CustomerId, CustomerUpdate, Customer)
+EP (listCustomers, Maybe CustomerId, (StripeList Customer))
 
-EP(createProduct, ProductCreate, Product)
-EP(retrieveProduct, ProductId, Product)
+EP (createProduct, ProductCreate, Product)
+EP (retrieveProduct, ProductId, Product)
 
-EP(createPrice, PriceCreate, Price)
-EP(retrievePrice, PriceId, Price)
-EP(listPrices, Maybe T.Text, (StripeList Price))
+EP (createPrice, PriceCreate, Price)
+EP (retrievePrice, PriceId, Price)
+EP (listPrices, Maybe T.Text, (StripeList Price))
 
-EP(createSubscription, SubscriptionCreate, Subscription)
-EP(retrieveSubscription, SubscriptionId, Subscription)
-EP(listSubscriptions, Maybe CustomerId, (StripeList Subscription))
+EP (createSubscription, SubscriptionCreate, Subscription)
+EP (retrieveSubscription, SubscriptionId, Subscription)
+EP (listSubscriptions, Maybe CustomerId, (StripeList Subscription))
 
-EP(createCheckoutSession, CheckoutSessionCreate, CheckoutSession)
-EP(retrieveCheckoutSession, CheckoutSessionId, CheckoutSession)
+EP (createCheckoutSession, CheckoutSessionCreate, CheckoutSession)
+EP (retrieveCheckoutSession, CheckoutSessionId, CheckoutSession)
 
-EP(createCustomerPortal, CustomerPortalCreate, CustomerPortal)
+EP (createCustomerPortal, CustomerPortalCreate, CustomerPortal)
 
-EP(retrieveEvent, EventId, Event)
-EP(listEvents, Maybe EventId, (StripeList Event))
+EP (retrieveEvent, EventId, Event)
+EP (listEvents, Maybe EventId, (StripeList Event))
 
 (createCustomer' :<|> retrieveCustomer' :<|> updateCustomer' :<|> listCustomers')
   :<|> (createProduct' :<|> retrieveProduct')
   :<|> (createPrice' :<|> retrievePrice' :<|> listPrices')
   :<|> (createSubscription' :<|> retrieveSubscription' :<|> listSubscriptions')
   :<|> (createCheckoutSession' :<|> retrieveCheckoutSession')
   :<|> (createCustomerPortal')
-  :<|> (retrieveEvent' :<|> listEvents')
-  = client api
+  :<|> (retrieveEvent' :<|> listEvents') =
+    client api

pub/stripe-servant/src/Stripe/Resources.hs

@@ -1,3 +1,5 @@
+{-# LANGUAGE DeriveDataTypeable #-}
+{-# LANGUAGE DerivingStrategies #-}
 {-# LANGUAGE GeneralizedNewtypeDeriving #-}
 {-# LANGUAGE TemplateHaskell #-}
 
@@ -37,6 +39,7 @@ module Stripe.Resources
 
     -- * Checkout
     CheckoutSessionId (..),
+    CheckoutSessionStatus (..),
     CheckoutSession (..),
     CheckoutSessionCreate (..),
     CheckoutSessionCreateLineItem (..),
@@ -49,6 +52,7 @@ module Stripe.Resources
 where
 
 import qualified Data.Aeson as A
+import Data.Data (Data)
 import qualified Data.HashMap.Strict as HM
 import Data.Maybe
 import qualified Data.Text as T
@@ -241,6 +245,12 @@ data SubscriptionCreate = SubscriptionCreate
 newtype CheckoutSessionId = CheckoutSessionId {unCheckoutSessionId :: T.Text}
   deriving (Show, Eq, ToJSON, FromJSON, ToHttpApiData)
 
+data CheckoutSessionStatus
+  = CssOpen
+  | CssExpired
+  | CssComplete
+  deriving stock (Eq, Ord, Show, Read, Data, Generic, Enum, Bounded)
+
 data CheckoutSession = CheckoutSession
   { csId :: CheckoutSessionId,
     csLivemode :: Bool,
@@ -250,6 +260,7 @@ data CheckoutSession = CheckoutSession
     csPaymentMethodTypes :: V.Vector T.Text, -- TODO: make enum
     csSubscription :: Maybe SubscriptionId,
     csAllowPromotionCodes :: Maybe Bool,
+    csStatus :: CheckoutSessionStatus,
     csUrl :: T.Text
   }
   deriving (Show, Eq)
@@ -295,6 +306,7 @@ $(deriveJSON (jsonOpts 2) ''StripeList)
 $(deriveJSON (jsonOpts 1) ''Customer)
 $(deriveJSON (jsonOpts 2) ''EventData)
 $(deriveJSON (jsonOpts 1) ''Event)
+$(deriveJSON (jsonOpts 3) ''CheckoutSessionStatus)
 $(deriveJSON (jsonOpts 2) ''CheckoutSession)
 $(deriveJSON (jsonOpts 2) ''PriceRecurring)
 $(deriveJSON (jsonOpts 1) ''Price)

pub/stripe-servant/src/Stripe/Util/Aeson.hs

@@ -1,8 +1,4 @@
--- |
-
-module Stripe.Util.Aeson
-  ( jsonOpts, deriveJSON, ToJSON, FromJSON )
-where
+module Stripe.Util.Aeson (jsonOpts, deriveJSON, ToJSON, FromJSON) where
 
 import Data.Aeson
 import Data.Aeson.TH
@@ -11,6 +7,7 @@ import Text.Casing (quietSnake)
 jsonOpts :: Int -> Options
 jsonOpts x =
   defaultOptions
-  { fieldLabelModifier = quietSnake . drop x
-  , constructorTagModifier = quietSnake
-  }
+    { fieldLabelModifier = quietSnake . drop x,
+      constructorTagModifier = quietSnake . drop x,
+      sumEncoding = UntaggedValue
+    }