com.squareup.square.api

Class DefaultSitesApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultSitesApi

All Implemented Interfaces:

SitesApi

public final class DefaultSitesApi
extends BaseApi
implements SitesApi

This class lists all the endpoints of the groups.

Field Summary

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

AUTHENTICATION_KEY, GLOBAL_ERROR_CASES

Constructor Summary

Constructors

Constructor and Description
DefaultSitesApi(io.apimatic.core.GlobalConfiguration globalConfig) Initializes the controller.

Method Summary

Modifier and Type	Method and Description
ListSitesResponse	listSites() Lists the Square Online sites that belong to a seller.
CompletableFuture<ListSitesResponse>	listSitesAsync() Lists the Square Online sites that belong to a seller.

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

getClientInstance, getGlobalConfiguration, getHttpCallback

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSitesApi

public DefaultSitesApi(io.apimatic.core.GlobalConfiguration globalConfig)

Initializes the controller.

Parameters:

globalConfig - Configurations added in client.

Method Detail

listSites

public ListSitesResponse listSites()
                            throws ApiException,
                                   IOException

Lists the Square Online sites that belong to a seller. Sites are listed in descending order by the `created_at` date. __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).

Specified by:

listSites in interface SitesApi

Returns:

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

listSitesAsync

public CompletableFuture<ListSitesResponse> listSitesAsync()

Lists the Square Online sites that belong to a seller. Sites are listed in descending order by the `created_at` date. __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).

Specified by:

listSitesAsync in interface SitesApi

Returns:

Returns the ListSitesResponse response from the API call