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

Web.Stripe.Client.HttpStreams

Contents

low-level

Description

Synopsis

stripe :: FromJSON (StripeReturn a) => StripeConfig -> StripeRequest a -> IO (Either StripeError (StripeReturn a))
stripeConn :: FromJSON (StripeReturn a) => Connection -> StripeConfig -> StripeRequest a -> IO (Either StripeError (StripeReturn a))
withConnection :: (Connection -> IO (Either StripeError a)) -> IO (Either StripeError a)
data StripeRequest a = StripeRequest {
- method :: Method
- endpoint :: Text
- queryParams :: Params
}
data StripeError = StripeError {
- errorType :: StripeErrorType
- errorMsg :: Text
- errorCode :: Maybe StripeErrorCode
- errorParam :: Maybe Text
- errorHTTP :: Maybe StripeErrorHTTPCode
}
data StripeConfig = StripeConfig {
- secretKey :: StripeKey
}
callAPI :: Connection -> (Value -> Result b) -> StripeConfig -> StripeRequest a -> IO (Either StripeError b)

Documentation

stripe :: FromJSON (StripeReturn a) => StripeConfig -> StripeRequest a -> IO (Either StripeError (StripeReturn a)) Source #

Create a request to Stripe's API

stripeConn :: FromJSON (StripeReturn a) => Connection -> StripeConfig -> StripeRequest a -> IO (Either StripeError (StripeReturn a)) Source #

Create a request to Stripe's API using a connection opened with withConnection

withConnection :: (Connection -> IO (Either StripeError a)) -> IO (Either StripeError a) Source #

Open a connection to the stripe API server

data StripeRequest a #

Stripe Request holding Method, URL and Params for a Request. Also includes the function needed to decode the response.

Constructors

StripeRequest
Fields method :: Method Method of StripeRequest (i.e. `GET`, `PUT`, `POST`, `PUT`) endpoint :: Text Endpoint of StripeRequest queryParams :: Params Query Parameters of StripeRequest

data StripeError #

Stripe Error

Constructors

StripeError
Fields errorType :: StripeErrorType errorMsg :: Text errorCode :: Maybe StripeErrorCode errorParam :: Maybe Text errorHTTP :: Maybe StripeErrorHTTPCode

Instances

Show StripeError
Instance details Defined in Web.Stripe.Error Methods showsPrec :: Int -> StripeError -> ShowS # show :: StripeError -> String # showList :: [StripeError] -> ShowS #
FromJSON StripeError
Instance details Defined in Web.Stripe.Error Methods parseJSON :: Value -> Parser StripeError # parseJSONList :: Value -> Parser [StripeError] #
Exception StripeError
Instance details Defined in Web.Stripe.Error Methods toException :: StripeError -> SomeException # fromException :: SomeException -> Maybe StripeError # displayException :: StripeError -> String #

data StripeConfig #

Stripe config

Constructors

StripeConfig
Fields secretKey :: StripeKey

Instances

Eq StripeConfig
Instance details Defined in Web.Stripe.Client Methods (==) :: StripeConfig -> StripeConfig -> Bool # (/=) :: StripeConfig -> StripeConfig -> Bool #
Data StripeConfig
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
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
Instance details Defined in Web.Stripe.Client Methods readsPrec :: Int -> ReadS StripeConfig # readList :: ReadS [StripeConfig] # readPrec :: ReadPrec StripeConfig # readListPrec :: ReadPrec [StripeConfig] #
Show StripeConfig
Instance details Defined in Web.Stripe.Client Methods showsPrec :: Int -> StripeConfig -> ShowS # show :: StripeConfig -> String # showList :: [StripeConfig] -> ShowS #

low-level

callAPI Source #

Arguments

:: Connection	an open connection to the server (`withConnection`)
-> (Value -> Result b)	function to convert JSON result to Haskell Value
-> StripeConfig	StripeConfig
-> StripeRequest a	StripeRequest
-> IO (Either StripeError b)

Create a request to Stripe's API over an existing connection

see also: withConnection FIXME: all connection errors should be turned into a StripeError. But that is not yet implemented.

NOTES: this a pretty low-level function. You probably want stripe or stripeConn. If you call this function directly, you are responsible for ensuring the JSON conversion function supplied is correct for StripeRequest. In the rest of the library this property is enforced automatically by the type-system. But adding that constraint here made implementing the Stripe testing monad difficult.