| Copyright | (c) David Johnson 2014 |
|---|---|
| Maintainer | djohnson.m@gmail.com |
| Stability | experimental |
| Portability | POSIX |
| Safe Haskell | None |
| Language | Haskell2010 |
Web.Stripe.StripeRequest
Contents
Description
- data Method
- data Expandable id
- newtype ExpandParams = ExpandParams {
- getExpandParams :: [Text]
- newtype Param k v = Param (k, v)
- type Params = [(ByteString, ByteString)]
- data StripeRequest a = StripeRequest {}
- type family StripeReturn a :: *
- class ToStripeParam param => StripeHasParam request param
- class ToStripeParam param where
- (-&-) :: StripeHasParam request param => StripeRequest request -> param -> StripeRequest request
- mkStripeRequest :: Method -> Text -> Params -> StripeRequest a
Types
HTTP Method
The other methods are not required by the Stripe API
data Expandable id #
a wrapper for fields which can either be an id or an expanded object
Instances
| (Eq id, Eq (ExpandsTo id)) => Eq (Expandable id) # | |
| (Data id, Data (ExpandsTo id)) => Data (Expandable id) # | |
| (Ord id, Ord (ExpandsTo id)) => Ord (Expandable id) # | |
| (Read id, Read (ExpandsTo id)) => Read (Expandable id) # | |
| (Show id, Show (ExpandsTo id)) => Show (Expandable id) # | |
| (FromJSON id, FromJSON (ExpandsTo id)) => FromJSON (Expandable id) # | JSON Instance for |
newtype ExpandParams #
Type of Expansion Parameters for use on Stripe objects
Constructors
| ExpandParams | |
Fields
| |
Instances
type Params = [(ByteString, ByteString)] #
HTTP Params
data StripeRequest a #
Stripe Request holding Method, URL and Params for a Request. Also
includes the function needed to decode the response.
Constructors
| StripeRequest | |
type family StripeReturn a :: * #
return type of stripe request
Instances
class ToStripeParam param => StripeHasParam request param #
indicate if a request allows an optional parameter
Instances
class ToStripeParam param where #
convert a parameter to a key/value
Minimal complete definition
Methods
toStripeParam :: param -> [(ByteString, ByteString)] -> [(ByteString, ByteString)] #
Instances
(-&-) :: StripeHasParam request param => StripeRequest request -> param -> StripeRequest request #
add an optional parameter to a StripeRequest
mkStripeRequest :: Method -> Text -> Params -> StripeRequest a #
HTTP Params
helper function for building a StripeRequest