StripeAPI.Common

This is the main functionality of this module

It makes a concrete Call to a Server without a body

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.

This is the main functionality of this module

It makes a concrete Call to a Server with a body

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.

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

Convert Text a to ByteString

Stringifies a showable value

>>> stringifyModel "Test""Test"

>>> stringifyModel 123"123"

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

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" }

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

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

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.

Wraps a ByteString to implement ToJSON and FromJSON

Wraps a ZonedTime to implement ToJSON and FromJSON

Defines how a request body is encoded

Defines a query parameter with the information necessary for serialization

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

Run it with runWithConfiguration

Utility type which uses IO as underlying monad