com.squareup.square.api

Class DefaultMerchantsApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultMerchantsApi

All Implemented Interfaces:

MerchantsApi

public final class DefaultMerchantsApi
extends BaseApi
implements MerchantsApi

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

Method Summary

Modifier and Type	Method and Description
ListMerchantsResponse	listMerchants(Integer cursor) Provides details about the merchant associated with a given access token.
CompletableFuture<ListMerchantsResponse>	listMerchantsAsync(Integer cursor) Provides details about the merchant associated with a given access token.
RetrieveMerchantResponse	retrieveMerchant(String merchantId) Retrieves the `Merchant` object for the given `merchant_id`.
CompletableFuture<RetrieveMerchantResponse>	retrieveMerchantAsync(String merchantId) Retrieves the `Merchant` object for the given `merchant_id`.

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

DefaultMerchantsApi

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

DefaultMerchantsApi

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

listMerchants

public ListMerchantsResponse listMerchants(Integer cursor)
                                    throws ApiException,
                                           IOException

Provides details about the merchant associated with a given access token. The access token used to connect your application to a Square seller is associated with a single merchant. That means that `ListMerchants` returns a list with a single `Merchant` object. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted your application access. If you know the merchant ID, you can also use the [RetrieveMerchant]($e/Merchants/RetrieveMerchant) endpoint to retrieve the merchant information.

Specified by:

listMerchants in interface MerchantsApi

Parameters:

cursor - Optional parameter: The cursor generated by the previous response.

Returns:

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

listMerchantsAsync

public CompletableFuture<ListMerchantsResponse> listMerchantsAsync(Integer cursor)

Provides details about the merchant associated with a given access token. The access token used to connect your application to a Square seller is associated with a single merchant. That means that `ListMerchants` returns a list with a single `Merchant` object. You can specify your personal access token to get your own merchant information or specify an OAuth token to get the information for the merchant that granted your application access. If you know the merchant ID, you can also use the [RetrieveMerchant]($e/Merchants/RetrieveMerchant) endpoint to retrieve the merchant information.

Specified by:

listMerchantsAsync in interface MerchantsApi

Parameters:

cursor - Optional parameter: The cursor generated by the previous response.

Returns:

Returns the ListMerchantsResponse response from the API call

retrieveMerchant

public RetrieveMerchantResponse retrieveMerchant(String merchantId)
                                          throws ApiException,
                                                 IOException

Retrieves the `Merchant` object for the given `merchant_id`.

Specified by:

retrieveMerchant in interface MerchantsApi

Parameters:

merchantId - Required parameter: The ID of the merchant to retrieve. If the string "me" is supplied as the ID, then retrieve the merchant that is currently accessible to this call.

Returns:

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

retrieveMerchantAsync

public CompletableFuture<RetrieveMerchantResponse> retrieveMerchantAsync(String merchantId)

Retrieves the `Merchant` object for the given `merchant_id`.

Specified by:

retrieveMerchantAsync in interface MerchantsApi

Parameters:

merchantId - Required parameter: The ID of the merchant to retrieve. If the string "me" is supplied as the ID, then retrieve the merchant that is currently accessible to this call.

Returns:

Returns the RetrieveMerchantResponse response from the API call