Web.Stripe.Client.HttpClient

Documentation

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

Defined in Web.Stripe.Error

Methods

showsPrec :: Int -> StripeError -> ShowS

show :: StripeError -> String

showList :: [StripeError] -> ShowS

FromJSON StripeError

Defined in Web.Stripe.Error

Methods

parseJSON :: Value -> Parser StripeError

parseJSONList :: Value -> Parser [StripeError]

Exception StripeError

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
• stripeEndpoint :: Maybe Endpoint

Instances

Eq StripeConfig

Defined in Web.Stripe.Client

Methods

(==) :: StripeConfig -> StripeConfig -> Bool

(/=) :: StripeConfig -> StripeConfig -> Bool

Data StripeConfig

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

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

Defined in Web.Stripe.Client

Methods

readsPrec :: Int -> ReadS StripeConfig

readList :: ReadS [StripeConfig]

readPrec :: ReadPrec StripeConfig

readListPrec :: ReadPrec [StripeConfig]

Show StripeConfig

Defined in Web.Stripe.Client

Methods

showsPrec :: Int -> StripeConfig -> ShowS

show :: StripeConfig -> String

showList :: [StripeConfig] -> ShowS

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

Create a request to Stripes API.

This function uses the global TLS manager from http-client-tls via getGlobalManager.

stripeManager :: FromJSON (StripeReturn a) => Manager -> StripeConfig -> StripeRequest a -> IO (Either StripeError (StripeReturn a))

Create a request to Stripes API using a Manager.

stripeConn :: FromJSON (StripeReturn a) => Manager -> StripeConfig -> StripeRequest a -> IO (Either StripeError (StripeReturn a))

Create a request to Stripes API using a Manager.

This function is used to maintain compatibility w/ stripe-http-streams. However, the terminology in http-streams uses Connection whereas http-client uses connection Manager.

low-level

withConnection :: (Manager -> IO (Either StripeError a)) -> IO (Either StripeError a)

withManager :: (Manager -> IO (Either StripeError a)) -> IO (Either StripeError a)

callAPI :: Manager -> (Value -> Result b) -> StripeConfig -> StripeRequest a -> IO (Either StripeError b)

Create a request to Stripes API using an existing Manager

This is a low-level function. In most cases you probably want to use stripe or stripeManager.