com.squareup.square.models

Class ListGiftCardsRequest

java.lang.Object

com.squareup.square.models.ListGiftCardsRequest

public class ListGiftCardsRequest
extends Object

This is a model class for ListGiftCardsRequest type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListGiftCardsRequest.Builder Class to build instances of ListGiftCardsRequest.

Constructor Summary

Constructors

Constructor and Description
ListGiftCardsRequest(String type, String state, Integer limit, String cursor, String customerId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCursor() Getter for Cursor.
String	getCustomerId() Getter for CustomerId.
Integer	getLimit() Getter for Limit.
String	getState() Getter for State.
String	getType() Getter for Type.
int	hashCode()
ListGiftCardsRequest.Builder	toBuilder() Builds a new ListGiftCardsRequest.Builder object.
String	toString() Converts this ListGiftCardsRequest into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListGiftCardsRequest

public ListGiftCardsRequest(String type,
                            String state,
                            Integer limit,
                            String cursor,
                            String customerId)

Initialization constructor.

Parameters:

type - String value for type.

state - String value for state.

limit - Integer value for limit.

cursor - String value for cursor.

customerId - String value for customerId.

Method Detail

getType

public String getType()

Getter for Type. If a [type]($m/GiftCardType) is provided, the endpoint returns gift cards of the specified type. Otherwise, the endpoint returns gift cards of all types.

Returns:

Returns the String

getState

public String getState()

Getter for State. If a [state]($m/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state. Otherwise, the endpoint returns the gift cards of all states.

Returns:

Returns the String

getLimit

public Integer getLimit()

Getter for Limit. 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](https://developer.squareup.com/docs/working-with-apis/pagination).

Returns:

Returns the Integer

getCursor

public String getCursor()

Getter for Cursor. 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](https://developer.squareup.com/docs/working-with-apis/pagination).

Returns:

Returns the String

getCustomerId

public String getCustomerId()

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

Returns:

Returns the String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this ListGiftCardsRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ListGiftCardsRequest.Builder toBuilder()

Builds a new ListGiftCardsRequest.Builder object. Creates the instance with the state of the current model.

Returns:

a new ListGiftCardsRequest.Builder object