Merge pull request #80 from square/release/20.1.0.20220616

Generated PR for Release: 20.1.0.20220616

Author: Wolfgang Schuster

doc/api/catalog.md

@@ -417,7 +417,7 @@ CompletableFuture<ListCatalogResponse> listCatalogAsync(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `cursor` | `String` | Query, Optional | The pagination cursor returned in the previous response. Leave unset for an initial request.<br>The page size is currently set to be 100.<br>See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. |
-| `types` | `String` | Query, Optional | An optional case-insensitive, comma-separated list of object types to retrieve.<br><br>The valid values are defined in the [CatalogObjectType](../../doc/models/catalog-object-type.md) enum, for example,<br>`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,<br>`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.<br><br>If this is unspecified, the operation returns objects of all the top level types at the version<br>of the Square API used to make the request. Object types that are nested onto other object types<br>are not included in the defaults.<br><br>At the current API version the default object types are:<br>ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, DINING_OPTION, TAX_EXEMPTION,<br>SERVICE_CHARGE, PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,<br>SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS. |
+| `types` | `String` | Query, Optional | An optional case-insensitive, comma-separated list of object types to retrieve.<br><br>The valid values are defined in the [CatalogObjectType](../../doc/models/catalog-object-type.md) enum, for example,<br>`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,<br>`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.<br><br>If this is unspecified, the operation returns objects of all the top level types at the version<br>of the Square API used to make the request. Object types that are nested onto other object types<br>are not included in the defaults.<br><br>At the current API version the default object types are:<br>ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST,<br>PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,<br>SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS. |
 | `catalogVersion` | `Long` | Query, Optional | The specific version of the catalog objects to be included in the response.<br>This allows you to retrieve historical<br>versions of objects. The specified version value is matched against<br>the [CatalogObject](../../doc/models/catalog-object.md)s' `version` attribute.  If not included, results will<br>be from the current version of the catalog. |
 
 ## Response Type

doc/api/gift-cards.md

@@ -22,7 +22,7 @@ GiftCardsApi giftCardsApi = client.getGiftCardsApi();
 # List Gift Cards
 
 Lists all gift cards. You can specify optional filters to retrieve
-a subset of the gift cards.
+a subset of the gift cards. Results are sorted by `created_at` in ascending order.
 
 ```java
 CompletableFuture<ListGiftCardsResponse> listGiftCardsAsync(

doc/api/loyalty.md

@@ -154,15 +154,17 @@ loyaltyApi.retrieveLoyaltyAccountAsync(accountId).thenAccept(result -> {
 
 # Accumulate Loyalty Points
 
-Adds points to a loyalty account.
+Adds points earned from the base loyalty program to a loyalty account.
 
 - If you are using the Orders API to manage orders, you only provide the `order_id`.
   The endpoint reads the order to compute points to add to the buyer's account.
 - If you are not using the Orders API to manage orders,
   you first perform a client-side computation to compute the points.  
   For spend-based and visit-based programs, you can first call
   [CalculateLoyaltyPoints](../../doc/api/loyalty.md#calculate-loyalty-points) to compute the points  
-  that you provide to this endpoint.
+  that you provide to this endpoint.
+
+This endpoint excludes additional points earned from loyalty promotions.
 
 ```java
 CompletableFuture<AccumulateLoyaltyPointsResponse> accumulateLoyaltyPointsAsync(
@@ -368,7 +370,7 @@ loyaltyApi.retrieveLoyaltyProgramAsync(programId).thenAccept(result -> {
 
 # Calculate Loyalty Points
 
-Calculates the points a purchase earns.
+Calculates the points a purchase earns from the base loyalty program.
 
 - If you are using the Orders API to manage orders, you provide the `order_id` in the request. The
   endpoint calculates the points by reading the order.

doc/api/terminal.md

@@ -26,8 +26,7 @@ TerminalApi terminalApi = client.getTerminalApi();
 
 # Create Terminal Action
 
-Creates a Terminal action request and sends it to the specified device to take a payment
-for the requested amount.
+Creates a Terminal action request and sends it to the specified device.
 
 ```java
 CompletableFuture<CreateTerminalActionResponse> createTerminalActionAsync(

doc/client.md

@@ -5,7 +5,7 @@ The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| `squareVersion` | `String` | Square Connect API versions<br>*Default*: `"2022-05-12"` |
+| `squareVersion` | `String` | Square Connect API versions<br>*Default*: `"2022-06-16"` |
 | `customUrl` | `String` | Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`<br>*Default*: `"https://connect.squareup.com"` |
 | `environment` | `string` | The API environment. <br> **Default: `production`** |
 | `httpClientConfig` | `ReadonlyHttpClientConfiguration` | Http Client Configuration instance. |
@@ -19,7 +19,7 @@ The API client can be initialized as follows:
 SquareClient client = new SquareClient.Builder()
     .httpClientConfig(configBuilder -> configBuilder
             .timeout(0))
-    .squareVersion("2022-05-12")
+    .squareVersion("2022-06-16")
     .accessToken("AccessToken")
     .environment(Environment.PRODUCTION)
     .customUrl("https://connect.squareup.com")
@@ -45,7 +45,7 @@ public class Program {
         SquareClient client = new SquareClient.Builder()
             .httpClientConfig(configBuilder -> configBuilder
                     .timeout(0))
-            .squareVersion("2022-05-12")
+            .squareVersion("2022-06-16")
             .accessToken("AccessToken")
             .build();
 

doc/models/appointment-segment.md

@@ -12,9 +12,9 @@ Defines an appointment segment of a booking.
 | Name | Type | Tags | Description | Getter |
 |  --- | --- | --- | --- | --- |
 | `DurationMinutes` | `Integer` | Optional | The time span in minutes of an appointment segment.<br>**Constraints**: `<= 1500` | Integer getDurationMinutes() |
-| `ServiceVariationId` | `String` | Required | The ID of the [CatalogItemVariation](../../doc/models/catalog-item-variation.md) object representing the service booked in this segment.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | String getServiceVariationId() |
+| `ServiceVariationId` | `String` | Optional | The ID of the [CatalogItemVariation](../../doc/models/catalog-item-variation.md) object representing the service booked in this segment.<br>**Constraints**: *Maximum Length*: `36` | String getServiceVariationId() |
 | `TeamMemberId` | `String` | Required | The ID of the [TeamMember](../../doc/models/team-member.md) object representing the team member booked in this segment.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `32` | String getTeamMemberId() |
-| `ServiceVariationVersion` | `long` | Required | The current version of the item variation representing the service booked in this segment. | long getServiceVariationVersion() |
+| `ServiceVariationVersion` | `Long` | Optional | The current version of the item variation representing the service booked in this segment. | Long getServiceVariationVersion() |
 | `IntermissionMinutes` | `Integer` | Optional | Time between the end of this segment and the beginning of the subsequent segment. | Integer getIntermissionMinutes() |
 | `AnyTeamMember` | `Boolean` | Optional | Whether the customer accepts any team member, instead of a specific one, to serve this segment. | Boolean getAnyTeamMember() |
 | `ResourceIds` | `List<String>` | Optional | The IDs of the seller-accessible resources used for this appointment segment. | List<String> getResourceIds() |
@@ -24,9 +24,9 @@ Defines an appointment segment of a booking.
 ```json
 {
   "duration_minutes": null,
-  "service_variation_id": "service_variation_id6",
+  "service_variation_id": null,
   "team_member_id": "team_member_id0",
-  "service_variation_version": 56,
+  "service_variation_version": null,
   "intermission_minutes": null,
   "any_team_member": null,
   "resource_ids": null

doc/models/batch-retrieve-inventory-changes-request.md

@@ -13,9 +13,10 @@
 | `LocationIds` | `List<String>` | Optional | The filter to return results by `Location` ID.<br>The filter is only applicable when set. The default value is null. | List<String> getLocationIds() |
 | `Types` | [`List<String>`](../../doc/models/inventory-change-type.md) | Optional | The filter to return results by `InventoryChangeType` values other than `TRANSFER`.<br>The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`. | List<String> getTypes() |
 | `States` | [`List<String>`](../../doc/models/inventory-state.md) | Optional | The filter to return `ADJUSTMENT` query results by<br>`InventoryState`. This filter is only applied when set.<br>The default value is null. | List<String> getStates() |
-| `UpdatedAfter` | `String` | Optional | The filter to return results with their `calculated_at` value  <br>after the given time as specified in an RFC 3339 timestamp.<br>The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). | String getUpdatedAfter() |
-| `UpdatedBefore` | `String` | Optional | The filter to return results with their `created_at` or `calculated_at` value  <br>strictly before the given time as specified in an RFC 3339 timestamp.<br>The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). | String getUpdatedBefore() |
+| `UpdatedAfter` | `String` | Optional | The filter to return results with their `calculated_at` value<br>after the given time as specified in an RFC 3339 timestamp.<br>The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). | String getUpdatedAfter() |
+| `UpdatedBefore` | `String` | Optional | The filter to return results with their `created_at` or `calculated_at` value<br>strictly before the given time as specified in an RFC 3339 timestamp.<br>The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). | String getUpdatedBefore() |
 | `Cursor` | `String` | Optional | A pagination cursor returned by a previous call to this endpoint.<br>Provide this to retrieve the next set of results for the original query.<br><br>See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. | String getCursor() |
+| `Limit` | `Integer` | Optional | **Constraints**: `>= 1`, `<= 1000` | Integer getLimit() |
 
 ## Example (as JSON)
 

doc/models/batch-retrieve-inventory-counts-request.md

@@ -14,6 +14,7 @@
 | `UpdatedAfter` | `String` | Optional | The filter to return results with their `calculated_at` value<br>after the given time as specified in an RFC 3339 timestamp.<br>The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). | String getUpdatedAfter() |
 | `Cursor` | `String` | Optional | A pagination cursor returned by a previous call to this endpoint.<br>Provide this to retrieve the next set of results for the original query.<br><br>See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. | String getCursor() |
 | `States` | [`List<String>`](../../doc/models/inventory-state.md) | Optional | The filter to return results by `InventoryState`. The filter is only applicable when set.<br>Ignored are untracked states of `NONE`, `SOLD`, and `UNLINKED_RETURN`.<br>The default is null. | List<String> getStates() |
+| `Limit` | `Integer` | Optional | **Constraints**: `>= 1`, `<= 1000` | Integer getLimit() |
 
 ## Example (as JSON)
 

doc/models/calculate-loyalty-points-response.md

@@ -13,7 +13,7 @@ a specified purchase.
 | Name | Type | Tags | Description | Getter |
 |  --- | --- | --- | --- | --- |
 | `Errors` | [`List<Error>`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | List<Error> getErrors() |
-| `Points` | `Integer` | Optional | The points that the buyer can earn from a specified purchase. | Integer getPoints() |
+| `Points` | `Integer` | Optional | The points that the buyer can earn from a specified purchase.<br>This value does not include additional points earned from a loyalty promotion. | Integer getPoints() |
 
 ## Example (as JSON)
 

doc/models/cancel-terminal-action-response.md

@@ -10,7 +10,7 @@
 | Name | Type | Tags | Description | Getter |
 |  --- | --- | --- | --- | --- |
 | `Errors` | [`List<Error>`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | List<Error> getErrors() |
-| `Action` | [`TerminalAction`](../../doc/models/terminal-action.md) | Optional | - | TerminalAction getAction() |
+| `Action` | [`TerminalAction`](../../doc/models/terminal-action.md) | Optional | Represents an action processed by the Square Terminal. | TerminalAction getAction() |
 
 ## Example (as JSON)