com.squareup.square.api

Interface CustomerSegmentsApi

All Known Implementing Classes:

DefaultCustomerSegmentsApi

public interface CustomerSegmentsApi

This interface lists all the endpoints of the group. This can be overridden for the mock calls.

Method Summary

Modifier and Type	Method and Description
ListCustomerSegmentsResponse	listCustomerSegments(String cursor, Integer limit) Retrieves the list of customer segments of a business.
CompletableFuture<ListCustomerSegmentsResponse>	listCustomerSegmentsAsync(String cursor, Integer limit) Retrieves the list of customer segments of a business.
RetrieveCustomerSegmentResponse	retrieveCustomerSegment(String segmentId) Retrieves a specific customer segment as identified by the `segment_id` value.
CompletableFuture<RetrieveCustomerSegmentResponse>	retrieveCustomerSegmentAsync(String segmentId) Retrieves a specific customer segment as identified by the `segment_id` value.

Method Detail

listCustomerSegments

ListCustomerSegmentsResponse listCustomerSegments(String cursor,
                                                  Integer limit)
                                           throws ApiException,
                                                  IOException

Retrieves the list of customer segments of a business.

Parameters:

cursor - Optional parameter: A pagination cursor returned by previous calls to `ListCustomerSegments`. This cursor is used to retrieve the next set of query results. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

limit - Optional parameter: The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. If the specified limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the ListCustomerSegmentsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

listCustomerSegmentsAsync

CompletableFuture<ListCustomerSegmentsResponse> listCustomerSegmentsAsync(String cursor,
                                                                          Integer limit)

Retrieves the list of customer segments of a business.

Parameters:

cursor - Optional parameter: A pagination cursor returned by previous calls to `ListCustomerSegments`. This cursor is used to retrieve the next set of query results. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

limit - Optional parameter: The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. If the specified limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the ListCustomerSegmentsResponse response from the API call

retrieveCustomerSegment

RetrieveCustomerSegmentResponse retrieveCustomerSegment(String segmentId)
                                                 throws ApiException,
                                                        IOException

Retrieves a specific customer segment as identified by the `segment_id` value.

Parameters:

segmentId - Required parameter: The Square-issued ID of the customer segment.

Returns:

Returns the RetrieveCustomerSegmentResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveCustomerSegmentAsync

CompletableFuture<RetrieveCustomerSegmentResponse> retrieveCustomerSegmentAsync(String segmentId)

Retrieves a specific customer segment as identified by the `segment_id` value.

Parameters:

segmentId - Required parameter: The Square-issued ID of the customer segment.

Returns:

Returns the RetrieveCustomerSegmentResponse response from the API call