RecurlyClient.Common

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

Documentation

doCallWithConfiguration

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)

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

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)

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

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

textToByte :: Text -> ByteString

Convert Text a to ByteString

byteToText :: ByteString -> Text

Convert a ByteString to Text

stringifyModel :: ToJSON a => a -> Text

This function 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.

anonymousSecurityScheme :: SecurityScheme

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

jsonObjectToList :: KeyMap v -> [(Text, v)]

data Configuration

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

  The path of the operation is appended to this URL

• configSecurityScheme :: SecurityScheme

  The SecurityScheme which is applied to the request This is used to set the Authentication header for example

• configIncludeUserAgent :: Bool

  This flag indicates if an automatically generated User-Agent header should be added to the request. This allows the server to detect with which version of the generator the code was generated.

• configApplicationName :: Text

  The application name which will be included in the User-Agent header if configIncludeUserAgent is set to True

Instances

Monad m => MonadReader Configuration (ClientT m)

Defined in RecurlyClient.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

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

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

Methods

httpBS :: Request -> m (Response ByteString)

Instances

MonadHTTP IO

This instance is the default instance used for production code

Defined in RecurlyClient.Common

Methods

httpBS :: Request -> IO (Response ByteString)

MonadHTTP m => MonadHTTP (ClientT m)

Defined in RecurlyClient.Common

Methods

httpBS :: Request -> ClientT m (Response ByteString)

MonadHTTP m => MonadHTTP (ReaderT r m)

Defined in RecurlyClient.Common

Methods

httpBS :: Request -> ReaderT r m (Response ByteString)

newtype JsonByteString

Wraps a ByteString to implement ToJSON and FromJSON

Constructors

JsonByteString ByteString

Instances

FromJSON JsonByteString

Defined in RecurlyClient.Common

Methods

parseJSON :: Value -> Parser JsonByteString

parseJSONList :: Value -> Parser [JsonByteString]

ToJSON JsonByteString

Defined in RecurlyClient.Common

Methods

toJSON :: JsonByteString -> Value

toEncoding :: JsonByteString -> Encoding

toJSONList :: [JsonByteString] -> Value

toEncodingList :: [JsonByteString] -> Encoding

Show JsonByteString

Defined in RecurlyClient.Common

Methods

showsPrec :: Int -> JsonByteString -> ShowS

show :: JsonByteString -> String

showList :: [JsonByteString] -> ShowS

Eq JsonByteString

Defined in RecurlyClient.Common

Methods

(==) :: JsonByteString -> JsonByteString -> Bool

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

Ord JsonByteString

Defined in RecurlyClient.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

newtype JsonDateTime

Wraps a ZonedTime to implement ToJSON and FromJSON

Constructors

JsonDateTime ZonedTime

Instances

FromJSON JsonDateTime

Defined in RecurlyClient.Common

Methods

parseJSON :: Value -> Parser JsonDateTime

parseJSONList :: Value -> Parser [JsonDateTime]

ToJSON JsonDateTime

Defined in RecurlyClient.Common

Methods

toJSON :: JsonDateTime -> Value

toEncoding :: JsonDateTime -> Encoding

toJSONList :: [JsonDateTime] -> Value

toEncodingList :: [JsonDateTime] -> Encoding

Show JsonDateTime

Defined in RecurlyClient.Common

Methods

showsPrec :: Int -> JsonDateTime -> ShowS

show :: JsonDateTime -> String

showList :: [JsonDateTime] -> ShowS

Eq JsonDateTime

Defined in RecurlyClient.Common

Methods

(==) :: JsonDateTime -> JsonDateTime -> Bool

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

Ord JsonDateTime

Defined in RecurlyClient.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

data RequestBodyEncoding

Defines how a request body is encoded

Constructors

RequestBodyEncodingJSON

Encode the body as JSON

RequestBodyEncodingFormData

Encode the body as form data

data QueryParameter

Defines a query parameter with the information necessary for serialization

Constructors

QueryParameter

Fields

• queryParamName :: Text
• queryParamValue :: Maybe Value
• queryParamStyle :: Text
• queryParamExplode :: Bool

Instances

Show QueryParameter

Defined in RecurlyClient.Common

Methods

showsPrec :: Int -> QueryParameter -> ShowS

show :: QueryParameter -> String

showList :: [QueryParameter] -> ShowS

Eq QueryParameter

Defined in RecurlyClient.Common

Methods

(==) :: QueryParameter -> QueryParameter -> Bool

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

data Nullable a

Constructors

NonNull a

Null

Instances

FromJSON a => FromJSON (Nullable a)

Defined in RecurlyClient.Common

Methods

parseJSON :: Value -> Parser (Nullable a)

parseJSONList :: Value -> Parser [Nullable a]

ToJSON a => ToJSON (Nullable a)

Defined in RecurlyClient.Common

Methods

toJSON :: Nullable a -> Value

toEncoding :: Nullable a -> Encoding

toJSONList :: [Nullable a] -> Value

toEncodingList :: [Nullable a] -> Encoding

Show a => Show (Nullable a)

Defined in RecurlyClient.Common

Methods

showsPrec :: Int -> Nullable a -> ShowS

show :: Nullable a -> String

showList :: [Nullable a] -> ShowS

Eq a => Eq (Nullable a)

Defined in RecurlyClient.Common

Methods

(==) :: Nullable a -> Nullable a -> Bool

(/=) :: Nullable a -> Nullable a -> Bool

newtype ClientT m a

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

MonadTrans ClientT

Defined in RecurlyClient.Common

Methods

lift :: Monad m => m a -> ClientT m a

Monad m => MonadReader Configuration (ClientT m)

Defined in RecurlyClient.Common

Methods

ask :: ClientT m Configuration

local :: (Configuration -> Configuration) -> ClientT m a -> ClientT m a

reader :: (Configuration -> a) -> ClientT m a

MonadIO m => MonadIO (ClientT m)

Defined in RecurlyClient.Common

Methods

liftIO :: IO a -> ClientT m a

Applicative m => Applicative (ClientT m)

Defined in RecurlyClient.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

Functor m => Functor (ClientT m)

Defined in RecurlyClient.Common

Methods

fmap :: (a -> b) -> ClientT m a -> ClientT m b

(<$) :: a -> ClientT m b -> ClientT m a

Monad m => Monad (ClientT m)

Defined in RecurlyClient.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

MonadHTTP m => MonadHTTP (ClientT m)

Defined in RecurlyClient.Common

Methods

httpBS :: Request -> ClientT m (Response ByteString)

type ClientM a = ClientT IO a

Utility type which uses IO as underlying monad