Merge pull request #111 from square/release/36.0.0.20231213

Generated PR for Release: 36.0.0.20231213

Author: jguze

doc/api/catalog.md

@@ -172,7 +172,6 @@ BatchUpsertCatalogObjectsRequest body = new BatchUpsertCatalogObjectsRequest.Bui
                 .presentAtAllLocations(true)
                 .itemData(new CatalogItem.Builder()
                         .name("Tea")
-                        .categoryId("#Beverages")
                         .taxIds(Arrays.asList(
                             "#SalesTax"
                         ))
@@ -193,6 +192,11 @@ BatchUpsertCatalogObjectsRequest body = new BatchUpsertCatalogObjectsRequest.Bui
                                     .build())
                             .build()
                         ))
+                        .categories(Arrays.asList(
+                            new CatalogObjectCategory.Builder()
+                                .id("#Beverages")
+                                .build()
+                        ))
                         .descriptionHtml("<p><strong>Hot</strong> Leaf Juice</p>")
                         .build())
                 .build(),
@@ -203,7 +207,6 @@ BatchUpsertCatalogObjectsRequest body = new BatchUpsertCatalogObjectsRequest.Bui
                 .presentAtAllLocations(true)
                 .itemData(new CatalogItem.Builder()
                         .name("Coffee")
-                        .categoryId("#Beverages")
                         .taxIds(Arrays.asList(
                             "#SalesTax"
                         ))
@@ -239,6 +242,11 @@ BatchUpsertCatalogObjectsRequest body = new BatchUpsertCatalogObjectsRequest.Bui
                                     .build())
                             .build()
                         ))
+                        .categories(Arrays.asList(
+                            new CatalogObjectCategory.Builder()
+                                .id("#Beverages")
+                                .build()
+                        ))
                         .descriptionHtml("<p>Hot <em>Bean Juice</em></p>")
                         .build())
                 .build(),
@@ -592,7 +600,8 @@ any [CatalogTax](../../doc/models/catalog-tax.md) objects that apply to it.
 CompletableFuture<RetrieveCatalogObjectResponse> retrieveCatalogObjectAsync(
     final String objectId,
     final Boolean includeRelatedObjects,
-    final Long catalogVersion)
+    final Long catalogVersion,
+    final Boolean includeCategoryPathToRoot)
 ```
 
 ## Parameters
@@ -602,6 +611,7 @@ CompletableFuture<RetrieveCatalogObjectResponse> retrieveCatalogObjectAsync(
 | `objectId` | `String` | Template, Required | The object ID of any type of catalog objects to be retrieved. |
 | `includeRelatedObjects` | `Boolean` | Query, Optional | If `true`, the response will include additional objects that are related to the<br>requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field<br>of the response. These objects are put in the `related_objects` field. Setting this to `true` is<br>helpful when the objects are needed for immediate display to a user.<br>This process only goes one level deep. Objects referenced by the related objects will not be included. For example,<br><br>if the `objects` field of the response contains a CatalogItem, its associated<br>CatalogCategory objects, CatalogTax objects, CatalogImage objects and<br>CatalogModifierLists will be returned in the `related_objects` field of the<br>response. If the `objects` field of the response contains a CatalogItemVariation,<br>its parent CatalogItem will be returned in the `related_objects` field of<br>the response.<br><br>Default value: `false`<br>**Default**: `false` |
 | `catalogVersion` | `Long` | Query, Optional | Requests objects as of a specific version of the catalog. This allows you to retrieve historical<br>versions of objects. The value to retrieve a specific version of an object can be found<br>in the version field of [CatalogObject](../../doc/models/catalog-object.md)s. If not included, results will<br>be from the current version of the catalog. |
+| `includeCategoryPathToRoot` | `Boolean` | Query, Optional | Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists<br>of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category<br>and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned<br>in the response payload.<br>**Default**: `false` |
 
 ## Response Type
 
@@ -612,8 +622,9 @@ CompletableFuture<RetrieveCatalogObjectResponse> retrieveCatalogObjectAsync(
 ```java
 String objectId = "object_id8";
 Boolean includeRelatedObjects = false;
+Boolean includeCategoryPathToRoot = false;
 
-catalogApi.retrieveCatalogObjectAsync(objectId, includeRelatedObjects, null).thenAccept(result -> {
+catalogApi.retrieveCatalogObjectAsync(objectId, includeRelatedObjects, null, includeCategoryPathToRoot).thenAccept(result -> {
     // TODO success callback handler
     System.out.println(result);
 }).exceptionally(exception -> {

doc/api/checkout.md

@@ -11,6 +11,10 @@ CheckoutApi checkoutApi = client.getCheckoutApi();
 ## Methods
 
 * [Create Checkout](../../doc/api/checkout.md#create-checkout)
+* [Retrieve Location Settings](../../doc/api/checkout.md#retrieve-location-settings)
+* [Update Location Settings](../../doc/api/checkout.md#update-location-settings)
+* [Retrieve Merchant Settings](../../doc/api/checkout.md#retrieve-merchant-settings)
+* [Update Merchant Settings](../../doc/api/checkout.md#update-merchant-settings)
 * [List Payment Links](../../doc/api/checkout.md#list-payment-links)
 * [Create Payment Link](../../doc/api/checkout.md#create-payment-link)
 * [Delete Payment Link](../../doc/api/checkout.md#delete-payment-link)
@@ -160,6 +164,148 @@ checkoutApi.createCheckoutAsync(locationId, body).thenAccept(result -> {
 ```
 
 
+# Retrieve Location Settings
+
+Retrieves the location-level settings for a Square-hosted checkout page.
+
+```java
+CompletableFuture<RetrieveLocationSettingsResponse> retrieveLocationSettingsAsync(
+    final String locationId)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `locationId` | `String` | Template, Required | The ID of the location for which to retrieve settings. |
+
+## Response Type
+
+[`RetrieveLocationSettingsResponse`](../../doc/models/retrieve-location-settings-response.md)
+
+## Example Usage
+
+```java
+String locationId = "location_id4";
+
+checkoutApi.retrieveLocationSettingsAsync(locationId).thenAccept(result -> {
+    // TODO success callback handler
+    System.out.println(result);
+}).exceptionally(exception -> {
+    // TODO failure callback handler
+    exception.printStackTrace();
+    return null;
+});
+```
+
+
+# Update Location Settings
+
+Updates the location-level settings for a Square-hosted checkout page.
+
+```java
+CompletableFuture<UpdateLocationSettingsResponse> updateLocationSettingsAsync(
+    final String locationId,
+    final UpdateLocationSettingsRequest body)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `locationId` | `String` | Template, Required | The ID of the location for which to retrieve settings. |
+| `body` | [`UpdateLocationSettingsRequest`](../../doc/models/update-location-settings-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
+
+## Response Type
+
+[`UpdateLocationSettingsResponse`](../../doc/models/update-location-settings-response.md)
+
+## Example Usage
+
+```java
+String locationId = "location_id4";
+UpdateLocationSettingsRequest body = new UpdateLocationSettingsRequest.Builder(
+    new CheckoutLocationSettings.Builder()
+        .build()
+)
+.build();
+
+checkoutApi.updateLocationSettingsAsync(locationId, body).thenAccept(result -> {
+    // TODO success callback handler
+    System.out.println(result);
+}).exceptionally(exception -> {
+    // TODO failure callback handler
+    exception.printStackTrace();
+    return null;
+});
+```
+
+
+# Retrieve Merchant Settings
+
+Retrieves the merchant-level settings for a Square-hosted checkout page.
+
+```java
+CompletableFuture<RetrieveMerchantSettingsResponse> retrieveMerchantSettingsAsync()
+```
+
+## Response Type
+
+[`RetrieveMerchantSettingsResponse`](../../doc/models/retrieve-merchant-settings-response.md)
+
+## Example Usage
+
+```java
+checkoutApi.retrieveMerchantSettingsAsync().thenAccept(result -> {
+    // TODO success callback handler
+    System.out.println(result);
+}).exceptionally(exception -> {
+    // TODO failure callback handler
+    exception.printStackTrace();
+    return null;
+});
+```
+
+
+# Update Merchant Settings
+
+Updates the merchant-level settings for a Square-hosted checkout page.
+
+```java
+CompletableFuture<UpdateMerchantSettingsResponse> updateMerchantSettingsAsync(
+    final UpdateMerchantSettingsRequest body)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `body` | [`UpdateMerchantSettingsRequest`](../../doc/models/update-merchant-settings-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
+
+## Response Type
+
+[`UpdateMerchantSettingsResponse`](../../doc/models/update-merchant-settings-response.md)
+
+## Example Usage
+
+```java
+UpdateMerchantSettingsRequest body = new UpdateMerchantSettingsRequest.Builder(
+    new CheckoutMerchantSettings.Builder()
+        .build()
+)
+.build();
+
+checkoutApi.updateMerchantSettingsAsync(body).thenAccept(result -> {
+    // TODO success callback handler
+    System.out.println(result);
+}).exceptionally(exception -> {
+    // TODO failure callback handler
+    exception.printStackTrace();
+    return null;
+});
+```
+
+
 # List Payment Links
 
 Lists all payment links.

doc/api/terminal.md

@@ -19,10 +19,12 @@ TerminalApi terminalApi = client.getTerminalApi();
 * [Search Terminal Checkouts](../../doc/api/terminal.md#search-terminal-checkouts)
 * [Get Terminal Checkout](../../doc/api/terminal.md#get-terminal-checkout)
 * [Cancel Terminal Checkout](../../doc/api/terminal.md#cancel-terminal-checkout)
+* [Dismiss Terminal Checkout](../../doc/api/terminal.md#dismiss-terminal-checkout)
 * [Create Terminal Refund](../../doc/api/terminal.md#create-terminal-refund)
 * [Search Terminal Refunds](../../doc/api/terminal.md#search-terminal-refunds)
 * [Get Terminal Refund](../../doc/api/terminal.md#get-terminal-refund)
-* [Cancel Terminal Refund](../../doc/api/terminal.md#cancel-terminal-refund)
+* [Cancel Terminal Refund](../../doc/api/terminal.md#cancel-terminal-refund)
+* [Dismiss Terminal Refund](../../doc/api/terminal.md#dismiss-terminal-refund)
 
 
 # Create Terminal Action
@@ -205,7 +207,7 @@ CompletableFuture<DismissTerminalActionResponse> dismissTerminalActionAsync(
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `actionId` | `String` | Template, Required | Unique ID for the `TerminalAction` associated with the waiting dialog to be dismissed. |
+| `actionId` | `String` | Template, Required | Unique ID for the `TerminalAction` associated with the action to be dismissed. |
 
 ## Response Type
 
@@ -391,6 +393,41 @@ terminalApi.cancelTerminalCheckoutAsync(checkoutId).thenAccept(result -> {
 ```
 
 
+# Dismiss Terminal Checkout
+
+Dismisses a Terminal checkout request if the status and type of the request permits it.
+
+```java
+CompletableFuture<DismissTerminalCheckoutResponse> dismissTerminalCheckoutAsync(
+    final String checkoutId)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `checkoutId` | `String` | Template, Required | Unique ID for the `TerminalCheckout` associated with the checkout to be dismissed. |
+
+## Response Type
+
+[`DismissTerminalCheckoutResponse`](../../doc/models/dismiss-terminal-checkout-response.md)
+
+## Example Usage
+
+```java
+String checkoutId = "checkout_id8";
+
+terminalApi.dismissTerminalCheckoutAsync(checkoutId).thenAccept(result -> {
+    // TODO success callback handler
+    System.out.println(result);
+}).exceptionally(exception -> {
+    // TODO failure callback handler
+    exception.printStackTrace();
+    return null;
+});
+```
+
+
 # Create Terminal Refund
 
 Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API](../../doc/api/refunds.md).
@@ -550,3 +587,38 @@ terminalApi.cancelTerminalRefundAsync(terminalRefundId).thenAccept(result -> {
 });
 ```
 
+
+# Dismiss Terminal Refund
+
+Dismisses a Terminal refund request if the status and type of the request permits it.
+
+```java
+CompletableFuture<DismissTerminalRefundResponse> dismissTerminalRefundAsync(
+    final String terminalRefundId)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `terminalRefundId` | `String` | Template, Required | Unique ID for the `TerminalRefund` associated with the refund to be dismissed. |
+
+## Response Type
+
+[`DismissTerminalRefundResponse`](../../doc/models/dismiss-terminal-refund-response.md)
+
+## Example Usage
+
+```java
+String terminalRefundId = "terminal_refund_id0";
+
+terminalApi.dismissTerminalRefundAsync(terminalRefundId).thenAccept(result -> {
+    // TODO success callback handler
+    System.out.println(result);
+}).exceptionally(exception -> {
+    // TODO failure callback handler
+    exception.printStackTrace();
+    return null;
+});
+```
+

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*: `"2023-11-15"` |
+| `squareVersion` | `String` | Square Connect API versions<br>*Default*: `"2023-12-13"` |
 | `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.md) | 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("2023-11-15")
+    .squareVersion("2023-12-13")
     .accessToken("AccessToken")
     .environment(Environment.PRODUCTION)
     .customUrl("https://connect.squareup.com")
@@ -40,7 +40,7 @@ public class Program {
         SquareClient client = new SquareClient.Builder()
             .httpClientConfig(configBuilder -> configBuilder
                     .timeout(0))
-            .squareVersion("2023-11-15")
+            .squareVersion("2023-12-13")
             .accessToken("AccessToken")
             .build();
 

doc/models/batch-retrieve-catalog-objects-request.md

@@ -13,6 +13,7 @@
 | `IncludeRelatedObjects` | `Boolean` | Optional | If `true`, the response will include additional objects that are related to the<br>requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field<br>of the response. These objects are put in the `related_objects` field. Setting this to `true` is<br>helpful when the objects are needed for immediate display to a user.<br>This process only goes one level deep. Objects referenced by the related objects will not be included. For example,<br><br>if the `objects` field of the response contains a CatalogItem, its associated<br>CatalogCategory objects, CatalogTax objects, CatalogImage objects and<br>CatalogModifierLists will be returned in the `related_objects` field of the<br>response. If the `objects` field of the response contains a CatalogItemVariation,<br>its parent CatalogItem will be returned in the `related_objects` field of<br>the response.<br><br>Default value: `false` | Boolean getIncludeRelatedObjects() |
 | `CatalogVersion` | `Long` | Optional | The specific version of the catalog objects to be included in the response.<br>This allows you to retrieve historical 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. | Long getCatalogVersion() |
 | `IncludeDeletedObjects` | `Boolean` | Optional | Indicates whether to include (`true`) or not (`false`) in the response deleted objects, namely, those with the `is_deleted` attribute set to `true`. | Boolean getIncludeDeletedObjects() |
+| `IncludeCategoryPathToRoot` | `Boolean` | Optional | Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists<br>of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category<br>and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned<br>in the response payload. | Boolean getIncludeCategoryPathToRoot() |
 
 ## Example (as JSON)
 
@@ -24,7 +25,8 @@
     "AA27W3M2GGTF3H6AVPNB77CK"
   ],
   "catalog_version": 190,
-  "include_deleted_objects": false
+  "include_deleted_objects": false,
+  "include_category_path_to_root": false
 }
 ```