Struct EventsList

pub struct EventsList<'a> { /* private fields */ }

Request builder for querying Paddle for events.

Implementations

impl<'a> EventsList<'a>

pub fn new(client: &'a Paddle) -> Self

pub fn after(&mut self, report_id: impl Into<PaddleID>) -> &mut Self

Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.

pub fn order_by_asc(&mut self, field: &str) -> &mut Self

Order returned entities by the specified field. Valid fields for ordering: id

pub fn order_by_desc(&mut self, field: &str) -> &mut Self

Order returned entities by the specified field. Valid fields for ordering: id

pub fn per_page(&mut self, entities_per_page: usize) -> &mut Self

Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.

Default: 50; Maximum: 200.

pub fn send(&self) -> Paginated<'_, Vec<Event>>

Returns a paginator for fetching pages of entities from Paddle

Trait Implementations

impl<'a> Serialize for EventsList<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.