public static final class EventService.EventListRequest<S> extends ListRequest<S,Event>
Request class for EventService.list().
Returns a cursor-paginated list of your events.
| Modifier and Type | Class and Description |
|---|---|
static class |
EventService.EventListRequest.CreatedAt |
static class |
EventService.EventListRequest.Include |
static class |
EventService.EventListRequest.ResourceType |
ListRequest.ListRequestExecutor<S,T>| Modifier and Type | Method and Description |
|---|---|
EventService.EventListRequest<S> |
withAction(java.lang.String action)
Limit to events with a given
action. |
EventService.EventListRequest<S> |
withAfter(java.lang.String after)
Cursor pointing to the start of the desired set.
|
EventService.EventListRequest<S> |
withBefore(java.lang.String before)
Cursor pointing to the end of the desired set.
|
EventService.EventListRequest<S> |
withCreatedAt(EventService.EventListRequest.CreatedAt createdAt) |
EventService.EventListRequest<S> |
withCreatedAtGt(java.lang.String gt)
Limit to records created after the specified date-time.
|
EventService.EventListRequest<S> |
withCreatedAtGte(java.lang.String gte)
Limit to records created on or after the specified date-time.
|
EventService.EventListRequest<S> |
withCreatedAtLt(java.lang.String lt)
Limit to records created before the specified date-time.
|
EventService.EventListRequest<S> |
withCreatedAtLte(java.lang.String lte)
Limit to records created on or before the specified date-time.
|
EventService.EventListRequest<S> |
withHeader(java.lang.String headerName,
java.lang.String headerValue) |
EventService.EventListRequest<S> |
withInclude(EventService.EventListRequest.Include include)
Includes linked resources in the response.
|
EventService.EventListRequest<S> |
withLimit(java.lang.Integer limit)
Number of records to return.
|
EventService.EventListRequest<S> |
withMandate(java.lang.String mandate)
ID of a mandate.
|
EventService.EventListRequest<S> |
withParentEvent(java.lang.String parentEvent)
ID of an event.
|
EventService.EventListRequest<S> |
withPayment(java.lang.String payment)
ID of a payment.
|
EventService.EventListRequest<S> |
withPayout(java.lang.String payout)
ID of a payout.
|
EventService.EventListRequest<S> |
withRefund(java.lang.String refund)
ID of a refund.
|
EventService.EventListRequest<S> |
withResourceType(EventService.EventListRequest.ResourceType resourceType)
Type of resource that you’d like to get all events for.
|
EventService.EventListRequest<S> |
withSubscription(java.lang.String subscription)
ID of a subscription.
|
execute, executeWrapped, iteratingExecutor, pagingExecutorpublic EventService.EventListRequest<S> withAction(java.lang.String action)
Limit to events with a given action.
public EventService.EventListRequest<S> withAfter(java.lang.String after)
Cursor pointing to the start of the desired set.
public EventService.EventListRequest<S> withBefore(java.lang.String before)
Cursor pointing to the end of the desired set.
public EventService.EventListRequest<S> withCreatedAt(EventService.EventListRequest.CreatedAt createdAt)
public EventService.EventListRequest<S> withCreatedAtGt(java.lang.String gt)
Limit to records created after the specified date-time.
public EventService.EventListRequest<S> withCreatedAtGte(java.lang.String gte)
Limit to records created on or after the specified date-time.
public EventService.EventListRequest<S> withCreatedAtLt(java.lang.String lt)
Limit to records created before the specified date-time.
public EventService.EventListRequest<S> withCreatedAtLte(java.lang.String lte)
Limit to records created on or before the specified date-time.
public EventService.EventListRequest<S> withInclude(EventService.EventListRequest.Include include)
Includes linked resources in the response. Must be used with the resource_type parameter specified. The include should be one of:
paymentmandatepayoutrefundsubscriptionpublic EventService.EventListRequest<S> withLimit(java.lang.Integer limit)
Number of records to return.
public EventService.EventListRequest<S> withMandate(java.lang.String mandate)
ID of a mandate. If specified, this endpoint will return all events for the given mandate.
public EventService.EventListRequest<S> withParentEvent(java.lang.String parentEvent)
ID of an event. If specified, this endpint will return all events whose parent_event is the given event ID.
public EventService.EventListRequest<S> withPayment(java.lang.String payment)
ID of a payment. If specified, this endpoint will return all events for the given payment.
public EventService.EventListRequest<S> withPayout(java.lang.String payout)
ID of a payout. If specified, this endpoint will return all events for the given payout.
public EventService.EventListRequest<S> withRefund(java.lang.String refund)
ID of a refund. If specified, this endpoint will return all events for the given refund.
public EventService.EventListRequest<S> withResourceType(EventService.EventListRequest.ResourceType resourceType)
Type of resource that you’d like to get all events for. Cannot be used together with the payment, mandate, subscription, refund or payout parameter. The type can be one of:
paymentsmandatespayoutssubscriptionsrefundspublic EventService.EventListRequest<S> withSubscription(java.lang.String subscription)
ID of a subscription. If specified, this endpoint will return all events for the given subscription.
public EventService.EventListRequest<S> withHeader(java.lang.String headerName, java.lang.String headerValue)