Safe Haskell	None
Language	Haskell2010

StripeAPI.Common

Description

This module serves the purpose of defining common functionality which remains the same across all OpenAPI specifications.

Synopsis

doCallWithConfiguration :: MonadHTTP m => Configuration -> Text -> Text -> [QueryParameter] -> m (Response ByteString)
doCallWithConfigurationM :: MonadHTTP m => Text -> Text -> [QueryParameter] -> ClientT m (Response ByteString)
doBodyCallWithConfiguration :: (MonadHTTP m, ToJSON body) => Configuration -> Text -> Text -> [QueryParameter] -> Maybe body -> RequestBodyEncoding -> m (Response ByteString)
doBodyCallWithConfigurationM :: (MonadHTTP m, ToJSON body) => Text -> Text -> [QueryParameter] -> Maybe body -> RequestBodyEncoding -> ClientT m (Response ByteString)
runWithConfiguration :: Configuration -> ClientT m a -> m a
textToByte :: Text -> ByteString
stringifyModel :: StringifyModel a => a -> String
anonymousSecurityScheme :: SecurityScheme
data Configuration = Configuration {
- configBaseURL :: Text
- configSecurityScheme :: SecurityScheme
}
type SecurityScheme = Request -> Request
class Monad m => MonadHTTP m where
- httpBS :: Request -> m (Response ByteString)
class Show a => StringifyModel a
newtype JsonByteString = JsonByteString ByteString
newtype JsonDateTime = JsonDateTime ZonedTime
data RequestBodyEncoding
- = RequestBodyEncodingJSON
- | RequestBodyEncodingFormData
data QueryParameter = QueryParameter {
- queryParamName :: Text
- queryParamValue :: Maybe Value
- queryParamStyle :: Text
- queryParamExplode :: Bool
}
newtype ClientT m a = ClientT (ReaderT Configuration m a)
type ClientM a = ClientT IO a

Documentation

doCallWithConfiguration Source #

Arguments

:: MonadHTTP m
=> Configuration	Configuration options like base URL and security scheme
-> Text	HTTP method (GET, POST, etc.)
-> Text	Path to append to the base URL (path parameters should already be replaced)
-> [QueryParameter]	Query parameters
-> m (Response ByteString)	The raw response from the server

This is the main functionality of this module

It makes a concrete Call to a Server without a body

doCallWithConfigurationM :: MonadHTTP m => Text -> Text -> [QueryParameter] -> ClientT m (Response ByteString) Source #

Same as doCallWithConfiguration but run in a ReaderT environment which contains the configuration. This is useful if multiple calls have to be executed with the same configuration.

doBodyCallWithConfiguration Source #

Arguments

:: (MonadHTTP m, ToJSON body)
=> Configuration	Configuration options like base URL and security scheme
-> Text	HTTP method (GET, POST, etc.)
-> Text	Path to append to the base URL (path parameters should already be replaced)
-> [QueryParameter]	Query parameters
-> Maybe body	Request body
-> RequestBodyEncoding	JSON or form data deepobjects
-> m (Response ByteString)	The raw response from the server

This is the main functionality of this module

It makes a concrete Call to a Server with a body

doBodyCallWithConfigurationM :: (MonadHTTP m, ToJSON body) => Text -> Text -> [QueryParameter] -> Maybe body -> RequestBodyEncoding -> ClientT m (Response ByteString) Source #

Same as doBodyCallWithConfiguration but run in a ReaderT environment which contains the configuration. This is useful if multiple calls have to be executed with the same configuration.

runWithConfiguration :: Configuration -> ClientT m a -> m a Source #

Run a ClientT monad transformer in another monad with a specified configuration

textToByte :: Text -> ByteString Source #

Convert Text a to ByteString

stringifyModel :: StringifyModel a => a -> String Source #

Stringifies a showable value

>>> stringifyModel "Test"
"Test"

>>> stringifyModel 123
"123"

anonymousSecurityScheme :: SecurityScheme Source #

Anonymous security scheme which does not alter the request in any way

data Configuration Source #

An operation can and must be configured with data, which may be common for many operations.

This configuration consists of information about the server URL and the used security scheme.

In OpenAPI these information can be defined

Root level
Path level
Operation level

To get started, the defaultConfiguration can be used and changed accordingly.

Note that it is possible that bearerAuthenticationSecurityScheme is not available because it is not a security scheme in the OpenAPI specification.

defaultConfiguration
  { configSecurityScheme = bearerAuthenticationSecurityScheme "token" }

Constructors

Configuration
Fields configBaseURL :: Text configSecurityScheme :: SecurityScheme

Instances

Instances details

Monad m => MonadReader Configuration (ClientT m) Source #
Instance details Defined in StripeAPI.Common Methods ask :: ClientT m Configuration # local :: (Configuration -> Configuration) -> ClientT m a -> ClientT m a # reader :: (Configuration -> a) -> ClientT m a #

type SecurityScheme = Request -> Request Source #

This type specifies a security scheme which can modify a request according to the scheme (e. g. add an Authorization header)

class Monad m => MonadHTTP m where Source #

Abstracts the usage of httpBS away, so that it can be used for testing

Methods

httpBS :: Request -> m (Response ByteString) Source #

Instances

Instances details

MonadHTTP IO Source #	This instance is the default instance used for production code
Instance details Defined in StripeAPI.Common Methods httpBS :: Request -> IO (Response ByteString) Source #
MonadHTTP m => MonadHTTP (ClientT m) Source #
Instance details Defined in StripeAPI.Common Methods httpBS :: Request -> ClientT m (Response ByteString) Source #
MonadHTTP m => MonadHTTP (ReaderT r m) Source #
Instance details Defined in StripeAPI.Common Methods httpBS :: Request -> ReaderT r m (Response ByteString) Source #

class Show a => StringifyModel a Source #

This type class makes the code generation for URL parameters easier as it allows to stringify a value

The Show class is not sufficient as strings should not be stringified with quotes.

Minimal complete definition

stringifyModel

Instances

Instances details

Show a => StringifyModel a Source #
Instance details Defined in StripeAPI.Common Methods stringifyModel :: a -> String Source #
StringifyModel String Source #
Instance details Defined in StripeAPI.Common Methods stringifyModel :: String -> String Source #
StringifyModel Text Source #
Instance details Defined in StripeAPI.Common Methods stringifyModel :: Text -> String Source #

newtype JsonByteString Source #

Wraps a ByteString to implement ToJSON and FromJSON

Constructors

JsonByteString ByteString

Instances

Instances details

Eq JsonByteString Source #
Instance details Defined in StripeAPI.Common Methods (==) :: JsonByteString -> JsonByteString -> Bool # (/=) :: JsonByteString -> JsonByteString -> Bool #
Ord JsonByteString Source #
Instance details Defined in StripeAPI.Common Methods compare :: JsonByteString -> JsonByteString -> Ordering # (<) :: JsonByteString -> JsonByteString -> Bool # (<=) :: JsonByteString -> JsonByteString -> Bool # (>) :: JsonByteString -> JsonByteString -> Bool # (>=) :: JsonByteString -> JsonByteString -> Bool # max :: JsonByteString -> JsonByteString -> JsonByteString # min :: JsonByteString -> JsonByteString -> JsonByteString #
Show JsonByteString Source #
Instance details Defined in StripeAPI.Common Methods showsPrec :: Int -> JsonByteString -> ShowS # show :: JsonByteString -> String # showList :: [JsonByteString] -> ShowS #
ToJSON JsonByteString Source #
Instance details Defined in StripeAPI.Common Methods toJSON :: JsonByteString -> Value # toEncoding :: JsonByteString -> Encoding # toJSONList :: [JsonByteString] -> Value # toEncodingList :: [JsonByteString] -> Encoding #
FromJSON JsonByteString Source #
Instance details Defined in StripeAPI.Common Methods parseJSON :: Value -> Parser JsonByteString # parseJSONList :: Value -> Parser [JsonByteString] #

newtype JsonDateTime Source #

Wraps a ZonedTime to implement ToJSON and FromJSON

Constructors

JsonDateTime ZonedTime

Instances

Instances details

Eq JsonDateTime Source #
Instance details Defined in StripeAPI.Common Methods (==) :: JsonDateTime -> JsonDateTime -> Bool # (/=) :: JsonDateTime -> JsonDateTime -> Bool #
Ord JsonDateTime Source #
Instance details Defined in StripeAPI.Common Methods compare :: JsonDateTime -> JsonDateTime -> Ordering # (<) :: JsonDateTime -> JsonDateTime -> Bool # (<=) :: JsonDateTime -> JsonDateTime -> Bool # (>) :: JsonDateTime -> JsonDateTime -> Bool # (>=) :: JsonDateTime -> JsonDateTime -> Bool # max :: JsonDateTime -> JsonDateTime -> JsonDateTime # min :: JsonDateTime -> JsonDateTime -> JsonDateTime #
Show JsonDateTime Source #
Instance details Defined in StripeAPI.Common Methods showsPrec :: Int -> JsonDateTime -> ShowS # show :: JsonDateTime -> String # showList :: [JsonDateTime] -> ShowS #
ToJSON JsonDateTime Source #
Instance details Defined in StripeAPI.Common Methods toJSON :: JsonDateTime -> Value # toEncoding :: JsonDateTime -> Encoding # toJSONList :: [JsonDateTime] -> Value # toEncodingList :: [JsonDateTime] -> Encoding #
FromJSON JsonDateTime Source #
Instance details Defined in StripeAPI.Common Methods parseJSON :: Value -> Parser JsonDateTime # parseJSONList :: Value -> Parser [JsonDateTime] #

data RequestBodyEncoding Source #

Defines how a request body is encoded

Constructors

RequestBodyEncodingJSON	Encode the body as JSON
RequestBodyEncodingFormData	Encode the body as form data

data QueryParameter Source #

Defines a query parameter with the information necessary for serialization

Constructors

QueryParameter
Fields queryParamName :: Text queryParamValue :: Maybe Value queryParamStyle :: Text queryParamExplode :: Bool

Instances

Instances details

Eq QueryParameter Source #
Instance details Defined in StripeAPI.Common Methods (==) :: QueryParameter -> QueryParameter -> Bool # (/=) :: QueryParameter -> QueryParameter -> Bool #
Show QueryParameter Source #
Instance details Defined in StripeAPI.Common Methods showsPrec :: Int -> QueryParameter -> ShowS # show :: QueryParameter -> String # showList :: [QueryParameter] -> ShowS #

newtype ClientT m a Source #

The monad in which the operations can be run. Contains the Configuration to run the requests with.

Run it with runWithConfiguration

Constructors

ClientT (ReaderT Configuration m a)

Instances

Instances details

MonadTrans ClientT Source #
Instance details Defined in StripeAPI.Common Methods lift :: Monad m => m a -> ClientT m a #
Monad m => MonadReader Configuration (ClientT m) Source #
Instance details Defined in StripeAPI.Common Methods ask :: ClientT m Configuration # local :: (Configuration -> Configuration) -> ClientT m a -> ClientT m a # reader :: (Configuration -> a) -> ClientT m a #
Monad m => Monad (ClientT m) Source #
Instance details Defined in StripeAPI.Common Methods (>>=) :: ClientT m a -> (a -> ClientT m b) -> ClientT m b # (>>) :: ClientT m a -> ClientT m b -> ClientT m b # return :: a -> ClientT m a #
Functor m => Functor (ClientT m) Source #
Instance details Defined in StripeAPI.Common Methods fmap :: (a -> b) -> ClientT m a -> ClientT m b # (<$) :: a -> ClientT m b -> ClientT m a #
Applicative m => Applicative (ClientT m) Source #
Instance details Defined in StripeAPI.Common Methods pure :: a -> ClientT m a # (<>) :: ClientT m (a -> b) -> ClientT m a -> ClientT m b # liftA2 :: (a -> b -> c) -> ClientT m a -> ClientT m b -> ClientT m c # (>) :: ClientT m a -> ClientT m b -> ClientT m b # (<*) :: ClientT m a -> ClientT m b -> ClientT m a #
MonadIO m => MonadIO (ClientT m) Source #
Instance details Defined in StripeAPI.Common Methods liftIO :: IO a -> ClientT m a #
MonadHTTP m => MonadHTTP (ClientT m) Source #
Instance details Defined in StripeAPI.Common Methods httpBS :: Request -> ClientT m (Response ByteString) Source #

type ClientM a = ClientT IO a Source #

Utility type which uses IO as underlying monad