Stripe.Wreq

Typical use of this module:

1. Run get, post, or delete to get a WreqResponse.
2. Use wreqResponse to convert the Wreq response to a Response.
3. Use responseValue to obtain the response payload as an Aeson Value (or an Error if the request was not successful).

Request

GET

get :: Session -> ApiSecretKey -> Get -> IO WreqResponse

get' :: Session -> ApiSecretKey -> RequestApiVersion -> Get -> IO WreqResponse

data Get

Constructors

Get

Fields

• getPath :: [Text]

  URL path components

• getParams :: [(Text, Text)]

  Query params

POST

post :: Session -> ApiSecretKey -> Post -> IO WreqResponse

post' :: Session -> ApiSecretKey -> RequestApiVersion -> Post -> IO WreqResponse

data Post

Constructors

Post

Fields

• postPath :: [Text]

  URL path components

• postParams :: [FormParam]

  Parameters to send in the request body

DELETE

delete :: Session -> ApiSecretKey -> Delete -> IO WreqResponse

delete' :: Session -> ApiSecretKey -> RequestApiVersion -> Delete -> IO WreqResponse

data Delete

Constructors

Delete

Fields

• deletePath :: [Text]

  URL path components

• deleteParams :: [(Text, Text)]

  Query params

Response

type WreqResponse = Response ByteString

data Response

Constructors

Response

Fields

• responseBody :: Either Text Value

  Every Stripe response should have a JSON body; but if not, this will be a Left value with an error message from the JSON parser.

• responseCode :: StatusCode

  The status code of the HTTP response.

wreqResponse :: WreqResponse -> Response

Convert a WreqResponse into a Response by parsing the JSON response body (the Stripe API always returns JSON) and getting the HTTP status code.

responseValue :: Response -> Either Error Value

Interpret a response, returning Right with the parsed JSON payload if everything is okay, or Left with an error if the response contains any indication that something went wrong.

responseValueError :: Value -> Error

If the response object looks like this:

{
  "error": {
      "type": "card_error",
      "message": "..."
    }
  }
}

then we use the value of the message field as a UserMessage. Otherwise it is a LogMessage.

"message: A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. [...] Card errors are the most common type of error you should expect to handle. They result when the user enters a card that can't be charged for some reason." - Stripe

Error

data Error

Constructors

Error

Fields

• userMessages :: [UserMessage]
• logMessages :: [LogMessage]

Instances

Monoid Error

Defined in Stripe.Wreq

Methods

mempty :: Error

mappend :: Error -> Error -> Error

mconcat :: [Error] -> Error

Semigroup Error

Defined in Stripe.Wreq

Methods

(<>) :: Error -> Error -> Error

sconcat :: NonEmpty Error -> Error

stimes :: Integral b => b -> Error -> Error

Exception Error

Defined in Stripe.Wreq

Methods

toException :: Error -> SomeException

fromException :: SomeException -> Maybe Error

displayException :: Error -> String

Show Error

Defined in Stripe.Wreq

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

Eq Error

Defined in Stripe.Wreq

Methods

(==) :: Error -> Error -> Bool

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

newtype UserMessage

An error message suitable for being shown to a user.

Constructors

UserMessage Text

Instances

Show UserMessage

Defined in Stripe.Wreq

Methods

showsPrec :: Int -> UserMessage -> ShowS

show :: UserMessage -> String

showList :: [UserMessage] -> ShowS

Eq UserMessage

Defined in Stripe.Wreq

Methods

(==) :: UserMessage -> UserMessage -> Bool

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

newtype LogMessage

An error message that should go into an error log, not shown to a user.

Constructors

LogMessage Text

Instances

Show LogMessage

Defined in Stripe.Wreq

Methods

showsPrec :: Int -> LogMessage -> ShowS

show :: LogMessage -> String

showList :: [LogMessage] -> ShowS

Eq LogMessage

Defined in Stripe.Wreq

Methods

(==) :: LogMessage -> LogMessage -> Bool

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

userError

Arguments

:: Text

An error message intended to be shown to a user.

-> Error

logError

Arguments

:: Text

An error message intended to go into a log file, not to be shown to a user.

-> Error

Status code

newtype StatusCode

An HTTP status code returned by Stripe.

"Stripe uses conventional HTTP response codes to indicate the success or failure of an API request." - Stripe

Constructors

StatusCode Int

Instances

Eq StatusCode

Defined in Stripe.Wreq

Methods

(==) :: StatusCode -> StatusCode -> Bool

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

Predicates

Some basic functions for interpreting status codes.

isSuccess :: StatusCode -> Bool

"Codes in the 2xx range indicate success." - Stripe

isError :: StatusCode -> Bool

isError x is equivalent to isClientError x || isServerError x.

isClientError :: StatusCode -> Bool

"Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.)." - Stripe

isServerError :: StatusCode -> Bool

"Codes in the 5xx range indicate an error with Stripe's servers." - Stripe

Client error codes

Constants for each of the error codes enumerated in the Stripe API documentation, for your convenience.

badRequest400 :: StatusCode

400 - Bad Request

"The request was unacceptable, often due to missing a required parameter." - Stripe

unauthorized401 :: StatusCode

401 - Unauthorized

"No valid API key provided." - Stripe

requestFailed402 :: StatusCode

402 - Request Failed

"The parameters were valid but the request failed." - Stripe

notFound404 :: StatusCode

404 - Not Found

"The requested resource doesn't exist." - Stripe

conflict409 :: StatusCode

409 - Conflict

"The request conflicts with another request (perhaps due to using the same idempotent key)." - Stripe

tooManyRequests429 :: StatusCode

429 - Too Many Requests

"Too many requests hit the API too quickly. We recommend an exponential backoff of your requests." - Stripe

Re-exports from Wreq

data FormParam where

A key/value pair for an application/x-www-form-urlencoded POST request body.

Constructors

(:=) :: forall v. FormValue v => ByteString -> v -> FormParam infixr 3

Instances

Show FormParam

Defined in Network.Wreq.Internal.Types

Methods

showsPrec :: Int -> FormParam -> ShowS

show :: FormParam -> String

showList :: [FormParam] -> ShowS

data Session

A session that spans multiple requests. This is responsible for cookie management and TCP connection reuse.

Instances

Show Session

Defined in Network.Wreq.Internal.Types

Methods

showsPrec :: Int -> Session -> ShowS

show :: Session -> String

showList :: [Session] -> ShowS

newAPISession :: IO Session

Create a session.

This uses the default session manager settings, but does not manage cookies. It is intended for use with REST-like HTTP-based APIs, which typically do not use cookies.

Since: wreq-0.5.2.0