com.squareup.square.api

Class DefaultLocationsApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultLocationsApi

All Implemented Interfaces:

LocationsApi

public final class DefaultLocationsApi
extends BaseApi
implements LocationsApi

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

Method Summary

Modifier and Type	Method and Description
CreateLocationResponse	createLocation(CreateLocationRequest body) Creates a [location](https://developer.squareup.com/docs/locations-api).
CompletableFuture<CreateLocationResponse>	createLocationAsync(CreateLocationRequest body) Creates a [location](https://developer.squareup.com/docs/locations-api).
ListLocationsResponse	listLocations() Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api), including those with an inactive status.
CompletableFuture<ListLocationsResponse>	listLocationsAsync() Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api), including those with an inactive status.
RetrieveLocationResponse	retrieveLocation(String locationId) Retrieves details of a single location.
CompletableFuture<RetrieveLocationResponse>	retrieveLocationAsync(String locationId) Retrieves details of a single location.
UpdateLocationResponse	updateLocation(String locationId, UpdateLocationRequest body) Updates a [location](https://developer.squareup.com/docs/locations-api).
CompletableFuture<UpdateLocationResponse>	updateLocationAsync(String locationId, UpdateLocationRequest body) Updates a [location](https://developer.squareup.com/docs/locations-api).

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

DefaultLocationsApi

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

DefaultLocationsApi

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

listLocations

public ListLocationsResponse listLocations()
                                    throws ApiException,
                                           IOException

Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api), including those with an inactive status.

Specified by:

listLocations in interface LocationsApi

Returns:

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

listLocationsAsync

public CompletableFuture<ListLocationsResponse> listLocationsAsync()

Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api), including those with an inactive status.

Specified by:

listLocationsAsync in interface LocationsApi

Returns:

Returns the ListLocationsResponse response from the API call

createLocation

public CreateLocationResponse createLocation(CreateLocationRequest body)
                                      throws ApiException,
                                             IOException

Creates a [location](https://developer.squareup.com/docs/locations-api). Creating new locations allows for separate configuration of receipt layouts, item prices, and sales reports. Developers can use locations to separate sales activity through applications that integrate with Square from sales activity elsewhere in a seller's account. Locations created programmatically with the Locations API last forever and are visible to the seller for their own management. Therefore, ensure that each location has a sensible and unique name.

Specified by:

createLocation in interface LocationsApi

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 CreateLocationResponse 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.

createLocationAsync

public CompletableFuture<CreateLocationResponse> createLocationAsync(CreateLocationRequest body)

Creates a [location](https://developer.squareup.com/docs/locations-api). Creating new locations allows for separate configuration of receipt layouts, item prices, and sales reports. Developers can use locations to separate sales activity through applications that integrate with Square from sales activity elsewhere in a seller's account. Locations created programmatically with the Locations API last forever and are visible to the seller for their own management. Therefore, ensure that each location has a sensible and unique name.

Specified by:

createLocationAsync in interface LocationsApi

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 CreateLocationResponse response from the API call

retrieveLocation

public RetrieveLocationResponse retrieveLocation(String locationId)
                                          throws ApiException,
                                                 IOException

Retrieves details of a single location. Specify "main" as the location ID to retrieve details of the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location).

Specified by:

retrieveLocation in interface LocationsApi

Parameters:

locationId - Required parameter: The ID of the location to retrieve. Specify the string "main" to return the main location.

Returns:

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

retrieveLocationAsync

public CompletableFuture<RetrieveLocationResponse> retrieveLocationAsync(String locationId)

Retrieves details of a single location. Specify "main" as the location ID to retrieve details of the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location).

Specified by:

retrieveLocationAsync in interface LocationsApi

Parameters:

locationId - Required parameter: The ID of the location to retrieve. Specify the string "main" to return the main location.

Returns:

Returns the RetrieveLocationResponse response from the API call

updateLocation

public UpdateLocationResponse updateLocation(String locationId,
                                             UpdateLocationRequest body)
                                      throws ApiException,
                                             IOException

Updates a [location](https://developer.squareup.com/docs/locations-api).

Specified by:

updateLocation in interface LocationsApi

Parameters:

locationId - Required parameter: The ID of the location 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 UpdateLocationResponse 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.

updateLocationAsync

public CompletableFuture<UpdateLocationResponse> updateLocationAsync(String locationId,
                                                                     UpdateLocationRequest body)

Updates a [location](https://developer.squareup.com/docs/locations-api).

Specified by:

updateLocationAsync in interface LocationsApi

Parameters:

locationId - Required parameter: The ID of the location 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 UpdateLocationResponse response from the API call