Struct TransactionsList

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

Request builder for fetching transactions from Paddle API.

Implementations

impl<'a> TransactionsList<'a>

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

pub fn after(&mut self, transaction_id: impl Into<TransactionID>) -> &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 billed_at(&mut self, date: DateTime<Utc>) -> &mut Self

Return entities billed at a specific time.

pub fn billed_at_lt(&mut self, date: DateTime<Utc>) -> &mut Self

Return entities billed before the specified time.

pub fn billed_at_lte(&mut self, date: DateTime<Utc>) -> &mut Self

Return entities billed before or on the specified time.

pub fn billed_at_gt(&mut self, date: DateTime<Utc>) -> &mut Self

Return entities billed after the specified time.

pub fn billed_at_gte(&mut self, date: DateTime<Utc>) -> &mut Self

Return entities billed after or on the specified time.

pub fn collection_mode(&mut self, mode: CollectionMode) -> &mut Self

Return entities that match the specified collection mode.

pub fn created_at(&mut self, date: DateTime<Utc>) -> &mut Self

Return entities created at a specific time.

pub fn created_at_lt(&mut self, date: DateTime<Utc>) -> &mut Self

Return entities created before the specified time.

pub fn created_at_lte(&mut self, date: DateTime<Utc>) -> &mut Self

Return entities created before or on the specified time.

pub fn created_at_gt(&mut self, date: DateTime<Utc>) -> &mut Self

Return entities created after the specified time.

pub fn created_at_gte(&mut self, date: DateTime<Utc>) -> &mut Self

Return entities created after or on the specified time.

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

Return entities related to the specified customers.

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

Return only the IDs specified.

pub fn include( &mut self, entities: impl IntoIterator<Item = impl AsRef<str>>, ) -> &mut Self

Include related entities in the response.

Valid values are:

• address
• adjustments
• adjustments_totals
• available_payment_methods
• business
• customer
• discount

pub fn invoice_numbers( &mut self, numbers: impl IntoIterator<Item = impl AsRef<str>>, ) -> &mut Self

Return entities that match the invoice number.

pub fn origin( &mut self, origins: impl IntoIterator<Item = TransactionOrigin>, ) -> &mut Self

Return entities related to the specified origin(s).

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

Order returned entities by the specified field. Valid fields for ordering: billed_at, created_at, id, updated_at

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

Order returned entities by the specified field. Valid fields for ordering: billed_at, created_at, id, updated_at

pub fn status( &mut self, statuses: impl IntoIterator<Item = TransactionStatus>, ) -> &mut Self

Return entities that match the specified status.

pub fn subscription_ids( &mut self, subscription_ids: impl IntoIterator<Item = impl Into<SubscriptionID>>, ) -> &mut Self

Return entities related to the specified subscription.

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 updated_at(&mut self, date: DateTime<Utc>) -> &mut Self

Return entities updated at a specific time.

pub fn updated_at_lt(&mut self, date: DateTime<Utc>) -> &mut Self

Return entities updated before the specified time.

pub fn updated_at_lte(&mut self, date: DateTime<Utc>) -> &mut Self

Return entities updated before or on the specified time.

pub fn updated_at_gt(&mut self, date: DateTime<Utc>) -> &mut Self

Return entities updated after the specified time.

pub fn updated_at_gte(&mut self, date: DateTime<Utc>) -> &mut Self

Return entities updated after or on the specified time.

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

Returns a paginator for fetching pages of entities from Paddle

Trait Implementations

impl<'a> Serialize for TransactionsList<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.