stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetEvents

Description

Contains the different functions to run the operation getEvents

Synopsis

Documentation

getEvents Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> Maybe String

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 String

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 String

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 String

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 String

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 String

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.

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

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.

Constructors

GetEventsResponseError String

Means either no matching case available or a parse error

GetEventsResponse200 GetEventsResponseBody200

Successful response.

GetEventsResponseDefault Error

Error response.

data GetEventsResponseBody200 Source #

Defines the data type for the schema GetEventsResponseBody200

Constructors

GetEventsResponseBody200 

Fields

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`.