com.squareup.square.models

Class ListGiftCardsResponse

java.lang.Object

com.squareup.square.models.ListGiftCardsResponse

public class ListGiftCardsResponse
extends Object

This is a model class for ListGiftCardsResponse type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ListGiftCardsResponse(List<Error> errors, List<GiftCard> giftCards, String cursor) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
HttpContext	getContext()
String	getCursor() Getter for Cursor.
List<Error>	getErrors() Getter for Errors.
List<GiftCard>	getGiftCards() Getter for GiftCards.
int	hashCode()
ListGiftCardsResponse.Builder	toBuilder() Builds a new ListGiftCardsResponse.Builder object.
String	toString() Converts this ListGiftCardsResponse into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListGiftCardsResponse

public ListGiftCardsResponse(List<Error> errors,
                             List<GiftCard> giftCards,
                             String cursor)

Initialization constructor.

Parameters:

errors - List of Error value for errors.

giftCards - List of GiftCard value for giftCards.

cursor - String value for cursor.

Method Detail

getContext

public HttpContext getContext()

getErrors

public List<Error> getErrors()

Getter for Errors. Any errors that occurred during the request.

Returns:

Returns the List of Error

getGiftCards

public List<GiftCard> getGiftCards()

Getter for GiftCards. The requested gift cards or an empty object if none are found.

Returns:

Returns the List of GiftCard

getCursor

public String getCursor()

Getter for Cursor. When a response is truncated, it includes a cursor that you can use in a subsequent request to retrieve the next set of gift cards. If a cursor is not present, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).

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 ListGiftCardsResponse into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ListGiftCardsResponse.Builder toBuilder()

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

Returns:

a new ListGiftCardsResponse.Builder object