com.squareup.square.models

Class ListCustomersResponse

java.lang.Object

com.squareup.square.models.ListCustomersResponse

public class ListCustomersResponse
extends Object

This is a model class for ListCustomersResponse type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ListCustomersResponse(List<Error> errors, List<Customer> customers, String cursor, Long count) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
HttpContext	getContext()
Long	getCount() Getter for Count.
String	getCursor() Getter for Cursor.
List<Customer>	getCustomers() Getter for Customers.
List<Error>	getErrors() Getter for Errors.
int	hashCode()
ListCustomersResponse.Builder	toBuilder() Builds a new ListCustomersResponse.Builder object.
String	toString() Converts this ListCustomersResponse into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListCustomersResponse

public ListCustomersResponse(List<Error> errors,
                             List<Customer> customers,
                             String cursor,
                             Long count)

Initialization constructor.

Parameters:

errors - List of Error value for errors.

customers - List of Customer value for customers.

cursor - String value for cursor.

count - Long value for count.

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

getCustomers

public List<Customer> getCustomers()

Getter for Customers. The customer profiles associated with the Square account or an empty object (`{}`) if none are found. Only customer profiles with public information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) are included in the response.

Returns:

Returns the List of Customer

getCursor

public String getCursor()

Getter for Cursor. A pagination cursor to retrieve the next set of results for the original query. A cursor is only present if the request succeeded and additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the String

getCount

public Long getCount()

Getter for Count. The total count of customers associated with the Square account. Only customer profiles with public information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) are counted. This field is present only if `count` is set to `true` in the request.

Returns:

Returns the Long

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ListCustomersResponse.Builder toBuilder()

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

Returns:

a new ListCustomersResponse.Builder object