Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation getEvents
Synopsis
- getEvents :: forall m. MonadHTTP m => GetEventsParameters -> StripeT m (Response GetEventsResponse)
- data GetEventsParameters = GetEventsParameters {
- getEventsParametersQueryCreated :: Maybe GetEventsParametersQueryCreated'Variants
- getEventsParametersQueryDeliverySuccess :: Maybe Bool
- getEventsParametersQueryEndingBefore :: Maybe Text
- getEventsParametersQueryExpand :: Maybe [Text]
- getEventsParametersQueryLimit :: Maybe Int
- getEventsParametersQueryStartingAfter :: Maybe Text
- getEventsParametersQueryType :: Maybe Text
- getEventsParametersQueryTypes :: Maybe [Text]
- mkGetEventsParameters :: GetEventsParameters
- data GetEventsParametersQueryCreated'OneOf1 = GetEventsParametersQueryCreated'OneOf1 {}
- mkGetEventsParametersQueryCreated'OneOf1 :: GetEventsParametersQueryCreated'OneOf1
- data GetEventsParametersQueryCreated'Variants
- data GetEventsResponse
- data GetEventsResponseBody200 = GetEventsResponseBody200 {}
- mkGetEventsResponseBody200 :: [Event] -> Bool -> Text -> GetEventsResponseBody200
Documentation
:: forall m. MonadHTTP m | |
=> GetEventsParameters | Contains all available parameters of this operation (query and path parameters) |
-> StripeT m (Response GetEventsResponse) | Monadic computation which returns the result of the operation |
GET /v1/events
<p>List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in <a href="/docs/api/events/object">event object</a> <code>api_version</code> attribute (not according to your current Stripe API version or <code>Stripe-Version</code> header).</p>
data GetEventsParameters Source #
Defines the object schema located at paths./v1/events.GET.parameters
in the specification.
GetEventsParameters | |
|
Instances
Eq GetEventsParameters Source # | |
Defined in StripeAPI.Operations.GetEvents (==) :: GetEventsParameters -> GetEventsParameters -> Bool # (/=) :: GetEventsParameters -> GetEventsParameters -> Bool # | |
Show GetEventsParameters Source # | |
Defined in StripeAPI.Operations.GetEvents showsPrec :: Int -> GetEventsParameters -> ShowS # show :: GetEventsParameters -> String # showList :: [GetEventsParameters] -> ShowS # | |
ToJSON GetEventsParameters Source # | |
Defined in StripeAPI.Operations.GetEvents toJSON :: GetEventsParameters -> Value # toEncoding :: GetEventsParameters -> Encoding # toJSONList :: [GetEventsParameters] -> Value # toEncodingList :: [GetEventsParameters] -> Encoding # | |
FromJSON GetEventsParameters Source # | |
Defined in StripeAPI.Operations.GetEvents parseJSON :: Value -> Parser GetEventsParameters # parseJSONList :: Value -> Parser [GetEventsParameters] # |
mkGetEventsParameters :: GetEventsParameters Source #
Create a new GetEventsParameters
with all required fields.
data GetEventsParametersQueryCreated'OneOf1 Source #
Defines the object schema located at paths./v1/events.GET.parameters.properties.queryCreated.anyOf
in the specification.
mkGetEventsParametersQueryCreated'OneOf1 :: GetEventsParametersQueryCreated'OneOf1 Source #
Create a new GetEventsParametersQueryCreated'OneOf1
with all required fields.
data GetEventsParametersQueryCreated'Variants Source #
Defines the oneOf schema located at paths./v1/events.GET.parameters.properties.queryCreated.anyOf
in the specification.
Represents the parameter named 'created'
GetEventsParametersQueryCreated'GetEventsParametersQueryCreated'OneOf1 GetEventsParametersQueryCreated'OneOf1 | |
GetEventsParametersQueryCreated'Int Int |
data GetEventsResponse Source #
Represents a response of the operation getEvents
.
The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), GetEventsResponseError
is used.
GetEventsResponseError String | Means either no matching case available or a parse error |
GetEventsResponse200 GetEventsResponseBody200 | Successful response. |
GetEventsResponseDefault Error | Error response. |
Instances
Eq GetEventsResponse Source # | |
Defined in StripeAPI.Operations.GetEvents (==) :: GetEventsResponse -> GetEventsResponse -> Bool # (/=) :: GetEventsResponse -> GetEventsResponse -> Bool # | |
Show GetEventsResponse Source # | |
Defined in StripeAPI.Operations.GetEvents showsPrec :: Int -> GetEventsResponse -> ShowS # show :: GetEventsResponse -> String # showList :: [GetEventsResponse] -> ShowS # |
data GetEventsResponseBody200 Source #
Defines the object schema located at paths./v1/events.GET.responses.200.content.application/json.schema
in the specification.
GetEventsResponseBody200 | |
|
Instances
Eq GetEventsResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetEvents | |
Show GetEventsResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetEvents showsPrec :: Int -> GetEventsResponseBody200 -> ShowS # show :: GetEventsResponseBody200 -> String # showList :: [GetEventsResponseBody200] -> ShowS # | |
ToJSON GetEventsResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetEvents | |
FromJSON GetEventsResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetEvents |
mkGetEventsResponseBody200 Source #
:: [Event] | |
-> Bool | |
-> Text | |
-> GetEventsResponseBody200 |
Create a new GetEventsResponseBody200
with all required fields.