Struct stripe::ListEvents

pub struct ListEvents<'a> {
    pub created: Option<RangeQuery<Timestamp>>,
    pub delivery_success: Option<bool>,
    pub ending_before: Option<EventId>,
    pub expand: &'a [&'a str],
    pub limit: Option<u64>,
    pub starting_after: Option<EventId>,
    pub type_: Option<&'a str>,
    pub types: Option<Vec<String>>,
}

The parameters for Event::list.

Fields

created: Option<RangeQuery<Timestamp>>

delivery_success: Option<bool>

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.

ending_before: Option<EventId>

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.

expand: &'a [&'a str]

Specifies which fields in the response should be expanded.

limit: Option<u64>

A limit on the number of objects to be returned.

Limit can range between 1 and 100, and the default is 10.

starting_after: Option<EventId>

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_: Option<&'a str>

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.

types: Option<Vec<String>>

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.

Implementations

impl<'a> ListEvents<'a>

pub fn new() -> Self

Trait Implementations

impl<'a> Clone for ListEvents<'a>

fn clone(&self) -> ListEvents<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for ListEvents<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for ListEvents<'a>

fn default() -> ListEvents<'a>

Returns the “default value” for a type.

impl<'a> Serialize for ListEvents<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.