Struct CustomersList

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

Request builder for fetching customers from Paddle API.

Implementations

impl<'a> CustomersList<'a>

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

pub fn after(&mut self, customer_id: impl Into<CustomerID>) -> &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 emails( &mut self, emails: impl IntoIterator<Item = impl AsRef<str>>, ) -> &mut Self

Return entities that exactly match the specified email addresses

pub fn ids( &mut self, customer_ids: impl IntoIterator<Item = impl Into<CustomerID>>, ) -> &mut Self

Return only the IDs specified.

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 search(&mut self, term: impl Into<String>) -> &mut Self

Return entities that match a search query. Searches id, name, and email fields. Use the email filter for precise matching of email addresses.

pub fn status(&mut self, status: Status) -> &mut Self

Return only prices with the specified status.

pub async fn send(&self) -> Result<SuccessResponse<Vec<Customer>>, Error>

Send the request to Paddle and return the response.

Trait Implementations

impl<'a> Serialize for CustomersList<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.