com.squareup.square.models

Class ListCardsRequest

java.lang.Object

com.squareup.square.models.ListCardsRequest

public class ListCardsRequest
extends Object

This is a model class for ListCardsRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ListCardsRequest(io.apimatic.core.types.OptionalNullable<String> cursor, io.apimatic.core.types.OptionalNullable<String> customerId, io.apimatic.core.types.OptionalNullable<Boolean> includeDisabled, io.apimatic.core.types.OptionalNullable<String> referenceId, String sortOrder) Initialization constructor.
	ListCardsRequest(String cursor, String customerId, Boolean includeDisabled, String referenceId, String sortOrder) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCursor() Getter for Cursor.
String	getCustomerId() Getter for CustomerId.
Boolean	getIncludeDisabled() Getter for IncludeDisabled.
String	getReferenceId() Getter for ReferenceId.
String	getSortOrder() Getter for SortOrder.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCursor() Internal Getter for Cursor.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCustomerId() Internal Getter for CustomerId.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetIncludeDisabled() Internal Getter for IncludeDisabled.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetReferenceId() Internal Getter for ReferenceId.
ListCardsRequest.Builder	toBuilder() Builds a new ListCardsRequest.Builder object.
String	toString() Converts this ListCardsRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListCardsRequest

public ListCardsRequest(String cursor,
                        String customerId,
                        Boolean includeDisabled,
                        String referenceId,
                        String sortOrder)

Initialization constructor.

Parameters:

cursor - String value for cursor.

customerId - String value for customerId.

includeDisabled - Boolean value for includeDisabled.

referenceId - String value for referenceId.

sortOrder - String value for sortOrder.

ListCardsRequest

protected ListCardsRequest(io.apimatic.core.types.OptionalNullable<String> cursor,
                           io.apimatic.core.types.OptionalNullable<String> customerId,
                           io.apimatic.core.types.OptionalNullable<Boolean> includeDisabled,
                           io.apimatic.core.types.OptionalNullable<String> referenceId,
                           String sortOrder)

Initialization constructor.

Parameters:

cursor - String value for cursor.

customerId - String value for customerId.

includeDisabled - Boolean value for includeDisabled.

referenceId - String value for referenceId.

sortOrder - String value for sortOrder.

Method Detail

internalGetCursor

protected io.apimatic.core.types.OptionalNullable<String> internalGetCursor()

Internal Getter for Cursor. A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.

Returns:

Returns the Internal String

getCursor

public String getCursor()

Getter for Cursor. A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.

Returns:

Returns the String

internalGetCustomerId

protected io.apimatic.core.types.OptionalNullable<String> internalGetCustomerId()

Internal Getter for CustomerId. Limit results to cards associated with the customer supplied. By default, all cards owned by the merchant are returned.

Returns:

Returns the Internal String

getCustomerId

public String getCustomerId()

Getter for CustomerId. Limit results to cards associated with the customer supplied. By default, all cards owned by the merchant are returned.

Returns:

Returns the String

internalGetIncludeDisabled

protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetIncludeDisabled()

Internal Getter for IncludeDisabled. Includes disabled cards. By default, all enabled cards owned by the merchant are returned.

Returns:

Returns the Internal Boolean

getIncludeDisabled

public Boolean getIncludeDisabled()

Getter for IncludeDisabled. Includes disabled cards. By default, all enabled cards owned by the merchant are returned.

Returns:

Returns the Boolean

internalGetReferenceId

protected io.apimatic.core.types.OptionalNullable<String> internalGetReferenceId()

Internal Getter for ReferenceId. Limit results to cards associated with the reference_id supplied.

Returns:

Returns the Internal String

getReferenceId

public String getReferenceId()

Getter for ReferenceId. Limit results to cards associated with the reference_id supplied.

Returns:

Returns the String

getSortOrder

public String getSortOrder()

Getter for SortOrder. The order (e.g., chronological or alphabetical) in which results from a request are returned.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ListCardsRequest.Builder toBuilder()

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

Returns:

a new ListCardsRequest.Builder object