Struct square_api_client::models::ListGiftCardActivitiesParameters

pub struct ListGiftCardActivitiesParameters {
    pub gift_card_id: Option<String>,
    pub type: Option<GiftCardActivityType>,
    pub location_id: Option<String>,
    pub begin_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub limit: Option<i32>,
    pub cursor: Option<String>,
    pub sort_order: Option<SortOrder>,
}

This is a model struct for ListGiftCardActivitiesParameters (query parameters)

Fields

gift_card_id: Option<String>

If a gift card ID is provided, the endpoint returns activities related to the specified gift card. Otherwise, the endpoint returns all gift card activities for the seller.

type: Option<GiftCardActivityType>

If a type is provided, the endpoint returns gift card activities of the specified type. Otherwise, the endpoint returns all types of gift card activities.

location_id: Option<String>

If a location ID is provided, the endpoint returns gift card activities for the specified location. Otherwise, the endpoint returns gift card activities for all locations.

begin_time: Option<DateTime>

The timestamp for the beginning of the reporting period, in RFC 3339 format. This start time is inclusive. The default value is the current time minus one year.

end_time: Option<DateTime>

The timestamp for the end of the reporting period, in RFC 3339 format. This end time is inclusive. The default value is the current time.

limit: Option<i32>

If a limit is provided, the endpoint returns the specified number of results (or fewer) per page. The maximum value is 100. The default value is 50. For more information, see Pagination.

cursor: Option<String>

A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. If a cursor is not provided, the endpoint returns the first page of the results. For more information, see Pagination.

sort_order: Option<SortOrder>

The order in which the endpoint returns the activities, based on created_at.

• ASC - Oldest to newest.
• DESC - Newest to oldest (default).

Implementations

impl ListGiftCardActivitiesParameters

pub fn to_query_string(&self) -> String

Trait Implementations

impl Clone for ListGiftCardActivitiesParameters

fn clone(&self) -> ListGiftCardActivitiesParameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListGiftCardActivitiesParameters

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

Formats the value using the given formatter.

impl Default for ListGiftCardActivitiesParameters

fn default() -> ListGiftCardActivitiesParameters

Returns the “default value” for a type.

impl From<ListGiftCardActivitiesParameters> for String

fn from(
    list_gift_card_activities_parameters: ListGiftCardActivitiesParameters
) -> Self

Converts to this type from the input type.

impl ToString for ListGiftCardActivitiesParameters

fn to_string(&self) -> String

Converts the given value to a String.