com.squareup.square.api

Class DefaultCustomerGroupsApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultCustomerGroupsApi

All Implemented Interfaces:

CustomerGroupsApi

public final class DefaultCustomerGroupsApi
extends BaseApi
implements CustomerGroupsApi

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
DefaultCustomerGroupsApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers) Initializes the controller.
DefaultCustomerGroupsApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers, HttpCallback httpCallback) Initializes the controller with HTTPCallback.

Method Summary

Modifier and Type	Method and Description
CreateCustomerGroupResponse	createCustomerGroup(CreateCustomerGroupRequest body) Creates a new customer group for a business.
CompletableFuture<CreateCustomerGroupResponse>	createCustomerGroupAsync(CreateCustomerGroupRequest body) Creates a new customer group for a business.
DeleteCustomerGroupResponse	deleteCustomerGroup(String groupId) Deletes a customer group as identified by the `group_id` value.
CompletableFuture<DeleteCustomerGroupResponse>	deleteCustomerGroupAsync(String groupId) Deletes a customer group as identified by the `group_id` value.
ListCustomerGroupsResponse	listCustomerGroups(String cursor, Integer limit) Retrieves the list of customer groups of a business.
CompletableFuture<ListCustomerGroupsResponse>	listCustomerGroupsAsync(String cursor, Integer limit) Retrieves the list of customer groups of a business.
RetrieveCustomerGroupResponse	retrieveCustomerGroup(String groupId) Retrieves a specific customer group as identified by the `group_id` value.
CompletableFuture<RetrieveCustomerGroupResponse>	retrieveCustomerGroupAsync(String groupId) Retrieves a specific customer group as identified by the `group_id` value.
UpdateCustomerGroupResponse	updateCustomerGroup(String groupId, UpdateCustomerGroupRequest body) Updates a customer group as identified by the `group_id` value.
CompletableFuture<UpdateCustomerGroupResponse>	updateCustomerGroupAsync(String groupId, UpdateCustomerGroupRequest body) Updates a customer group as identified by the `group_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

DefaultCustomerGroupsApi

public DefaultCustomerGroupsApi(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.

DefaultCustomerGroupsApi

public DefaultCustomerGroupsApi(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

listCustomerGroups

public ListCustomerGroupsResponse listCustomerGroups(String cursor,
                                                     Integer limit)
                                              throws ApiException,
                                                     IOException

Retrieves the list of customer groups of a business.

Specified by:

listCustomerGroups in interface CustomerGroupsApi

Parameters:

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query. 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 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 ListCustomerGroupsResponse 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.

listCustomerGroupsAsync

public CompletableFuture<ListCustomerGroupsResponse> listCustomerGroupsAsync(String cursor,
                                                                             Integer limit)

Retrieves the list of customer groups of a business.

Specified by:

listCustomerGroupsAsync in interface CustomerGroupsApi

Parameters:

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query. 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 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 ListCustomerGroupsResponse response from the API call

createCustomerGroup

public CreateCustomerGroupResponse createCustomerGroup(CreateCustomerGroupRequest body)
                                                throws ApiException,
                                                       IOException

Creates a new customer group for a business. The request must include the `name` value of the group.

Specified by:

createCustomerGroup in interface CustomerGroupsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateCustomerGroupResponse 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.

createCustomerGroupAsync

public CompletableFuture<CreateCustomerGroupResponse> createCustomerGroupAsync(CreateCustomerGroupRequest body)

Creates a new customer group for a business. The request must include the `name` value of the group.

Specified by:

createCustomerGroupAsync in interface CustomerGroupsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateCustomerGroupResponse response from the API call

deleteCustomerGroup

public DeleteCustomerGroupResponse deleteCustomerGroup(String groupId)
                                                throws ApiException,
                                                       IOException

Deletes a customer group as identified by the `group_id` value.

Specified by:

deleteCustomerGroup in interface CustomerGroupsApi

Parameters:

groupId - Required parameter: The ID of the customer group to delete.

Returns:

Returns the DeleteCustomerGroupResponse 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.

deleteCustomerGroupAsync

public CompletableFuture<DeleteCustomerGroupResponse> deleteCustomerGroupAsync(String groupId)

Deletes a customer group as identified by the `group_id` value.

Specified by:

deleteCustomerGroupAsync in interface CustomerGroupsApi

Parameters:

groupId - Required parameter: The ID of the customer group to delete.

Returns:

Returns the DeleteCustomerGroupResponse response from the API call

retrieveCustomerGroup

public RetrieveCustomerGroupResponse retrieveCustomerGroup(String groupId)
                                                    throws ApiException,
                                                           IOException

Retrieves a specific customer group as identified by the `group_id` value.

Specified by:

retrieveCustomerGroup in interface CustomerGroupsApi

Parameters:

groupId - Required parameter: The ID of the customer group to retrieve.

Returns:

Returns the RetrieveCustomerGroupResponse 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.

retrieveCustomerGroupAsync

public CompletableFuture<RetrieveCustomerGroupResponse> retrieveCustomerGroupAsync(String groupId)

Retrieves a specific customer group as identified by the `group_id` value.

Specified by:

retrieveCustomerGroupAsync in interface CustomerGroupsApi

Parameters:

groupId - Required parameter: The ID of the customer group to retrieve.

Returns:

Returns the RetrieveCustomerGroupResponse response from the API call

updateCustomerGroup

public UpdateCustomerGroupResponse updateCustomerGroup(String groupId,
                                                       UpdateCustomerGroupRequest body)
                                                throws ApiException,
                                                       IOException

Updates a customer group as identified by the `group_id` value.

Specified by:

updateCustomerGroup in interface CustomerGroupsApi

Parameters:

groupId - Required parameter: The ID of the customer group to update.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateCustomerGroupResponse 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.

updateCustomerGroupAsync

public CompletableFuture<UpdateCustomerGroupResponse> updateCustomerGroupAsync(String groupId,
                                                                               UpdateCustomerGroupRequest body)

Updates a customer group as identified by the `group_id` value.

Specified by:

updateCustomerGroupAsync in interface CustomerGroupsApi

Parameters:

groupId - Required parameter: The ID of the customer group to update.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateCustomerGroupResponse response from the API call