Struct square_api_client::models::ListGiftCardsParameters

pub struct ListGiftCardsParameters {
    pub type: Option<GiftCardType>,
    pub state: Option<GiftCardStatus>,
    pub limit: Option<i32>,
    pub cursor: Option<String>,
    pub customer_id: Option<String>,
}

This is a model struct for ListGiftCardsParameters (query parameters)

Fields

type: Option<GiftCardType>

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

state: Option<GiftCardStatus>

If a state is provided, the endpoint returns the gift cards in the specified state. Otherwise, the endpoint returns the gift cards of all states.

limit: Option<i32>

If a limit is provided, the endpoint returns only the specified number of results per page. The maximum value is 50. The default value is 30. 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.

customer_id: Option<String>

If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer.

Implementations

impl ListGiftCardsParameters

pub fn to_query_string(&self) -> String

Trait Implementations

impl Clone for ListGiftCardsParameters

fn clone(&self) -> ListGiftCardsParameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListGiftCardsParameters

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

Formats the value using the given formatter.

impl Default for ListGiftCardsParameters

fn default() -> ListGiftCardsParameters

Returns the “default value” for a type.

impl From<ListGiftCardsParameters> for String

fn from(list_gift_cards_parameters: ListGiftCardsParameters) -> Self

Converts to this type from the input type.

impl ToString for ListGiftCardsParameters

fn to_string(&self) -> String

Converts the given value to a String.