SquareClient (Square 30.0.1.20230608 API)

java.lang.Object
- com.squareup.square.SquareClient

All Implemented Interfaces:

Configuration, SquareClientInterface
```
public final class SquareClient
extends Object
implements SquareClientInterface
```
Gateway class for the library. This class acts as a factory for Apis. It holds the state of the SDK.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SquareClient.Builder
Class to build instances of SquareClient.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SquareClient.Builder` Class to build instances of `SquareClient`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getAccessToken()` OAuth 2.0 Access Token.
`Headers`	`getAdditionalHeaders()` Additional headers to add to each API request.
`ApplePayApi`	`getApplePayApi()` Get the instance of ApplePayApi.
`BankAccountsApi`	`getBankAccountsApi()` Get the instance of BankAccountsApi.
`String`	`getBaseUri()` Get base URI by current environment.
`String`	`getBaseUri(Server server)` Get base URI by current environment.
`String`	`getBaseUri(String server)` Get base URI by current environment.
`BookingCustomAttributesApi`	`getBookingCustomAttributesApi()` Get the instance of BookingCustomAttributesApi.
`BookingsApi`	`getBookingsApi()` Get the instance of BookingsApi.
`CardsApi`	`getCardsApi()` Get the instance of CardsApi.
`CashDrawersApi`	`getCashDrawersApi()` Get the instance of CashDrawersApi.
`CatalogApi`	`getCatalogApi()` Get the instance of CatalogApi.
`CheckoutApi`	`getCheckoutApi()` Get the instance of CheckoutApi.
`CustomerCustomAttributesApi`	`getCustomerCustomAttributesApi()` Get the instance of CustomerCustomAttributesApi.
`CustomerGroupsApi`	`getCustomerGroupsApi()` Get the instance of CustomerGroupsApi.
`CustomersApi`	`getCustomersApi()` Get the instance of CustomersApi.
`CustomerSegmentsApi`	`getCustomerSegmentsApi()` Get the instance of CustomerSegmentsApi.
`String`	`getCustomUrl()` Sets the base URL requests are made to.
`DevicesApi`	`getDevicesApi()` Get the instance of DevicesApi.
`DisputesApi`	`getDisputesApi()` Get the instance of DisputesApi.
`EmployeesApi`	`getEmployeesApi()` Get the instance of EmployeesApi.
`Environment`	`getEnvironment()` Current API environment.
`GiftCardActivitiesApi`	`getGiftCardActivitiesApi()` Get the instance of GiftCardActivitiesApi.
`GiftCardsApi`	`getGiftCardsApi()` Get the instance of GiftCardsApi.
`ReadonlyHttpClientConfiguration`	`getHttpClientConfig()` Http Client Configuration instance.
`InventoryApi`	`getInventoryApi()` Get the instance of InventoryApi.
`InvoicesApi`	`getInvoicesApi()` Get the instance of InvoicesApi.
`LaborApi`	`getLaborApi()` Get the instance of LaborApi.
`LocationCustomAttributesApi`	`getLocationCustomAttributesApi()` Get the instance of LocationCustomAttributesApi.
`LocationsApi`	`getLocationsApi()` Get the instance of LocationsApi.
`LoyaltyApi`	`getLoyaltyApi()` Get the instance of LoyaltyApi.
`MerchantCustomAttributesApi`	`getMerchantCustomAttributesApi()` Get the instance of MerchantCustomAttributesApi.
`MerchantsApi`	`getMerchantsApi()` Get the instance of MerchantsApi.
`MobileAuthorizationApi`	`getMobileAuthorizationApi()` Get the instance of MobileAuthorizationApi.
`OAuthApi`	`getOAuthApi()` Get the instance of OAuthApi.
`OrderCustomAttributesApi`	`getOrderCustomAttributesApi()` Get the instance of OrderCustomAttributesApi.
`OrdersApi`	`getOrdersApi()` Get the instance of OrdersApi.
`PaymentsApi`	`getPaymentsApi()` Get the instance of PaymentsApi.
`PayoutsApi`	`getPayoutsApi()` Get the instance of PayoutsApi.
`RefundsApi`	`getRefundsApi()` Get the instance of RefundsApi.
`String`	`getSdkVersion()` Current SDK Version.
`SitesApi`	`getSitesApi()` Get the instance of SitesApi.
`SnippetsApi`	`getSnippetsApi()` Get the instance of SnippetsApi.
`String`	`getSquareVersion()` Square Connect API versions.
`SubscriptionsApi`	`getSubscriptionsApi()` Get the instance of SubscriptionsApi.
`TeamApi`	`getTeamApi()` Get the instance of TeamApi.
`TerminalApi`	`getTerminalApi()` Get the instance of TerminalApi.
`TransactionsApi`	`getTransactionsApi()` Get the instance of TransactionsApi.
`String`	`getUserAgentDetail()` Additional detail which can be appended with User-Agent header.
`V1TransactionsApi`	`getV1TransactionsApi()` Get the instance of V1TransactionsApi.
`VendorsApi`	`getVendorsApi()` Get the instance of VendorsApi.
`WebhookSubscriptionsApi`	`getWebhookSubscriptionsApi()` Get the instance of WebhookSubscriptionsApi.
`SquareClient.Builder`	`newBuilder()` Builds a new `SquareClient.Builder` object.
`static void`	`shutdown()` Shutdown the underlying HttpClient instance.
`long`	`timeout()` Deprecated. This method will be removed in a future version. Use `getHttpClientConfig()` instead.
`String`	`toString()` Converts this SquareClient into string format.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - shutdown
```
public static void shutdown()
```
    Shutdown the underlying HttpClient instance.
  - getMobileAuthorizationApi
```
public MobileAuthorizationApi getMobileAuthorizationApi()
```
    Get the instance of MobileAuthorizationApi.
    
    Specified by:
    
    getMobileAuthorizationApi in interface SquareClientInterface
    
    Returns:
    
    mobileAuthorization
  - getOAuthApi
```
public OAuthApi getOAuthApi()
```
    Get the instance of OAuthApi.
    
    Specified by:
    
    getOAuthApi in interface SquareClientInterface
    
    Returns:
    
    oAuth
  - getV1TransactionsApi
```
public V1TransactionsApi getV1TransactionsApi()
```
    Get the instance of V1TransactionsApi.
    
    Specified by:
    
    getV1TransactionsApi in interface SquareClientInterface
    
    Returns:
    
    v1Transactions
  - getApplePayApi
```
public ApplePayApi getApplePayApi()
```
    Get the instance of ApplePayApi.
    
    Specified by:
    
    getApplePayApi in interface SquareClientInterface
    
    Returns:
    
    applePay
  - getBankAccountsApi
```
public BankAccountsApi getBankAccountsApi()
```
    Get the instance of BankAccountsApi.
    
    Specified by:
    
    getBankAccountsApi in interface SquareClientInterface
    
    Returns:
    
    bankAccounts
  - getBookingsApi
```
public BookingsApi getBookingsApi()
```
    Get the instance of BookingsApi.
    
    Specified by:
    
    getBookingsApi in interface SquareClientInterface
    
    Returns:
    
    bookings
  - getBookingCustomAttributesApi
```
public BookingCustomAttributesApi getBookingCustomAttributesApi()
```
    Get the instance of BookingCustomAttributesApi.
    
    Specified by:
    
    getBookingCustomAttributesApi in interface SquareClientInterface
    
    Returns:
    
    bookingCustomAttributes
  - getCardsApi
```
public CardsApi getCardsApi()
```
    Get the instance of CardsApi.
    
    Specified by:
    
    getCardsApi in interface SquareClientInterface
    
    Returns:
    
    cards
  - getCashDrawersApi
```
public CashDrawersApi getCashDrawersApi()
```
    Get the instance of CashDrawersApi.
    
    Specified by:
    
    getCashDrawersApi in interface SquareClientInterface
    
    Returns:
    
    cashDrawers
  - getCatalogApi
```
public CatalogApi getCatalogApi()
```
    Get the instance of CatalogApi.
    
    Specified by:
    
    getCatalogApi in interface SquareClientInterface
    
    Returns:
    
    catalog
  - getCustomersApi
```
public CustomersApi getCustomersApi()
```
    Get the instance of CustomersApi.
    
    Specified by:
    
    getCustomersApi in interface SquareClientInterface
    
    Returns:
    
    customers
  - getCustomerCustomAttributesApi
```
public CustomerCustomAttributesApi getCustomerCustomAttributesApi()
```
    Get the instance of CustomerCustomAttributesApi.
    
    Specified by:
    
    getCustomerCustomAttributesApi in interface SquareClientInterface
    
    Returns:
    
    customerCustomAttributes
  - getCustomerGroupsApi
```
public CustomerGroupsApi getCustomerGroupsApi()
```
    Get the instance of CustomerGroupsApi.
    
    Specified by:
    
    getCustomerGroupsApi in interface SquareClientInterface
    
    Returns:
    
    customerGroups
  - getCustomerSegmentsApi
```
public CustomerSegmentsApi getCustomerSegmentsApi()
```
    Get the instance of CustomerSegmentsApi.
    
    Specified by:
    
    getCustomerSegmentsApi in interface SquareClientInterface
    
    Returns:
    
    customerSegments
  - getDevicesApi
```
public DevicesApi getDevicesApi()
```
    Get the instance of DevicesApi.
    
    Specified by:
    
    getDevicesApi in interface SquareClientInterface
    
    Returns:
    
    devices
  - getDisputesApi
```
public DisputesApi getDisputesApi()
```
    Get the instance of DisputesApi.
    
    Specified by:
    
    getDisputesApi in interface SquareClientInterface
    
    Returns:
    
    disputes
  - getEmployeesApi
```
public EmployeesApi getEmployeesApi()
```
    Get the instance of EmployeesApi.
    
    Specified by:
    
    getEmployeesApi in interface SquareClientInterface
    
    Returns:
    
    employees
  - getGiftCardsApi
```
public GiftCardsApi getGiftCardsApi()
```
    Get the instance of GiftCardsApi.
    
    Specified by:
    
    getGiftCardsApi in interface SquareClientInterface
    
    Returns:
    
    giftCards
  - getGiftCardActivitiesApi
```
public GiftCardActivitiesApi getGiftCardActivitiesApi()
```
    Get the instance of GiftCardActivitiesApi.
    
    Specified by:
    
    getGiftCardActivitiesApi in interface SquareClientInterface
    
    Returns:
    
    giftCardActivities
  - getInventoryApi
```
public InventoryApi getInventoryApi()
```
    Get the instance of InventoryApi.
    
    Specified by:
    
    getInventoryApi in interface SquareClientInterface
    
    Returns:
    
    inventory
  - getInvoicesApi
```
public InvoicesApi getInvoicesApi()
```
    Get the instance of InvoicesApi.
    
    Specified by:
    
    getInvoicesApi in interface SquareClientInterface
    
    Returns:
    
    invoices
  - getLaborApi
```
public LaborApi getLaborApi()
```
    Get the instance of LaborApi.
    
    Specified by:
    
    getLaborApi in interface SquareClientInterface
    
    Returns:
    
    labor
  - getLocationsApi
```
public LocationsApi getLocationsApi()
```
    Get the instance of LocationsApi.
    
    Specified by:
    
    getLocationsApi in interface SquareClientInterface
    
    Returns:
    
    locations
  - getLocationCustomAttributesApi
```
public LocationCustomAttributesApi getLocationCustomAttributesApi()
```
    Get the instance of LocationCustomAttributesApi.
    
    Specified by:
    
    getLocationCustomAttributesApi in interface SquareClientInterface
    
    Returns:
    
    locationCustomAttributes
  - getCheckoutApi
```
public CheckoutApi getCheckoutApi()
```
    Get the instance of CheckoutApi.
    
    Specified by:
    
    getCheckoutApi in interface SquareClientInterface
    
    Returns:
    
    checkout
  - getTransactionsApi
```
public TransactionsApi getTransactionsApi()
```
    Get the instance of TransactionsApi.
    
    Specified by:
    
    getTransactionsApi in interface SquareClientInterface
    
    Returns:
    
    transactions
  - getLoyaltyApi
```
public LoyaltyApi getLoyaltyApi()
```
    Get the instance of LoyaltyApi.
    
    Specified by:
    
    getLoyaltyApi in interface SquareClientInterface
    
    Returns:
    
    loyalty
  - getMerchantsApi
```
public MerchantsApi getMerchantsApi()
```
    Get the instance of MerchantsApi.
    
    Specified by:
    
    getMerchantsApi in interface SquareClientInterface
    
    Returns:
    
    merchants
  - getMerchantCustomAttributesApi
```
public MerchantCustomAttributesApi getMerchantCustomAttributesApi()
```
    Get the instance of MerchantCustomAttributesApi.
    
    Specified by:
    
    getMerchantCustomAttributesApi in interface SquareClientInterface
    
    Returns:
    
    merchantCustomAttributes
  - getOrdersApi
```
public OrdersApi getOrdersApi()
```
    Get the instance of OrdersApi.
    
    Specified by:
    
    getOrdersApi in interface SquareClientInterface
    
    Returns:
    
    orders
  - getOrderCustomAttributesApi
```
public OrderCustomAttributesApi getOrderCustomAttributesApi()
```
    Get the instance of OrderCustomAttributesApi.
    
    Specified by:
    
    getOrderCustomAttributesApi in interface SquareClientInterface
    
    Returns:
    
    orderCustomAttributes
  - getPaymentsApi
```
public PaymentsApi getPaymentsApi()
```
    Get the instance of PaymentsApi.
    
    Specified by:
    
    getPaymentsApi in interface SquareClientInterface
    
    Returns:
    
    payments
  - getPayoutsApi
```
public PayoutsApi getPayoutsApi()
```
    Get the instance of PayoutsApi.
    
    Specified by:
    
    getPayoutsApi in interface SquareClientInterface
    
    Returns:
    
    payouts
  - getRefundsApi
```
public RefundsApi getRefundsApi()
```
    Get the instance of RefundsApi.
    
    Specified by:
    
    getRefundsApi in interface SquareClientInterface
    
    Returns:
    
    refunds
  - getSitesApi
```
public SitesApi getSitesApi()
```
    Get the instance of SitesApi.
    
    Specified by:
    
    getSitesApi in interface SquareClientInterface
    
    Returns:
    
    sites
  - getSnippetsApi
```
public SnippetsApi getSnippetsApi()
```
    Get the instance of SnippetsApi.
    
    Specified by:
    
    getSnippetsApi in interface SquareClientInterface
    
    Returns:
    
    snippets
  - getSubscriptionsApi
```
public SubscriptionsApi getSubscriptionsApi()
```
    Get the instance of SubscriptionsApi.
    
    Specified by:
    
    getSubscriptionsApi in interface SquareClientInterface
    
    Returns:
    
    subscriptions
  - getTeamApi
```
public TeamApi getTeamApi()
```
    Get the instance of TeamApi.
    
    Specified by:
    
    getTeamApi in interface SquareClientInterface
    
    Returns:
    
    team
  - getTerminalApi
```
public TerminalApi getTerminalApi()
```
    Get the instance of TerminalApi.
    
    Specified by:
    
    getTerminalApi in interface SquareClientInterface
    
    Returns:
    
    terminal
  - getVendorsApi
```
public VendorsApi getVendorsApi()
```
    Get the instance of VendorsApi.
    
    Specified by:
    
    getVendorsApi in interface SquareClientInterface
    
    Returns:
    
    vendors
  - getWebhookSubscriptionsApi
```
public WebhookSubscriptionsApi getWebhookSubscriptionsApi()
```
    Get the instance of WebhookSubscriptionsApi.
    
    Specified by:
    
    getWebhookSubscriptionsApi in interface SquareClientInterface
    
    Returns:
    
    webhookSubscriptions
  - getEnvironment
```
public Environment getEnvironment()
```
    Current API environment.
    
    Specified by:
    
    getEnvironment in interface Configuration
    
    Returns:
    
    environment
  - getCustomUrl
```
public String getCustomUrl()
```
    Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
    
    Specified by:
    
    getCustomUrl in interface Configuration
    
    Returns:
    
    customUrl
  - getSquareVersion
```
public String getSquareVersion()
```
    Square Connect API versions.
    
    Specified by:
    
    getSquareVersion in interface Configuration
    
    Returns:
    
    squareVersion
  - getHttpClientConfig
```
public ReadonlyHttpClientConfiguration getHttpClientConfig()
```
    Http Client Configuration instance.
    
    Specified by:
    
    getHttpClientConfig in interface Configuration
    
    Returns:
    
    httpClientConfig
  - getAdditionalHeaders
```
public Headers getAdditionalHeaders()
```
    Additional headers to add to each API request.
    
    Specified by:
    
    getAdditionalHeaders in interface Configuration
    
    Returns:
    
    a copy of additionalHeaders
  - getUserAgentDetail
```
public String getUserAgentDetail()
```
    Additional detail which can be appended with User-Agent header.
    
    Specified by:
    
    getUserAgentDetail in interface Configuration
    
    Returns:
    
    userAgentDetail
  - getAccessToken
```
public String getAccessToken()
```
    OAuth 2.0 Access Token.
    
    Specified by:
    
    getAccessToken in interface Configuration
    
    Returns:
    
    accessToken
  - getSdkVersion
```
public String getSdkVersion()
```
    Current SDK Version.
    
    Specified by:
    
    getSdkVersion in interface SquareClientInterface
    
    Returns:
    
    sdkVersion
  - timeout
```
@Deprecated
public long timeout()
```
    Deprecated. This method will be removed in a future version. Use getHttpClientConfig() instead.
    
    The timeout to use for making HTTP requests.
    
    Specified by:
    
    timeout in interface Configuration
    
    Returns:
    
    timeout
  - getBaseUri
```
public String getBaseUri(Server server)
```
    Get base URI by current environment.
    
    Specified by:
    
    getBaseUri in interface Configuration
    
    Parameters:
    
    server - Server for which to get the base URI
    
    Returns:
    
    Processed base URI
  - getBaseUri
```
public String getBaseUri()
```
    Get base URI by current environment.
    
    Specified by:
    
    getBaseUri in interface Configuration
    
    Returns:
    
    Processed base URI
  - getBaseUri
```
public String getBaseUri(String server)
```
    Get base URI by current environment.
    
    Parameters:
    
    server - string for which to get the base URI
    
    Returns:
    
    Processed base URI
  - toString
```
public String toString()
```
    Converts this SquareClient into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - newBuilder
```
public SquareClient.Builder newBuilder()
```
    Builds a new SquareClient.Builder object. Creates the instance with the state of the current client.
    
    Returns:
    
    a new SquareClient.Builder object

Class SquareClient

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

shutdown

getMobileAuthorizationApi

getOAuthApi

getV1TransactionsApi

getApplePayApi

getBankAccountsApi

getBookingsApi

getBookingCustomAttributesApi

getCardsApi

getCashDrawersApi

getCatalogApi

getCustomersApi

getCustomerCustomAttributesApi

getCustomerGroupsApi

getCustomerSegmentsApi

getDevicesApi

getDisputesApi

getEmployeesApi

getGiftCardsApi

getGiftCardActivitiesApi

getInventoryApi

getInvoicesApi

getLaborApi

getLocationsApi

getLocationCustomAttributesApi

getCheckoutApi

getTransactionsApi

getLoyaltyApi

getMerchantsApi

getMerchantCustomAttributesApi

getOrdersApi

getOrderCustomAttributesApi

getPaymentsApi

getPayoutsApi

getRefundsApi

getSitesApi

getSnippetsApi

getSubscriptionsApi

getTeamApi

getTerminalApi

getVendorsApi

getWebhookSubscriptionsApi

getEnvironment

getCustomUrl

getSquareVersion

getHttpClientConfig

getAdditionalHeaders

getUserAgentDetail

getAccessToken

getSdkVersion

timeout

getBaseUri

getBaseUri

getBaseUri

toString

newBuilder