Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation getEvents
Synopsis
- getEvents :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetEventsRequestBody -> m (Either HttpException (Response GetEventsResponse))
- getEventsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetEventsRequestBody -> m (Either HttpException (Response ByteString))
- getEventsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetEventsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetEventsResponse))
- getEventsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetEventsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetEventsRequestBody = GetEventsRequestBody {
- data GetEventsResponse
- data GetEventsResponseBody200 = GetEventsResponseBody200 {}
- data GetEventsResponseBody200Object'
Documentation
:: (MonadHTTP m, SecurityScheme s) | |
=> Configuration s | The configuration to use in the request |
-> Maybe Text | created |
-> Maybe Bool | delivery_success: Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned. |
-> Maybe Text | ending_before: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. | Constraints: Maximum length of 5000 |
-> Maybe Text | expand: Specifies which fields in the response should be expanded. |
-> Maybe Integer | limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
-> Maybe Text | starting_after: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. | Constraints: Maximum length of 5000 |
-> Maybe Text | type: A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property. | Constraints: Maximum length of 5000 |
-> Maybe Text | types: An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both. |
-> Maybe GetEventsRequestBody | The request body to send |
-> m (Either HttpException (Response GetEventsResponse)) | Monad containing 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>
getEventsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetEventsRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/events
The same as getEvents
but returns the raw ByteString
getEventsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetEventsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetEventsResponse)) Source #
GET /v1/events
Monadic version of getEvents
(use with runWithConfiguration
)
getEventsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetEventsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/events
Monadic version of getEventsRaw
(use with runWithConfiguration
)
data GetEventsRequestBody Source #
Defines the data type for the schema getEventsRequestBody
Instances
Eq GetEventsRequestBody Source # | |
Defined in StripeAPI.Operations.GetEvents (==) :: GetEventsRequestBody -> GetEventsRequestBody -> Bool # (/=) :: GetEventsRequestBody -> GetEventsRequestBody -> Bool # | |
Show GetEventsRequestBody Source # | |
Defined in StripeAPI.Operations.GetEvents showsPrec :: Int -> GetEventsRequestBody -> ShowS # show :: GetEventsRequestBody -> String # showList :: [GetEventsRequestBody] -> ShowS # | |
ToJSON GetEventsRequestBody Source # | |
Defined in StripeAPI.Operations.GetEvents toJSON :: GetEventsRequestBody -> Value # toEncoding :: GetEventsRequestBody -> Encoding # toJSONList :: [GetEventsRequestBody] -> Value # toEncodingList :: [GetEventsRequestBody] -> Encoding # | |
FromJSON GetEventsRequestBody Source # | |
Defined in StripeAPI.Operations.GetEvents parseJSON :: Value -> Parser GetEventsRequestBody # parseJSONList :: Value -> Parser [GetEventsRequestBody] # |
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 data type for the schema GetEventsResponseBody200
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 |
data GetEventsResponseBody200Object' Source #
Defines the enum schema GetEventsResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
GetEventsResponseBody200Object'EnumOther Value | |
GetEventsResponseBody200Object'EnumTyped Text | |
GetEventsResponseBody200Object'EnumStringList |