com.squareup.square.api

Class BaseApi

java.lang.Object

com.squareup.square.api.BaseApi

Direct Known Subclasses:

DefaultApplePayApi, DefaultBankAccountsApi, DefaultBookingCustomAttributesApi, DefaultBookingsApi, DefaultCardsApi, DefaultCashDrawersApi, DefaultCatalogApi, DefaultCheckoutApi, DefaultCustomerCustomAttributesApi, DefaultCustomerGroupsApi, DefaultCustomersApi, DefaultCustomerSegmentsApi, DefaultDevicesApi, DefaultDisputesApi, DefaultEmployeesApi, DefaultGiftCardActivitiesApi, DefaultGiftCardsApi, DefaultInventoryApi, DefaultInvoicesApi, DefaultLaborApi, DefaultLocationCustomAttributesApi, DefaultLocationsApi, DefaultLoyaltyApi, DefaultMerchantCustomAttributesApi, DefaultMerchantsApi, DefaultMobileAuthorizationApi, DefaultOAuthApi, DefaultOrderCustomAttributesApi, DefaultOrdersApi, DefaultPaymentsApi, DefaultPayoutsApi, DefaultRefundsApi, DefaultSitesApi, DefaultSnippetsApi, DefaultSubscriptionsApi, DefaultTeamApi, DefaultTerminalApi, DefaultTransactionsApi, DefaultV1TransactionsApi, DefaultVendorsApi, DefaultWebhookSubscriptionsApi

public abstract class BaseApi
extends Object

Base class for all Apis.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AUTHENTICATION_KEY
protected static Map<String,io.apimatic.core.ErrorCase<ApiException>>	GLOBAL_ERROR_CASES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseApi(io.apimatic.core.GlobalConfiguration globalConfig)

Method Summary

Modifier and Type	Method and Description
io.apimatic.coreinterfaces.http.HttpClient	getClientInstance() Shared instance of the Http client.
protected io.apimatic.core.GlobalConfiguration	getGlobalConfiguration() Instance of the Global Configuration
HttpCallback	getHttpCallback() Get httpCallback associated with this controller.

Methods inherited from class java.lang.Object

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

Field Detail

AUTHENTICATION_KEY

protected static final String AUTHENTICATION_KEY

See Also:

Constant Field Values

GLOBAL_ERROR_CASES

protected static final Map<String,io.apimatic.core.ErrorCase<ApiException>> GLOBAL_ERROR_CASES

Constructor Detail

BaseApi

protected BaseApi(io.apimatic.core.GlobalConfiguration globalConfig)

Method Detail

getHttpCallback

public HttpCallback getHttpCallback()

Get httpCallback associated with this controller.

Returns:

HttpCallback

getClientInstance

public io.apimatic.coreinterfaces.http.HttpClient getClientInstance()

Shared instance of the Http client.

Returns:

The shared instance of the http client

getGlobalConfiguration

protected io.apimatic.core.GlobalConfiguration getGlobalConfiguration()

Instance of the Global Configuration

Returns:

The instance of the global configuration