StripeAPI.Operations.GetEvents

Contains the different functions to run the operation getEvents

Documentation

getEvents

Arguments

:: forall m. MonadHTTP m

=> GetEventsParameters

Contains all available parameters of this operation (query and path parameters)

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

Defines the object schema located at paths./v1/events.GET.parameters in the specification.

Constructors

GetEventsParameters

Fields

• getEventsParametersQueryCreated :: Maybe GetEventsParametersQueryCreated'Variants

  queryCreated: Represents the parameter named 'created'

• getEventsParametersQueryDeliverySuccess :: Maybe Bool

  queryDelivery_success: Represents the parameter named '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.

• getEventsParametersQueryEndingBefore :: Maybe Text

  queryEnding_before: Represents the parameter named '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
• getEventsParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

• getEventsParametersQueryLimit :: Maybe Int

  queryLimit: Represents the parameter named 'limit'

  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

• getEventsParametersQueryStartingAfter :: Maybe Text

  queryStarting_after: Represents the parameter named '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
• getEventsParametersQueryType :: Maybe Text

  queryType: Represents the parameter named '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
• getEventsParametersQueryTypes :: Maybe [Text]

  queryTypes: Represents the parameter named '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.

Instances

Eq GetEventsParameters

Defined in StripeAPI.Operations.GetEvents

Methods

(==) :: GetEventsParameters -> GetEventsParameters -> Bool

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

Show GetEventsParameters

Defined in StripeAPI.Operations.GetEvents

Methods

showsPrec :: Int -> GetEventsParameters -> ShowS

show :: GetEventsParameters -> String

showList :: [GetEventsParameters] -> ShowS

ToJSON GetEventsParameters

Defined in StripeAPI.Operations.GetEvents

Methods

toJSON :: GetEventsParameters -> Value

toEncoding :: GetEventsParameters -> Encoding

toJSONList :: [GetEventsParameters] -> Value

toEncodingList :: [GetEventsParameters] -> Encoding

FromJSON GetEventsParameters

Defined in StripeAPI.Operations.GetEvents

Methods

parseJSON :: Value -> Parser GetEventsParameters

parseJSONList :: Value -> Parser [GetEventsParameters]

mkGetEventsParameters :: GetEventsParameters

Create a new GetEventsParameters with all required fields.

data GetEventsParametersQueryCreated'OneOf1

Defines the object schema located at paths./v1/events.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

GetEventsParametersQueryCreated'OneOf1

Fields

• getEventsParametersQueryCreated'OneOf1Gt :: Maybe Int

  gt

• getEventsParametersQueryCreated'OneOf1Gte :: Maybe Int

  gte

• getEventsParametersQueryCreated'OneOf1Lt :: Maybe Int

  lt

• getEventsParametersQueryCreated'OneOf1Lte :: Maybe Int

  lte

Instances

Eq GetEventsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetEvents

Methods

(==) :: GetEventsParametersQueryCreated'OneOf1 -> GetEventsParametersQueryCreated'OneOf1 -> Bool

(/=) :: GetEventsParametersQueryCreated'OneOf1 -> GetEventsParametersQueryCreated'OneOf1 -> Bool

Show GetEventsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetEvents

Methods

showsPrec :: Int -> GetEventsParametersQueryCreated'OneOf1 -> ShowS

show :: GetEventsParametersQueryCreated'OneOf1 -> String

showList :: [GetEventsParametersQueryCreated'OneOf1] -> ShowS

ToJSON GetEventsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetEvents

Methods

toJSON :: GetEventsParametersQueryCreated'OneOf1 -> Value

toEncoding :: GetEventsParametersQueryCreated'OneOf1 -> Encoding

toJSONList :: [GetEventsParametersQueryCreated'OneOf1] -> Value

toEncodingList :: [GetEventsParametersQueryCreated'OneOf1] -> Encoding

FromJSON GetEventsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetEvents

Methods

parseJSON :: Value -> Parser GetEventsParametersQueryCreated'OneOf1

parseJSONList :: Value -> Parser [GetEventsParametersQueryCreated'OneOf1]

mkGetEventsParametersQueryCreated'OneOf1 :: GetEventsParametersQueryCreated'OneOf1

Create a new GetEventsParametersQueryCreated'OneOf1 with all required fields.

data GetEventsParametersQueryCreated'Variants

Defines the oneOf schema located at paths./v1/events.GET.parameters.properties.queryCreated.anyOf in the specification.

Represents the parameter named 'created'

Constructors

GetEventsParametersQueryCreated'GetEventsParametersQueryCreated'OneOf1 GetEventsParametersQueryCreated'OneOf1

GetEventsParametersQueryCreated'Int Int

Instances

Eq GetEventsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetEvents

Methods

(==) :: GetEventsParametersQueryCreated'Variants -> GetEventsParametersQueryCreated'Variants -> Bool

(/=) :: GetEventsParametersQueryCreated'Variants -> GetEventsParametersQueryCreated'Variants -> Bool

Show GetEventsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetEvents

Methods

showsPrec :: Int -> GetEventsParametersQueryCreated'Variants -> ShowS

show :: GetEventsParametersQueryCreated'Variants -> String

showList :: [GetEventsParametersQueryCreated'Variants] -> ShowS

ToJSON GetEventsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetEvents

Methods

toJSON :: GetEventsParametersQueryCreated'Variants -> Value

toEncoding :: GetEventsParametersQueryCreated'Variants -> Encoding

toJSONList :: [GetEventsParametersQueryCreated'Variants] -> Value

toEncodingList :: [GetEventsParametersQueryCreated'Variants] -> Encoding

FromJSON GetEventsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetEvents

Methods

parseJSON :: Value -> Parser GetEventsParametersQueryCreated'Variants

parseJSONList :: Value -> Parser [GetEventsParametersQueryCreated'Variants]

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 object schema located at paths./v1/events.GET.responses.200.content.application/json.schema in the specification.

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.

• getEventsResponseBody200Url :: Text

  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]

mkGetEventsResponseBody200

Arguments

:: [Event]

getEventsResponseBody200Data

-> Bool

getEventsResponseBody200HasMore

-> Text

getEventsResponseBody200Url

-> GetEventsResponseBody200

Create a new GetEventsResponseBody200 with all required fields.