The Square Connect Java SDK is retired (EOL) as of 2019-12-17 and will no longer receive bug fixes or product updates. To continue receiving API and SDK improvements, please follow the instructions below to migrate to the new Square Java SDK.
The old Connect SDK documentation is available under the
/docs folder.
Follow the instructions below to migrate your apps from the deprecated
com.squareup.connect library to the new com.squareup.square library.
Update the dependency in your Maven or Gradle project.
Update the Square dependency in the POM for your project:
<dependency>
<groupId>com.squareup</groupId>
<artifactId>square</artifactId>
<version>4.0.0.20191217</version>
<scope>compile</scope>
</dependency>
Replace the com.squareup.connect dependency in the build file of your project:
implementation "com.squareup:square:4.0.0.20191217"
- Change all instances of
import com.squareup.connect'toimport com.squareup.square. - Update client instantiation to follow the method outlined below.
- Use
thenAcceptandexceptionallyrather thantryandcatchfor flow control.
To simplify your code, we also recommend that you use method chaining to access APIs instead of explicitly instantiating multiple clients.
import com.squareup.square.SquareClient; import com.squareup.square.Environment; SquareClient square = new SquareClient.Builder() .environment(Environment.SANDBOX) .accessToken("YOUR_SANDBOX_ACCESS_TOKEN") .build();
Using listLocations as an example
square.getLocationsApi().listLocationsAsync().thenAccept(result -> { // Business logic }).exceptionally(exception -> { // Exception handling return null; });
As a specific example, consider the code used to create a new customer
profile with the following CreateCustomerRequest object:
Address bodyAddress = new Address.Builder() .addressLine1("500 Electric Ave") .addressLine2("Suite 600") .locality("New York") .administrativeDistrictLevel1("NY") .postalCode("10003") .country("US") .build(); CreateCustomerRequest body = new CreateCustomerRequest.Builder() .givenName("Amelia") .familyName("Earhart") .emailAddress("[email protected]") .address(bodyAddress) .phoneNumber("1-212-555-4240") .referenceId("YOUR_REFERENCE_ID") .note("a customer") .build();
With the deprecated squareup.connect library, this is how you instantiate a client
for the Customers API, format the request, and call the endpoint:
ApiClient defaultClient = Configuration.getDefaultApiClient(); CustomersApi customersApi = new CustomersApi(); try { CreateCustomerResponse result = customersApi.createCustomer(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling CustomersApi.createCustomer"); e.printStackTrace(); }
Now consider equivalent code using the new squareup.square library:
// Instantiate the client SquareClient square = new SquareClient.Builder() .environment(Environment.SANDBOX) .accessToken("YOUR_SANDBOX_ACCESS_TOKEN") .build(); // Call the endpoint square.getCustomersApi().createCustomerAsync(body).thenAccept(result -> { System.out.println("Successfully created customer with id:"+ result.getCustomer().getId()); }).exceptionally(e -> { System.err.println("Exception when calling CustomersApi.createCustomer"); e.printStackTrace(); return null; });
That's it!
What was once a multi-object process can be handled asynchronously with a single
client. Migrating to the com.squareup.square library reduces boilerplate and lets
you focus on the parts of your code that really matter.
Please join us in our Square developer community if you have any questions!