Struct paypal_rs::Query

pub struct Query {
    pub count: Option<i32>,
    pub end_time: Option<DateTime<Utc>>,
    pub page: Option<i32>,
    pub page_size: Option<i32>,
    pub total_count_required: Option<bool>,
    pub sort_by: Option<String>,
    pub sort_order: Option<String>,
    pub start_id: Option<String>,
    pub start_index: Option<i32>,
    pub start_time: Option<DateTime<Utc>>,
}

Represents the query used in most GET api requests.

Reference: https://developer.paypal.com/docs/api/reference/api-requests/#query-parameters

Note: You can avoid most fields by the Default impl like so:

let query = Query { count: Some(40), ..Default::default() };

Fields

count: Option<i32>

The number of items to list in the response.

end_time: Option<DateTime<Utc>>

The end date and time for the range to show in the response.

page: Option<i32>

The page number indicating which set of items will be returned in the response. So, the combination of page=1 and page_size=20 returns the first 20 items. The combination of page=2 and page_size=20 returns items 21 through 40.

page_size: Option<i32>

The number of items to return in the response.

total_count_required: Option<bool>

Indicates whether to show the total count in the response.

sort_by: Option<String>

Sorts the payments in the response by a specified value, such as the create time or update time.

sort_order: Option<String>

Sorts the items in the response in ascending or descending order.

start_id: Option<String>

The ID of the starting resource in the response. When results are paged, you can use the next_id value as the start_id to continue with the next set of results.

start_index: Option<i32>

The start index of the payments to list. Typically, you use the start_index to jump to a specific position in the resource history based on its cart. For example, to start at the second item in a list of results, specify start_index=2.

start_time: Option<DateTime<Utc>>

The start date and time for the range to show in the response.

Trait Implementations

impl Debug for Query

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

Formats the value using the given formatter.

impl Default for Query

fn default() -> Query

Returns the "default value" for a type.

impl Serialize for Query

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

Serialize this value into the given Serde serializer.