| java.lang.Object |
| ↳ |
com.wsl.modules.stripe.client.StripeEventClient |
Class Overview
Encapsulates Event-related Stripe API calls.
Summary
| Public Methods |
|---|
|
EventCollection
|
listAllEvents(String createdTimestamp, TimeRange created, String endingBefore, int limit, String startingAfter, String type)
List All Events
List events, going back up to 30 days.
|
|
Event
|
retrieveEvent(String id)
Retrieve a Event
Retrieves the Event with the given ID
|
|
[Expand]
Inherited Methods |
|---|
From class
java.lang.Object
|
Object
|
clone()
|
|
boolean
|
equals(Object arg0)
|
|
void
|
finalize()
|
|
final
Class<?>
|
getClass()
|
|
int
|
hashCode()
|
|
final
void
|
notify()
|
|
final
void
|
notifyAll()
|
|
String
|
toString()
|
|
final
void
|
wait()
|
|
final
void
|
wait(long arg0, int arg1)
|
|
final
void
|
wait(long arg0)
|
|
Public Constructors
public
StripeEventClient
()
Public Methods
public
EventCollection
listAllEvents
(String createdTimestamp, TimeRange created, String endingBefore, int limit, String startingAfter, String type)
List All Events
List events, going back up to 30 days.
Parameters
| createdTimestamp
| A filter on the list based on the object created field. The value can be a string with an integer Unix timestamp |
| created
| Or it can be a dictionary with the following options: gt, gte, lt, lte |
| endingBefore
| 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. |
| limit
| A limit on the number of objects to be returned. Limit can range between 1 and 100 items. |
| startingAfter
| 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. |
| 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 |
Returns
- A Map with a data property that contains an array of up to limit events, starting after event starting_after, sorted in reverse chronological order. Each entry in the array is a separate event object. If no more events are available, the resulting array will be empty. This request should never throw an error.
public
Event
retrieveEvent
(String id)
Retrieve a Event
Retrieves the Event with the given ID
Parameters
| id
| The ID of the desired event |
Returns
- Returns a event if a valid ID was provided. Throws an error otherwise.
