StripeAPI.Operations.GetEvents

Contains the different functions to run the operation getEvents

Documentation

getEvents

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>

getEventsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe Bool -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> GetEventsRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/events

The same as getEvents but returns the raw ByteString

getEventsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe Bool -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> GetEventsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetEventsResponse))

GET /v1/events

Monadic version of getEvents (use with runWithConfiguration)

getEventsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe Bool -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> GetEventsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/events

Monadic version of getEventsRaw (use with runWithConfiguration)

data GetEventsRequestBody

Defines the data type for the schema getEventsRequestBody

Constructors

GetEventsRequestBody

Instances

Eq GetEventsRequestBody

Defined in StripeAPI.Operations.GetEvents

Methods

(==) :: GetEventsRequestBody -> GetEventsRequestBody -> Bool

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

Show GetEventsRequestBody

Defined in StripeAPI.Operations.GetEvents

Methods

showsPrec :: Int -> GetEventsRequestBody -> ShowS

show :: GetEventsRequestBody -> String

showList :: [GetEventsRequestBody] -> ShowS

ToJSON GetEventsRequestBody

Defined in StripeAPI.Operations.GetEvents

Methods

toJSON :: GetEventsRequestBody -> Value

toEncoding :: GetEventsRequestBody -> Encoding

toJSONList :: [GetEventsRequestBody] -> Value

toEncodingList :: [GetEventsRequestBody] -> Encoding

FromJSON GetEventsRequestBody

Defined in StripeAPI.Operations.GetEvents

Methods

parseJSON :: Value -> Parser GetEventsRequestBody

parseJSONList :: Value -> Parser [GetEventsRequestBody]

data GetEventsResponse

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.

Instances

Eq GetEventsResponse

Defined in StripeAPI.Operations.GetEvents

Methods

(==) :: GetEventsResponse -> GetEventsResponse -> Bool

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

Show GetEventsResponse

Defined in StripeAPI.Operations.GetEvents

Methods

showsPrec :: Int -> GetEventsResponse -> ShowS

show :: GetEventsResponse -> String

showList :: [GetEventsResponse] -> ShowS

data GetEventsResponseBody200

Defines the data type for the schema GetEventsResponseBody200

Constructors

GetEventsResponseBody200

Fields

• getEventsResponseBody200Data :: [] Event

  data

• getEventsResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getEventsResponseBody200Object :: GetEventsResponseBody200Object'

  object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

• getEventsResponseBody200Url :: String

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/events'

Instances

Eq GetEventsResponseBody200

Defined in StripeAPI.Operations.GetEvents

Methods

(==) :: GetEventsResponseBody200 -> GetEventsResponseBody200 -> Bool

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

Show GetEventsResponseBody200

Defined in StripeAPI.Operations.GetEvents

Methods

showsPrec :: Int -> GetEventsResponseBody200 -> ShowS

show :: GetEventsResponseBody200 -> String

showList :: [GetEventsResponseBody200] -> ShowS

ToJSON GetEventsResponseBody200

Defined in StripeAPI.Operations.GetEvents

Methods

toJSON :: GetEventsResponseBody200 -> Value

toEncoding :: GetEventsResponseBody200 -> Encoding

toJSONList :: [GetEventsResponseBody200] -> Value

toEncodingList :: [GetEventsResponseBody200] -> Encoding

FromJSON GetEventsResponseBody200

Defined in StripeAPI.Operations.GetEvents

Methods

parseJSON :: Value -> Parser GetEventsResponseBody200

parseJSONList :: Value -> Parser [GetEventsResponseBody200]

data GetEventsResponseBody200Object'

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

Constructors

GetEventsResponseBody200Object'EnumOther Value

GetEventsResponseBody200Object'EnumTyped String

GetEventsResponseBody200Object'EnumStringList

Instances

Eq GetEventsResponseBody200Object'

Defined in StripeAPI.Operations.GetEvents

Methods

(==) :: GetEventsResponseBody200Object' -> GetEventsResponseBody200Object' -> Bool

(/=) :: GetEventsResponseBody200Object' -> GetEventsResponseBody200Object' -> Bool

Show GetEventsResponseBody200Object'

Defined in StripeAPI.Operations.GetEvents

Methods

showsPrec :: Int -> GetEventsResponseBody200Object' -> ShowS

show :: GetEventsResponseBody200Object' -> String

showList :: [GetEventsResponseBody200Object'] -> ShowS

ToJSON GetEventsResponseBody200Object'

Defined in StripeAPI.Operations.GetEvents

Methods

toJSON :: GetEventsResponseBody200Object' -> Value

toEncoding :: GetEventsResponseBody200Object' -> Encoding

toJSONList :: [GetEventsResponseBody200Object'] -> Value

toEncodingList :: [GetEventsResponseBody200Object'] -> Encoding

FromJSON GetEventsResponseBody200Object'

Defined in StripeAPI.Operations.GetEvents

Methods

parseJSON :: Value -> Parser GetEventsResponseBody200Object'

parseJSONList :: Value -> Parser [GetEventsResponseBody200Object']