com.squareup.square.api

Class DefaultCustomerSegmentsApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultCustomerSegmentsApi

All Implemented Interfaces:

CustomerSegmentsApi

public final class DefaultCustomerSegmentsApi
extends BaseApi
implements CustomerSegmentsApi

This class lists all the endpoints of the groups.

Nested Class Summary

Nested classes/interfaces inherited from class com.squareup.square.api.BaseApi

BaseApi.RequestExecutor, BaseApi.RequestSupplier, BaseApi.ResponseHandler<T>

Field Summary

Fields inherited from class com.squareup.square.api.BaseApi

authManagers, config, httpCallback, internalUserAgent

Constructor Summary

Constructors

Constructor and Description
DefaultCustomerSegmentsApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers) Initializes the controller.
DefaultCustomerSegmentsApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers, HttpCallback httpCallback) Initializes the controller with HTTPCallback.

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.

Methods inherited from class com.squareup.square.api.BaseApi

getClientInstance, getHttpCallback, makeHttpCallAsync, validateResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultCustomerSegmentsApi

public DefaultCustomerSegmentsApi(Configuration config,
                                  HttpClient httpClient,
                                  Map<String,AuthManager> authManagers)

Initializes the controller.

Parameters:

config - Configurations added in client.

httpClient - Send HTTP requests and read the responses.

authManagers - Apply authorization to requests.

DefaultCustomerSegmentsApi

public DefaultCustomerSegmentsApi(Configuration config,
                                  HttpClient httpClient,
                                  Map<String,AuthManager> authManagers,
                                  HttpCallback httpCallback)

Initializes the controller with HTTPCallback.

Parameters:

config - Configurations added in client.

httpClient - Send HTTP requests and read the responses.

authManagers - Apply authorization to requests.

httpCallback - Callback to be called before and after the HTTP call.

Method Detail

listCustomerSegments

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

Retrieves the list of customer segments of a business.

Specified by:

listCustomerSegments in interface CustomerSegmentsApi

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

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

Retrieves the list of customer segments of a business.

Specified by:

listCustomerSegmentsAsync in interface CustomerSegmentsApi

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

public RetrieveCustomerSegmentResponse retrieveCustomerSegment(String segmentId)
                                                        throws ApiException,
                                                               IOException

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

Specified by:

retrieveCustomerSegment in interface CustomerSegmentsApi

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

public CompletableFuture<RetrieveCustomerSegmentResponse> retrieveCustomerSegmentAsync(String segmentId)

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

Specified by:

retrieveCustomerSegmentAsync in interface CustomerSegmentsApi

Parameters:

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

Returns:

Returns the RetrieveCustomerSegmentResponse response from the API call