SquareClientInterface (Square 30.0.1.20230608 API)

All Superinterfaces:

Configuration

All Known Implementing Classes:

SquareClient
```
public interface SquareClientInterface
extends Configuration
```
Gateway interface for the library. This acts as a factory for Apis. It holds the state of the SDK.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ApplePayApi`	`getApplePayApi()` Provides access to ApplePay controller.
`BankAccountsApi`	`getBankAccountsApi()` Provides access to BankAccounts controller.
`BookingCustomAttributesApi`	`getBookingCustomAttributesApi()` Provides access to BookingCustomAttributes controller.
`BookingsApi`	`getBookingsApi()` Provides access to Bookings controller.
`CardsApi`	`getCardsApi()` Provides access to Cards controller.
`CashDrawersApi`	`getCashDrawersApi()` Provides access to CashDrawers controller.
`CatalogApi`	`getCatalogApi()` Provides access to Catalog controller.
`CheckoutApi`	`getCheckoutApi()` Provides access to Checkout controller.
`CustomerCustomAttributesApi`	`getCustomerCustomAttributesApi()` Provides access to CustomerCustomAttributes controller.
`CustomerGroupsApi`	`getCustomerGroupsApi()` Provides access to CustomerGroups controller.
`CustomersApi`	`getCustomersApi()` Provides access to Customers controller.
`CustomerSegmentsApi`	`getCustomerSegmentsApi()` Provides access to CustomerSegments controller.
`DevicesApi`	`getDevicesApi()` Provides access to Devices controller.
`DisputesApi`	`getDisputesApi()` Provides access to Disputes controller.
`EmployeesApi`	`getEmployeesApi()` Provides access to Employees controller.
`GiftCardActivitiesApi`	`getGiftCardActivitiesApi()` Provides access to GiftCardActivities controller.
`GiftCardsApi`	`getGiftCardsApi()` Provides access to GiftCards controller.
`InventoryApi`	`getInventoryApi()` Provides access to Inventory controller.
`InvoicesApi`	`getInvoicesApi()` Provides access to Invoices controller.
`LaborApi`	`getLaborApi()` Provides access to Labor controller.
`LocationCustomAttributesApi`	`getLocationCustomAttributesApi()` Provides access to LocationCustomAttributes controller.
`LocationsApi`	`getLocationsApi()` Provides access to Locations controller.
`LoyaltyApi`	`getLoyaltyApi()` Provides access to Loyalty controller.
`MerchantCustomAttributesApi`	`getMerchantCustomAttributesApi()` Provides access to MerchantCustomAttributes controller.
`MerchantsApi`	`getMerchantsApi()` Provides access to Merchants controller.
`MobileAuthorizationApi`	`getMobileAuthorizationApi()` Provides access to MobileAuthorization controller.
`OAuthApi`	`getOAuthApi()` Provides access to OAuth controller.
`OrderCustomAttributesApi`	`getOrderCustomAttributesApi()` Provides access to OrderCustomAttributes controller.
`OrdersApi`	`getOrdersApi()` Provides access to Orders controller.
`PaymentsApi`	`getPaymentsApi()` Provides access to Payments controller.
`PayoutsApi`	`getPayoutsApi()` Provides access to Payouts controller.
`RefundsApi`	`getRefundsApi()` Provides access to Refunds controller.
`String`	`getSdkVersion()` Current SDK Version.
`SitesApi`	`getSitesApi()` Provides access to Sites controller.
`SnippetsApi`	`getSnippetsApi()` Provides access to Snippets controller.
`SubscriptionsApi`	`getSubscriptionsApi()` Provides access to Subscriptions controller.
`TeamApi`	`getTeamApi()` Provides access to Team controller.
`TerminalApi`	`getTerminalApi()` Provides access to Terminal controller.
`TransactionsApi`	`getTransactionsApi()` Provides access to Transactions controller.
`V1TransactionsApi`	`getV1TransactionsApi()` Provides access to V1Transactions controller.
`VendorsApi`	`getVendorsApi()` Provides access to Vendors controller.
`WebhookSubscriptionsApi`	`getWebhookSubscriptionsApi()` Provides access to WebhookSubscriptions controller.

Methods inherited from interface com.squareup.square.Configuration
getAccessToken, getAdditionalHeaders, getBaseUri, getBaseUri, getCustomUrl, getEnvironment, getHttpClientConfig, getSquareVersion, getUserAgentDetail, timeout

- Method Detail
  - getMobileAuthorizationApi
```
MobileAuthorizationApi getMobileAuthorizationApi()
```
    Provides access to MobileAuthorization controller.
    
    Returns:
    
    Returns the MobileAuthorizationApi instance
  - getOAuthApi
```
OAuthApi getOAuthApi()
```
    Provides access to OAuth controller.
    
    Returns:
    
    Returns the OAuthApi instance
  - getV1TransactionsApi
```
V1TransactionsApi getV1TransactionsApi()
```
    Provides access to V1Transactions controller.
    
    Returns:
    
    Returns the V1TransactionsApi instance
  - getApplePayApi
```
ApplePayApi getApplePayApi()
```
    Provides access to ApplePay controller.
    
    Returns:
    
    Returns the ApplePayApi instance
  - getBankAccountsApi
```
BankAccountsApi getBankAccountsApi()
```
    Provides access to BankAccounts controller.
    
    Returns:
    
    Returns the BankAccountsApi instance
  - getBookingsApi
```
BookingsApi getBookingsApi()
```
    Provides access to Bookings controller.
    
    Returns:
    
    Returns the BookingsApi instance
  - getBookingCustomAttributesApi
```
BookingCustomAttributesApi getBookingCustomAttributesApi()
```
    Provides access to BookingCustomAttributes controller.
    
    Returns:
    
    Returns the BookingCustomAttributesApi instance
  - getCardsApi
```
CardsApi getCardsApi()
```
    Provides access to Cards controller.
    
    Returns:
    
    Returns the CardsApi instance
  - getCashDrawersApi
```
CashDrawersApi getCashDrawersApi()
```
    Provides access to CashDrawers controller.
    
    Returns:
    
    Returns the CashDrawersApi instance
  - getCatalogApi
```
CatalogApi getCatalogApi()
```
    Provides access to Catalog controller.
    
    Returns:
    
    Returns the CatalogApi instance
  - getCustomersApi
```
CustomersApi getCustomersApi()
```
    Provides access to Customers controller.
    
    Returns:
    
    Returns the CustomersApi instance
  - getCustomerCustomAttributesApi
```
CustomerCustomAttributesApi getCustomerCustomAttributesApi()
```
    Provides access to CustomerCustomAttributes controller.
    
    Returns:
    
    Returns the CustomerCustomAttributesApi instance
  - getCustomerGroupsApi
```
CustomerGroupsApi getCustomerGroupsApi()
```
    Provides access to CustomerGroups controller.
    
    Returns:
    
    Returns the CustomerGroupsApi instance
  - getCustomerSegmentsApi
```
CustomerSegmentsApi getCustomerSegmentsApi()
```
    Provides access to CustomerSegments controller.
    
    Returns:
    
    Returns the CustomerSegmentsApi instance
  - getDevicesApi
```
DevicesApi getDevicesApi()
```
    Provides access to Devices controller.
    
    Returns:
    
    Returns the DevicesApi instance
  - getDisputesApi
```
DisputesApi getDisputesApi()
```
    Provides access to Disputes controller.
    
    Returns:
    
    Returns the DisputesApi instance
  - getEmployeesApi
```
EmployeesApi getEmployeesApi()
```
    Provides access to Employees controller.
    
    Returns:
    
    Returns the EmployeesApi instance
  - getGiftCardsApi
```
GiftCardsApi getGiftCardsApi()
```
    Provides access to GiftCards controller.
    
    Returns:
    
    Returns the GiftCardsApi instance
  - getGiftCardActivitiesApi
```
GiftCardActivitiesApi getGiftCardActivitiesApi()
```
    Provides access to GiftCardActivities controller.
    
    Returns:
    
    Returns the GiftCardActivitiesApi instance
  - getInventoryApi
```
InventoryApi getInventoryApi()
```
    Provides access to Inventory controller.
    
    Returns:
    
    Returns the InventoryApi instance
  - getInvoicesApi
```
InvoicesApi getInvoicesApi()
```
    Provides access to Invoices controller.
    
    Returns:
    
    Returns the InvoicesApi instance
  - getLaborApi
```
LaborApi getLaborApi()
```
    Provides access to Labor controller.
    
    Returns:
    
    Returns the LaborApi instance
  - getLocationsApi
```
LocationsApi getLocationsApi()
```
    Provides access to Locations controller.
    
    Returns:
    
    Returns the LocationsApi instance
  - getLocationCustomAttributesApi
```
LocationCustomAttributesApi getLocationCustomAttributesApi()
```
    Provides access to LocationCustomAttributes controller.
    
    Returns:
    
    Returns the LocationCustomAttributesApi instance
  - getCheckoutApi
```
CheckoutApi getCheckoutApi()
```
    Provides access to Checkout controller.
    
    Returns:
    
    Returns the CheckoutApi instance
  - getTransactionsApi
```
TransactionsApi getTransactionsApi()
```
    Provides access to Transactions controller.
    
    Returns:
    
    Returns the TransactionsApi instance
  - getLoyaltyApi
```
LoyaltyApi getLoyaltyApi()
```
    Provides access to Loyalty controller.
    
    Returns:
    
    Returns the LoyaltyApi instance
  - getMerchantsApi
```
MerchantsApi getMerchantsApi()
```
    Provides access to Merchants controller.
    
    Returns:
    
    Returns the MerchantsApi instance
  - getMerchantCustomAttributesApi
```
MerchantCustomAttributesApi getMerchantCustomAttributesApi()
```
    Provides access to MerchantCustomAttributes controller.
    
    Returns:
    
    Returns the MerchantCustomAttributesApi instance
  - getOrdersApi
```
OrdersApi getOrdersApi()
```
    Provides access to Orders controller.
    
    Returns:
    
    Returns the OrdersApi instance
  - getOrderCustomAttributesApi
```
OrderCustomAttributesApi getOrderCustomAttributesApi()
```
    Provides access to OrderCustomAttributes controller.
    
    Returns:
    
    Returns the OrderCustomAttributesApi instance
  - getPaymentsApi
```
PaymentsApi getPaymentsApi()
```
    Provides access to Payments controller.
    
    Returns:
    
    Returns the PaymentsApi instance
  - getPayoutsApi
```
PayoutsApi getPayoutsApi()
```
    Provides access to Payouts controller.
    
    Returns:
    
    Returns the PayoutsApi instance
  - getRefundsApi
```
RefundsApi getRefundsApi()
```
    Provides access to Refunds controller.
    
    Returns:
    
    Returns the RefundsApi instance
  - getSitesApi
```
SitesApi getSitesApi()
```
    Provides access to Sites controller.
    
    Returns:
    
    Returns the SitesApi instance
  - getSnippetsApi
```
SnippetsApi getSnippetsApi()
```
    Provides access to Snippets controller.
    
    Returns:
    
    Returns the SnippetsApi instance
  - getSubscriptionsApi
```
SubscriptionsApi getSubscriptionsApi()
```
    Provides access to Subscriptions controller.
    
    Returns:
    
    Returns the SubscriptionsApi instance
  - getTeamApi
```
TeamApi getTeamApi()
```
    Provides access to Team controller.
    
    Returns:
    
    Returns the TeamApi instance
  - getTerminalApi
```
TerminalApi getTerminalApi()
```
    Provides access to Terminal controller.
    
    Returns:
    
    Returns the TerminalApi instance
  - getVendorsApi
```
VendorsApi getVendorsApi()
```
    Provides access to Vendors controller.
    
    Returns:
    
    Returns the VendorsApi instance
  - getWebhookSubscriptionsApi
```
WebhookSubscriptionsApi getWebhookSubscriptionsApi()
```
    Provides access to WebhookSubscriptions controller.
    
    Returns:
    
    Returns the WebhookSubscriptionsApi instance
  - getSdkVersion
```
String getSdkVersion()
```
    Current SDK Version.
    
    Returns:
    
    sdkVersion

Interface SquareClientInterface

Method Summary

Methods inherited from interface com.squareup.square.Configuration

Method Detail

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

getSdkVersion