Merge pull request #61 from square/release/15.1.0.20210915

Generated PR for Release: 15.1.0.20210915

Author: joanc-sq

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-## Version 15.0.0.20210915 (2021-09-15)
+## Version 15.1.0.20210915 (2021-09-15)
 ## API updates
 
 * **Invoices API:** 
@@ -22,53 +22,6 @@
   * Revised API descriptions for the ObtainToken and Authorize endpoints. Clarified that the Authorize endpoint is not a callable API but is used to direct the seller to the Square authorization page. For more information about the Authorize endpoint, see [Create the Redirect URL and Square Authorization Page URL.](https://developer.squareup.com/docs/oauth-api/create-urls-for-square-authorization)
 
 
-## Version 13.0.0.20210721 (2021-07-21)
-## SDK updates
-  * The [Square Java SDK](https://developer.squareup.com/docs/sdks/java) now lets you customize `HttpClient` by creating an `okhttpclient` instance and setting it in `HttpClientConfiguration` to override the default behavior. 
-
-## API updates
-
-* **Orders  API:** 
-  * [OrderServiceCharge](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderServiceCharge) object. Added a new field, `type`. It identifies the service charge type.
-
-  * [OrderQuantityUnit](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderQuantityUnit), 
-    [OrderLineItem](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderLineItem), 
-    [OrderLineItemDiscount](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderLineItemDiscount), 
-    [OrderLineItemModifier](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderLineItemModifier), 
-    [OrderLineItemTax](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderLineItemTax), 
-    [OrderServiceCharge](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderServiceCharge), 
-    [OrderReturnLineItem](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderReturnLineItem), 
-    [OrderReturnLineItemModifier](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderReturnLineItemModifier), 
-    [OrderReturnServiceCharge](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderReturnServiceCharge), 
-    [OrderReturnTax](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderReturnTax), and 
-    [OrderReturnDiscount](https://developer.squareup.com/reference/square_2021-07-21/objects/OrderReturnDiscount) objects. Added a new field, `catalog_version`.
-* **Locations API:**
-  * [Location](https://developer.squareup.com/reference/square_2021-07-21/objects/Location) object. Added a new field `tax_ids` of type `TaxIds`. In the current implementation, sellers in Ireland and France can configure tax IDs during the onboarding process. They can also provide the information later by updating the location information in the Seller Dashboard. These tax IDs appear in this field.
-
-* **Loyalty API:**
-  * As of July 15, 2021, the country in which the seller’s Square account is activated determines whether Square uses pretax or post-tax purchase amounts to calculate accrued points. This change supports consumption tax models, such as value-added tax (VAT). Previously, point accrual was based on pretax purchase amounts only. This change does not affect the existing point balance of loyalty accounts. For more information, see [Availability of Square Loyalty.](https://developer.squareup.com/docs/loyalty-api/overview#loyalty-market-availability)
-
-* **Payments API:** 
-  * [UpdatePayment](https://developer.squareup.com/reference/square_2021-07-21/payments-api/update-payment). The endpoint has moved to the [general availability](https://developer.squareup.com/docs/build-basics/api-lifecycle#general-availability) (GA) state. Also, you can now update gift card payments (similar to card, cash, and external payments).
-
-* **Subscriptions API:**
-  * The [Subscriptions API](https://developer.squareup.com/docs/subscriptions-api/overview) has moved to the [general availability](https://developer.squareup.com/docs/build-basics/api-lifecycle#general-availability) (GA) state.
-  * [CatalogSubscriptionPlan](https://developer.squareup.com/reference/square_2021-07-21/objects/CatalogSubscriptionPlan) object. The `name` and `price` are now write-once fields. You specify these values at the time  of creating a plan. After the plan is created, these fields cannot be updated. This makes a subscription plan immutable. 
-
-* **Inventory API:**
-  * [RetrieveInventoryTransfer.](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Retrieve-Inventory-Transfer) This new endpoint is introduced to support the retrieval of inventory transfer.
-  * [RetrieveInventoryChanges.](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Retrieve-Inventory-Changes) This endpoint is deprecated. Its support ends when it is retired in about 12 months.  
-  * The following endpoints have updated URLs to conform to the standard REST API convention. For more information about migrating deprecated URLs to updated URLs in your application, see [Inventory API: Migrate to Updated API Entities.](https://developer.squareup.com/docs/inventory-api/migrate-to-updated-api-entities)
-    * [RetrieveInventoryAdjustment](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Retrieve-Inventory-Adjustment)
-    * [BatchChangeInventory](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Batch-Change-Inventory)
-    * [BatchRetrieveInventoryChanges](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Batch-Retrieve-Inventory-Changes) 
-    * [BatchRetrieveInventoryCounts](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Batch-Retrieve-Inventory-Counts)
-    * [RetrieveInventoryPhysicalCount](https://developer.squareup.com/reference/square_2021-07-21/inventory-api/Retrieve-Inventory-Physical-Count)
-
-## Documentation updates
-* **Webhooks.** Revised the steps and descriptions for creating and using webhooks. For more information, see [Webhooks Overview.](https://developer.squareup.com/docs/webhooks/overview)
-
-
 ## Version 12.0.0.20210616 (2021-06-16)
 ## New API releases
 * **Gift Cards API and Gift Card Activities API.** Gift card support is integrated in the [Square Seller Dashboard](https://squareup.com/dashboard/) and the [Square Point of Sale](https://squareup.com/us/en/point-of-sale)  application. Sellers can sell, redeem, track, and reload Square gift cards. Now developers can use the [Gift Cards API](https://developer.squareup.com/reference/square_2021-06-16/gift-cards-api) and the [Gift Card Activities API](https://developer.squareup.com/reference/square_2021-06-16/gift-card-activities-api) to integrate Square gift cards into third-party applications. For more information, see [Gift Cards API Overview.](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api)

README.md

@@ -33,7 +33,7 @@ Install the client dynamically by adding a dependency to the POM for your projec
 <dependency>
     <groupId>com.squareup</groupId>
     <artifactId>square</artifactId>
-    <version>15.0.0.20210915</version>
+    <version>15.1.0.20210915</version>
 </dependency>
 ```
 
@@ -42,7 +42,7 @@ Install the client dynamically by adding a dependency to the POM for your projec
 Install the client by adding the following dependency to the build file for your project:
 
 ```
-implementation "com.squareup:square:15.0.0.20210915"
+implementation "com.squareup:square:15.1.0.20210915"
 ```
 
 ## API documentation
@@ -53,6 +53,9 @@ implementation "com.squareup:square:15.0.0.20210915"
 * [Disputes]
 * [Checkout]
 * [Apple Pay]
+* [Cards]
+
+### Terminal
 * [Terminal]
 
 ### Orders
@@ -76,19 +79,22 @@ implementation "com.squareup:square:15.0.0.20210915"
 ### Loyalty
 * [Loyalty]
 
+### Gift Cards
+* [Gift Cards]
+* [Gift Card Activities]
+
 ### Bookings
 * [Bookings]
 
 ### Business
 * [Merchants]
 * [Locations]
 * [Devices]
+* [Cash Drawers]
 
 ### Team
 * [Team]
-* [Employees]
 * [Labor]
-* [Cash Drawers]
 
 ### Financials
 * [Bank Accounts]
@@ -102,6 +108,7 @@ implementation "com.squareup:square:15.0.0.20210915"
 * [OAuth]
 
 ### Deprecated APIs
+* [Employees]
 * [V1 Employees]
 * [V1 Transactions]
 * [V1 Items]
@@ -349,3 +356,6 @@ You can also use the Square API to create applications or services that work wit
 [Transactions]: doc/api/transactions.md
 [Sites]: doc/api/sites.md
 [Snippets]: doc/api/snippets.md
+[Cards]: doc/api/cards.md
+[Gift Cards]: doc/api/gift-cards.md
+[Gift Card Activities]: doc/api/gift-card-activities.md

doc/api/catalog.md

@@ -485,9 +485,9 @@ CatalogObject requestImage = new CatalogObject.Builder(
     .imageData(requestImageImageData)
     .build();
 CreateCatalogImageRequest request = new CreateCatalogImageRequest.Builder(
-        "528dea59-7bfb-43c1-bd48-4a6bba7dd61f86")
+        "528dea59-7bfb-43c1-bd48-4a6bba7dd61f86",
+        requestImage)
     .objectId("ND6EA5AAJEO5WL3JNNIAQA32")
-    .image(requestImage)
     .build();
 FileWrapper imageFile = new FileWrapper(new File("dummy_file"), "optional-content-type");
 
@@ -813,7 +813,7 @@ catalogApi.retrieveCatalogObjectAsync(objectId, includeRelatedObjects, catalogVe
 # Search Catalog Objects
 
 Searches for [CatalogObject](/doc/models/catalog-object.md) of any type by matching supported search attribute values,
-excluding custom attribute values on items or item variations, against one or more of the specified query expressions.
+excluding custom attribute values on items or item variations, against one or more of the specified query filters.
 
 This (`SearchCatalogObjects`) endpoint differs from the [SearchCatalogItems](/doc/api/catalog.md#search-catalog-items)
 endpoint in the following aspects:
@@ -896,7 +896,7 @@ catalogApi.searchCatalogObjectsAsync(body).thenAccept(result -> {
 # Search Catalog Items
 
 Searches for catalog items or item variations by matching supported search attribute values, including
-custom attribute values, against one or more of the specified query expressions.
+custom attribute values, against one or more of the specified query filters.
 
 This (`SearchCatalogItems`) endpoint differs from the [SearchCatalogObjects](/doc/api/catalog.md#search-catalog-objects)
 endpoint in the following aspects:

doc/api/checkout.md

@@ -50,6 +50,7 @@ MeasurementUnit bodyOrderOrderLineItems0QuantityUnitMeasurementUnit = new Measur
 OrderQuantityUnit bodyOrderOrderLineItems0QuantityUnit = new OrderQuantityUnit.Builder()
     .measurementUnit(bodyOrderOrderLineItems0QuantityUnitMeasurementUnit)
     .precision(191)
+    .catalogObjectId("catalog_object_id7")
     .catalogVersion(131L)
     .build();
 List<OrderLineItemAppliedTax> bodyOrderOrderLineItems0AppliedTaxes = new LinkedList<>();
@@ -104,6 +105,7 @@ MeasurementUnit bodyOrderOrderLineItems1QuantityUnitMeasurementUnit = new Measur
 OrderQuantityUnit bodyOrderOrderLineItems1QuantityUnit = new OrderQuantityUnit.Builder()
     .measurementUnit(bodyOrderOrderLineItems1QuantityUnitMeasurementUnit)
     .precision(192)
+    .catalogObjectId("catalog_object_id6")
     .catalogVersion(130L)
     .build();
 Money bodyOrderOrderLineItems1BasePriceMoney = new Money.Builder()
@@ -130,6 +132,7 @@ MeasurementUnit bodyOrderOrderLineItems2QuantityUnitMeasurementUnit = new Measur
 OrderQuantityUnit bodyOrderOrderLineItems2QuantityUnit = new OrderQuantityUnit.Builder()
     .measurementUnit(bodyOrderOrderLineItems2QuantityUnitMeasurementUnit)
     .precision(193)
+    .catalogObjectId("catalog_object_id5")
     .catalogVersion(129L)
     .build();
 Money bodyOrderOrderLineItems2BasePriceMoney = new Money.Builder()

doc/api/customer-groups.md

@@ -23,14 +23,16 @@ Retrieves the list of customer groups of a business.
 
 ```java
 CompletableFuture<ListCustomerGroupsResponse> listCustomerGroupsAsync(
-    final String cursor)
+    final String cursor,
+    final Integer limit)
 ```
 
 ## Parameters
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `cursor` | `String` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.<br>Provide this cursor to retrieve the next set of results for your original query.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
+| `limit` | `Integer` | Query, Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.<br>The limit is ignored if it is less than 1 or greater than 50. The default value is 50.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
 
 ## Response Type
 
@@ -40,8 +42,9 @@ CompletableFuture<ListCustomerGroupsResponse> listCustomerGroupsAsync(
 
 ```java
 String cursor = "cursor6";
+Integer limit = 172;
 
-customerGroupsApi.listCustomerGroupsAsync(cursor).thenAccept(result -> {
+customerGroupsApi.listCustomerGroupsAsync(cursor, limit).thenAccept(result -> {
     // TODO success callback handler
 }).exceptionally(exception -> {
     // TODO failure callback handler

doc/api/customer-segments.md

@@ -20,14 +20,16 @@ Retrieves the list of customer segments of a business.
 
 ```java
 CompletableFuture<ListCustomerSegmentsResponse> listCustomerSegmentsAsync(
-    final String cursor)
+    final String cursor,
+    final Integer limit)
 ```
 
 ## Parameters
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `cursor` | `String` | Query, Optional | A pagination cursor returned by previous calls to `ListCustomerSegments`.<br>This cursor is used to retrieve the next set of query results.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
+| `limit` | `Integer` | Query, Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.<br>The limit is ignored if it is less than 1 or greater than 50. The default value is 50.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
 
 ## Response Type
 
@@ -37,8 +39,9 @@ CompletableFuture<ListCustomerSegmentsResponse> listCustomerSegmentsAsync(
 
 ```java
 String cursor = "cursor6";
+Integer limit = 172;
 
-customerSegmentsApi.listCustomerSegmentsAsync(cursor).thenAccept(result -> {
+customerSegmentsApi.listCustomerSegmentsAsync(cursor, limit).thenAccept(result -> {
     // TODO success callback handler
 }).exceptionally(exception -> {
     // TODO failure callback handler

doc/api/customers.md

@@ -33,6 +33,7 @@ profiles can take closer to one minute or longer, especially during network inci
 ```java
 CompletableFuture<ListCustomersResponse> listCustomersAsync(
     final String cursor,
+    final Integer limit,
     final String sortField,
     final String sortOrder)
 ```
@@ -42,8 +43,9 @@ CompletableFuture<ListCustomersResponse> listCustomersAsync(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `cursor` | `String` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.<br>Provide this cursor to retrieve the next set of results for your original query.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
-| `sortField` | [`String`](/doc/models/customer-sort-field.md) | Query, Optional | Indicates how customers should be sorted.<br><br>Default: `DEFAULT`. |
-| `sortOrder` | [`String`](/doc/models/sort-order.md) | Query, Optional | Indicates whether customers should be sorted in ascending (`ASC`) or<br>descending (`DESC`) order.<br><br>Default: `ASC`. |
+| `limit` | `Integer` | Query, Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.<br>The limit is ignored if it is less than 1 or greater than 100. The default value is 100.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
+| `sortField` | [`String`](/doc/models/customer-sort-field.md) | Query, Optional | Indicates how customers should be sorted.<br><br>The default value is `DEFAULT`. |
+| `sortOrder` | [`String`](/doc/models/sort-order.md) | Query, Optional | Indicates whether customers should be sorted in ascending (`ASC`) or<br>descending (`DESC`) order.<br><br>The default value is `ASC`. |
 
 ## Response Type
 
@@ -53,10 +55,11 @@ CompletableFuture<ListCustomersResponse> listCustomersAsync(
 
 ```java
 String cursor = "cursor6";
+Integer limit = 172;
 String sortField = "DEFAULT";
 String sortOrder = "DESC";
 
-customersApi.listCustomersAsync(cursor, sortField, sortOrder).thenAccept(result -> {
+customersApi.listCustomersAsync(cursor, limit, sortField, sortOrder).thenAccept(result -> {
     // TODO success callback handler
 }).exceptionally(exception -> {
     // TODO failure callback handler

doc/api/gift-cards.md

@@ -67,8 +67,8 @@ giftCardsApi.listGiftCardsAsync(type, state, limit, cursor, customerId).thenAcce
 
 # Create Gift Card
 
-Creates a digital gift card. You must activate the gift card before
-it can be used. For more information, see
+Creates a digital gift card or registers a physical (plastic) gift card. You must activate the gift card before
+it can be used for payment. For more information, see
 [Selling gift cards](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#selling-square-gift-cards).
 
 ```java

doc/api/invoices.md

@@ -165,6 +165,7 @@ Invoice bodyInvoice = new Invoice.Builder()
     .scheduledAt("2030-01-13T10:00:00Z")
     .acceptedPaymentMethods(bodyInvoiceAcceptedPaymentMethods)
     .customFields(bodyInvoiceCustomFields)
+    .saleOrServiceDate("2030-01-24")
     .build();
 CreateInvoiceRequest body = new CreateInvoiceRequest.Builder(
         bodyInvoice)