Copyright	(c) David Johnson 2014
Maintainer	djohnson.m@gmail.com
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Web.Stripe.Client

Description

Synopsis

module Web.Stripe.StripeRequest
module Web.Stripe.Error
module Web.Stripe.Util
handleStream :: (Value -> Result a) -> Int -> Result Value -> Either StripeError a
parseFail :: String -> Either StripeError a
attemptDecode :: Int -> Bool
unknownCode :: Either StripeError a
defaultEndpoint :: Endpoint
data Endpoint = Endpoint {
- endpointUrl :: ByteString
- endpointProtocol :: Protocol
- endpointPort :: Int
}
data Protocol
- = HTTP
- | HTTPS
data StripeConfig = StripeConfig {
- secretKey :: StripeKey
- stripeEndpoint :: Maybe Endpoint
}
newtype StripeKey = StripeKey {
- getStripeKey :: ByteString
}
data APIVersion = V20141007

Documentation

module Web.Stripe.StripeRequest

module Web.Stripe.Error

module Web.Stripe.Util

handleStream Source #

Arguments

:: (Value -> Result a)	function to decode JSON value
-> Int	HTTP response code
-> Result Value	result of attempting to decode body
-> Either StripeError a

handleStream

This function is used by the backends such as stripe-http-client to decode the results of an API request.

parseFail Source #

Arguments

:: String	error message
-> Either StripeError a

lift a parser error to be a StripeError

attemptDecode Source #

Arguments

:: Int	HTTP status code
-> Bool

check the HTTP status code and see if it is one we can deal with or not

unknownCode :: Either StripeError a Source #

StripeError to return when we don't know what to do with the received HTTP status code.

defaultEndpoint :: Endpoint Source #

data Endpoint Source #

Stripe endpoint, useful for mocking

Constructors

Endpoint
Fields endpointUrl :: ByteString endpointProtocol :: Protocol endpointPort :: Int

Instances

Eq Endpoint Source #
Instance details Defined in Web.Stripe.Client Methods (==) :: Endpoint -> Endpoint -> Bool # (/=) :: Endpoint -> Endpoint -> Bool #
Data Endpoint Source #
Instance details Defined in Web.Stripe.Client Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Endpoint -> c Endpoint # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Endpoint # toConstr :: Endpoint -> Constr # dataTypeOf :: Endpoint -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Endpoint) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Endpoint) # gmapT :: (forall b. Data b => b -> b) -> Endpoint -> Endpoint # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Endpoint -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Endpoint -> r # gmapQ :: (forall d. Data d => d -> u) -> Endpoint -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Endpoint -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Endpoint -> m Endpoint # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Endpoint -> m Endpoint # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Endpoint -> m Endpoint #
Ord Endpoint Source #
Instance details Defined in Web.Stripe.Client Methods compare :: Endpoint -> Endpoint -> Ordering # (<) :: Endpoint -> Endpoint -> Bool # (<=) :: Endpoint -> Endpoint -> Bool # (>) :: Endpoint -> Endpoint -> Bool # (>=) :: Endpoint -> Endpoint -> Bool # max :: Endpoint -> Endpoint -> Endpoint # min :: Endpoint -> Endpoint -> Endpoint #
Read Endpoint Source #
Instance details Defined in Web.Stripe.Client Methods readsPrec :: Int -> ReadS Endpoint # readList :: ReadS [Endpoint] # readPrec :: ReadPrec Endpoint # readListPrec :: ReadPrec [Endpoint] #
Show Endpoint Source #
Instance details Defined in Web.Stripe.Client Methods showsPrec :: Int -> Endpoint -> ShowS # show :: Endpoint -> String # showList :: [Endpoint] -> ShowS #

data Protocol Source #

Endpoint Protocol

Constructors

HTTP
HTTPS

Instances

Eq Protocol Source #
Instance details Defined in Web.Stripe.Client Methods (==) :: Protocol -> Protocol -> Bool # (/=) :: Protocol -> Protocol -> Bool #
Data Protocol Source #
Instance details Defined in Web.Stripe.Client Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Protocol -> c Protocol # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Protocol # toConstr :: Protocol -> Constr # dataTypeOf :: Protocol -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Protocol) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Protocol) # gmapT :: (forall b. Data b => b -> b) -> Protocol -> Protocol # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Protocol -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Protocol -> r # gmapQ :: (forall d. Data d => d -> u) -> Protocol -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Protocol -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Protocol -> m Protocol # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Protocol -> m Protocol # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Protocol -> m Protocol #
Ord Protocol Source #
Instance details Defined in Web.Stripe.Client Methods compare :: Protocol -> Protocol -> Ordering # (<) :: Protocol -> Protocol -> Bool # (<=) :: Protocol -> Protocol -> Bool # (>) :: Protocol -> Protocol -> Bool # (>=) :: Protocol -> Protocol -> Bool # max :: Protocol -> Protocol -> Protocol # min :: Protocol -> Protocol -> Protocol #
Read Protocol Source #
Instance details Defined in Web.Stripe.Client Methods readsPrec :: Int -> ReadS Protocol # readList :: ReadS [Protocol] # readPrec :: ReadPrec Protocol # readListPrec :: ReadPrec [Protocol] #
Show Protocol Source #
Instance details Defined in Web.Stripe.Client Methods showsPrec :: Int -> Protocol -> ShowS # show :: Protocol -> String # showList :: [Protocol] -> ShowS #

data StripeConfig Source #

Stripe config

Constructors

StripeConfig
Fields secretKey :: StripeKey stripeEndpoint :: Maybe Endpoint

Instances

Eq StripeConfig Source #
Instance details Defined in Web.Stripe.Client Methods (==) :: StripeConfig -> StripeConfig -> Bool # (/=) :: StripeConfig -> StripeConfig -> Bool #
Data StripeConfig Source #
Instance details Defined in Web.Stripe.Client Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StripeConfig -> c StripeConfig # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StripeConfig # toConstr :: StripeConfig -> Constr # dataTypeOf :: StripeConfig -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c StripeConfig) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StripeConfig) # gmapT :: (forall b. Data b => b -> b) -> StripeConfig -> StripeConfig # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StripeConfig -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StripeConfig -> r # gmapQ :: (forall d. Data d => d -> u) -> StripeConfig -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> StripeConfig -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> StripeConfig -> m StripeConfig # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StripeConfig -> m StripeConfig # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StripeConfig -> m StripeConfig #
Ord StripeConfig Source #
Instance details Defined in Web.Stripe.Client Methods compare :: StripeConfig -> StripeConfig -> Ordering # (<) :: StripeConfig -> StripeConfig -> Bool # (<=) :: StripeConfig -> StripeConfig -> Bool # (>) :: StripeConfig -> StripeConfig -> Bool # (>=) :: StripeConfig -> StripeConfig -> Bool # max :: StripeConfig -> StripeConfig -> StripeConfig # min :: StripeConfig -> StripeConfig -> StripeConfig #
Read StripeConfig Source #
Instance details Defined in Web.Stripe.Client Methods readsPrec :: Int -> ReadS StripeConfig # readList :: ReadS [StripeConfig] # readPrec :: ReadPrec StripeConfig # readListPrec :: ReadPrec [StripeConfig] #
Show StripeConfig Source #
Instance details Defined in Web.Stripe.Client Methods showsPrec :: Int -> StripeConfig -> ShowS # show :: StripeConfig -> String # showList :: [StripeConfig] -> ShowS #

newtype StripeKey Source #

Stripe secret key

Constructors

StripeKey
Fields getStripeKey :: ByteString

Instances

Eq StripeKey Source #
Instance details Defined in Web.Stripe.Client Methods (==) :: StripeKey -> StripeKey -> Bool # (/=) :: StripeKey -> StripeKey -> Bool #
Data StripeKey Source #
Instance details Defined in Web.Stripe.Client Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StripeKey -> c StripeKey # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StripeKey # toConstr :: StripeKey -> Constr # dataTypeOf :: StripeKey -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c StripeKey) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StripeKey) # gmapT :: (forall b. Data b => b -> b) -> StripeKey -> StripeKey # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StripeKey -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StripeKey -> r # gmapQ :: (forall d. Data d => d -> u) -> StripeKey -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> StripeKey -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> StripeKey -> m StripeKey # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StripeKey -> m StripeKey # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StripeKey -> m StripeKey #
Ord StripeKey Source #
Instance details Defined in Web.Stripe.Client Methods compare :: StripeKey -> StripeKey -> Ordering # (<) :: StripeKey -> StripeKey -> Bool # (<=) :: StripeKey -> StripeKey -> Bool # (>) :: StripeKey -> StripeKey -> Bool # (>=) :: StripeKey -> StripeKey -> Bool # max :: StripeKey -> StripeKey -> StripeKey # min :: StripeKey -> StripeKey -> StripeKey #
Read StripeKey Source #
Instance details Defined in Web.Stripe.Client Methods readsPrec :: Int -> ReadS StripeKey # readList :: ReadS [StripeKey] # readPrec :: ReadPrec StripeKey # readListPrec :: ReadPrec [StripeKey] #
Show StripeKey Source #
Instance details Defined in Web.Stripe.Client Methods showsPrec :: Int -> StripeKey -> ShowS # show :: StripeKey -> String # showList :: [StripeKey] -> ShowS #

data APIVersion Source #

API Version

Constructors

V20141007

Stripe API Version for this package release

Instances

Eq APIVersion Source #
Instance details Defined in Web.Stripe.Client Methods (==) :: APIVersion -> APIVersion -> Bool # (/=) :: APIVersion -> APIVersion -> Bool #
Data APIVersion Source #
Instance details Defined in Web.Stripe.Client Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> APIVersion -> c APIVersion # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c APIVersion # toConstr :: APIVersion -> Constr # dataTypeOf :: APIVersion -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c APIVersion) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c APIVersion) # gmapT :: (forall b. Data b => b -> b) -> APIVersion -> APIVersion # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> APIVersion -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> APIVersion -> r # gmapQ :: (forall d. Data d => d -> u) -> APIVersion -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> APIVersion -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> APIVersion -> m APIVersion # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> APIVersion -> m APIVersion # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> APIVersion -> m APIVersion #
Ord APIVersion Source #
Instance details Defined in Web.Stripe.Client Methods compare :: APIVersion -> APIVersion -> Ordering # (<) :: APIVersion -> APIVersion -> Bool # (<=) :: APIVersion -> APIVersion -> Bool # (>) :: APIVersion -> APIVersion -> Bool # (>=) :: APIVersion -> APIVersion -> Bool # max :: APIVersion -> APIVersion -> APIVersion # min :: APIVersion -> APIVersion -> APIVersion #
Read APIVersion Source #
Instance details Defined in Web.Stripe.Client Methods readsPrec :: Int -> ReadS APIVersion # readList :: ReadS [APIVersion] # readPrec :: ReadPrec APIVersion # readListPrec :: ReadPrec [APIVersion] #
Show APIVersion Source #
Instance details Defined in Web.Stripe.Client Methods showsPrec :: Int -> APIVersion -> ShowS # show :: APIVersion -> String # showList :: [APIVersion] -> ShowS #