com.squareup.square.models

Class CustomerFilter

java.lang.Object

com.squareup.square.models.CustomerFilter

public class CustomerFilter
extends Object

This is a model class for CustomerFilter type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CustomerFilter(CustomerCreationSourceFilter creationSource, TimeRange createdAt, TimeRange updatedAt, CustomerTextFilter emailAddress, CustomerTextFilter phoneNumber, CustomerTextFilter referenceId, FilterValue groupIds, CustomerCustomAttributeFilters customAttribute, FilterValue segmentIds) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
TimeRange	getCreatedAt() Getter for CreatedAt.
CustomerCreationSourceFilter	getCreationSource() Getter for CreationSource.
CustomerCustomAttributeFilters	getCustomAttribute() Getter for CustomAttribute.
CustomerTextFilter	getEmailAddress() Getter for EmailAddress.
FilterValue	getGroupIds() Getter for GroupIds.
CustomerTextFilter	getPhoneNumber() Getter for PhoneNumber.
CustomerTextFilter	getReferenceId() Getter for ReferenceId.
FilterValue	getSegmentIds() Getter for SegmentIds.
TimeRange	getUpdatedAt() Getter for UpdatedAt.
int	hashCode()
CustomerFilter.Builder	toBuilder() Builds a new CustomerFilter.Builder object.
String	toString() Converts this CustomerFilter into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomerFilter

public CustomerFilter(CustomerCreationSourceFilter creationSource,
                      TimeRange createdAt,
                      TimeRange updatedAt,
                      CustomerTextFilter emailAddress,
                      CustomerTextFilter phoneNumber,
                      CustomerTextFilter referenceId,
                      FilterValue groupIds,
                      CustomerCustomAttributeFilters customAttribute,
                      FilterValue segmentIds)

Initialization constructor.

Parameters:

creationSource - CustomerCreationSourceFilter value for creationSource.

createdAt - TimeRange value for createdAt.

updatedAt - TimeRange value for updatedAt.

emailAddress - CustomerTextFilter value for emailAddress.

phoneNumber - CustomerTextFilter value for phoneNumber.

referenceId - CustomerTextFilter value for referenceId.

groupIds - FilterValue value for groupIds.

customAttribute - CustomerCustomAttributeFilters value for customAttribute.

segmentIds - FilterValue value for segmentIds.

Method Detail

getCreationSource

public CustomerCreationSourceFilter getCreationSource()

Getter for CreationSource. The creation source filter. If one or more creation sources are set, customer profiles are included in, or excluded from, the result if they match at least one of the filter criteria.

Returns:

Returns the CustomerCreationSourceFilter

getCreatedAt

public TimeRange getCreatedAt()

Getter for CreatedAt. Represents a generic time range. The start and end values are represented in RFC 3339 format. Time ranges are customized to be inclusive or exclusive based on the needs of a particular endpoint. Refer to the relevant endpoint-specific documentation to determine how time ranges are handled.

Returns:

Returns the TimeRange

getUpdatedAt

public TimeRange getUpdatedAt()

Getter for UpdatedAt. Represents a generic time range. The start and end values are represented in RFC 3339 format. Time ranges are customized to be inclusive or exclusive based on the needs of a particular endpoint. Refer to the relevant endpoint-specific documentation to determine how time ranges are handled.

Returns:

Returns the TimeRange

getEmailAddress

public CustomerTextFilter getEmailAddress()

Getter for EmailAddress. A filter to select customers based on exact or fuzzy matching of customer attributes against a specified query. Depending on the customer attributes, the filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.

Returns:

Returns the CustomerTextFilter

getPhoneNumber

public CustomerTextFilter getPhoneNumber()

Getter for PhoneNumber. A filter to select customers based on exact or fuzzy matching of customer attributes against a specified query. Depending on the customer attributes, the filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.

Returns:

Returns the CustomerTextFilter

getReferenceId

public CustomerTextFilter getReferenceId()

Getter for ReferenceId. A filter to select customers based on exact or fuzzy matching of customer attributes against a specified query. Depending on the customer attributes, the filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.

Returns:

Returns the CustomerTextFilter

getGroupIds

public FilterValue getGroupIds()

Getter for GroupIds. A filter to select resources based on an exact field value. For any given value, the value can only be in one property. Depending on the field, either all properties can be set or only a subset will be available. Refer to the documentation of the field.

Returns:

Returns the FilterValue

getCustomAttribute

public CustomerCustomAttributeFilters getCustomAttribute()

Getter for CustomAttribute. The custom attribute filters in a set of [customer filters]($m/CustomerFilter) used in a search query. Use this filter to search based on [custom attributes]($m/CustomAttribute) that are assigned to customer profiles. For more information, see [Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute).

Returns:

Returns the CustomerCustomAttributeFilters

getSegmentIds

public FilterValue getSegmentIds()

Getter for SegmentIds. A filter to select resources based on an exact field value. For any given value, the value can only be in one property. Depending on the field, either all properties can be set or only a subset will be available. Refer to the documentation of the field.

Returns:

Returns the FilterValue

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CustomerFilter.Builder toBuilder()

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

Returns:

a new CustomerFilter.Builder object