Merge pull request #103 from square/release/30.0.0.20230608

Generated PR for Release: 30.0.0.20230608

Author: jessdelacruzsantos

doc/api/o-auth.md

@@ -37,7 +37,7 @@ following format:
 Authorization: Client APPLICATION_SECRET
 ```
 
-Replace `APPLICATION_SECRET` with the application secret on the Credentials
+Replace `APPLICATION_SECRET` with the application secret on the **Credentials**
 page in the [Developer Dashboard](https://developer.squareup.com/apps).
 
 :information_source: **Note** This endpoint does not require authentication.
@@ -53,7 +53,7 @@ CompletableFuture<RenewTokenResponse> renewTokenAsync(
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `clientId` | `String` | Template, Required | Your application ID, which is available in the OAuth page in the [Developer Dashboard](https://developer.squareup.com/apps). |
+| `clientId` | `String` | Template, Required | Your application ID, which is available on the **OAuth** page in the [Developer Dashboard](https://developer.squareup.com/apps). |
 | `body` | [`RenewTokenRequest`](../../doc/models/renew-token-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
 | `authorization` | `String` | Header, Required | Client APPLICATION_SECRET |
 
@@ -98,8 +98,8 @@ following format:
 Authorization: Client APPLICATION_SECRET
 ```
 
-Replace `APPLICATION_SECRET` with the application secret on the OAuth
-page for your application on the Developer Dashboard.
+Replace `APPLICATION_SECRET` with the application secret on the **OAuth**
+page for your application in the Developer Dashboard.
 
 :information_source: **Note** This endpoint does not require authentication.
 
@@ -150,7 +150,7 @@ returns only an access token.
 The `grant_type` parameter specifies the type of OAuth request. If
 `grant_type` is `authorization_code`, you must include the authorization
 code you received when a seller granted you authorization. If `grant_type`
-is `refresh_token`, you must provide a valid refresh token. If you are using
+is `refresh_token`, you must provide a valid refresh token. If you're using
 an old version of the Square APIs (prior to March 13, 2019), `grant_type`
 can be `migration_token` and you must provide a valid migration token.
 

doc/api/subscriptions.md

@@ -24,12 +24,14 @@ SubscriptionsApi subscriptionsApi = client.getSubscriptionsApi();
 
 # Create Subscription
 
-Creates a subscription to a subscription plan by a customer.
+Enrolls a customer in a subscription.
 
 If you provide a card on file in the request, Square charges the card for
-the subscription. Otherwise, Square bills an invoice to the customer's email
+the subscription. Otherwise, Square sends an invoice to the customer's email
 address. The subscription starts immediately, unless the request includes
-the optional `start_date`. Each individual subscription is associated with a particular location.
+the optional `start_date`. Each individual subscription is associated with a particular location.
+
+For more information, see [Create a subscription](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions#create-a-subscription).
 
 ```java
 CompletableFuture<CreateSubscriptionResponse> createSubscriptionAsync(
@@ -51,10 +53,10 @@ CompletableFuture<CreateSubscriptionResponse> createSubscriptionAsync(
 ```java
 CreateSubscriptionRequest body = new CreateSubscriptionRequest.Builder(
     "S8GWD5R9QB376",
-    "6JHXF3B2CW3YKHDV4XEM674H",
     "CHFGVKYY8RSV93M5KCYTG4PN0G"
 )
 .idempotencyKey("8193148c-9586-11e6-99f9-28cfe92138cf")
+.planId("6JHXF3B2CW3YKHDV4XEM674H")
 .startDate("2021-10-20")
 .taxPercentage("5")
 .priceOverrideMoney(new Money.Builder()
@@ -94,10 +96,7 @@ If left unset, all customers
 associated with the specified locations are returned.
 If the request specifies customer IDs, the endpoint orders results
 first by location, within location by customer ID, and within
-customer by subscription creation date.
-
-For more information, see
-[Retrieve subscriptions](https://developer.squareup.com/docs/subscriptions-api/overview#retrieve-subscriptions).
+customer by subscription creation date.
 
 ```java
 CompletableFuture<SearchSubscriptionsResponse> searchSubscriptionsAsync(
@@ -146,7 +145,7 @@ subscriptionsApi.searchSubscriptionsAsync(body).thenAccept(result -> {
 
 # Retrieve Subscription
 
-Retrieves a subscription.
+Retrieves a specific subscription.
 
 ```java
 CompletableFuture<RetrieveSubscriptionResponse> retrieveSubscriptionAsync(
@@ -183,8 +182,8 @@ subscriptionsApi.retrieveSubscriptionAsync(subscriptionId, null).thenAccept(resu
 
 # Update Subscription
 
-Updates a subscription. You can set, modify, and clear the
-`subscription` field values.
+Updates a subscription by modifying or clearing `subscription` field values.
+To clear a field, set its value to `null`.
 
 ```java
 CompletableFuture<UpdateSubscriptionResponse> updateSubscriptionAsync(
@@ -263,9 +262,9 @@ subscriptionsApi.deleteSubscriptionActionAsync(subscriptionId, actionId).thenAcc
 
 # Cancel Subscription
 
-Schedules a `CANCEL` action to cancel an active subscription
-by setting the `canceled_date` field to the end of the active billing period
-and changing the subscription status from ACTIVE to CANCELED after this date.
+Schedules a `CANCEL` action to cancel an active subscription. This
+sets the `canceled_date` field to the end of the active billing period. After this date,
+the subscription status changes from ACTIVE to CANCELED.
 
 ```java
 CompletableFuture<CancelSubscriptionResponse> cancelSubscriptionAsync(
@@ -300,7 +299,7 @@ subscriptionsApi.cancelSubscriptionAsync(subscriptionId).thenAccept(result -> {
 
 # List Subscription Events
 
-Lists all events for a specific subscription.
+Lists all [events](https://developer.squareup.com/docs/subscriptions-api/actions-events) for a specific subscription.
 
 ```java
 CompletableFuture<ListSubscriptionEventsResponse> listSubscriptionEventsAsync(
@@ -314,7 +313,7 @@ CompletableFuture<ListSubscriptionEventsResponse> listSubscriptionEventsAsync(
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `subscriptionId` | `String` | Template, Required | The ID of the subscription to retrieve the events for. |
-| `cursor` | `String` | Query, Optional | When the total number of resulting subscription events exceeds the limit of a paged response,<br>specify the cursor returned from a preceding response here to fetch the next set of results.<br>If the cursor is unset, the response contains the last page of the results.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
+| `cursor` | `String` | Query, Optional | When the total number of resulting subscription events exceeds the limit of a paged response,<br>specify the cursor returned from a preceding response here to fetch the next set of results.<br>If the cursor is unset, the response contains the last page of the results.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). |
 | `limit` | `Integer` | Query, Optional | The upper limit on the number of subscription events to return<br>in a paged response. |
 
 ## Response Type
@@ -417,7 +416,8 @@ subscriptionsApi.resumeSubscriptionAsync(subscriptionId, body).thenAccept(result
 
 # Swap Plan
 
-Schedules a `SWAP_PLAN` action to swap a subscription plan in an existing subscription.
+Schedules a `SWAP_PLAN` action to swap a subscription plan variation in an existing subscription.
+For more information, see [Swap Subscription Plan Variations](https://developer.squareup.com/docs/subscriptions-api/swap-plan-variations).
 
 ```java
 CompletableFuture<SwapPlanResponse> swapPlanAsync(
@@ -440,10 +440,8 @@ CompletableFuture<SwapPlanResponse> swapPlanAsync(
 
 ```java
 String subscriptionId = "subscription_id0";
-SwapPlanRequest body = new SwapPlanRequest.Builder(
-    null
-)
-.build();
+SwapPlanRequest body = new SwapPlanRequest.Builder()
+    .build();
 
 subscriptionsApi.swapPlanAsync(subscriptionId, body).thenAccept(result -> {
     // TODO success callback handler

doc/api/terminal.md

@@ -14,6 +14,7 @@ TerminalApi terminalApi = client.getTerminalApi();
 * [Search Terminal Actions](../../doc/api/terminal.md#search-terminal-actions)
 * [Get Terminal Action](../../doc/api/terminal.md#get-terminal-action)
 * [Cancel Terminal Action](../../doc/api/terminal.md#cancel-terminal-action)
+* [Dismiss Terminal Action](../../doc/api/terminal.md#dismiss-terminal-action)
 * [Create Terminal Checkout](../../doc/api/terminal.md#create-terminal-checkout)
 * [Search Terminal Checkouts](../../doc/api/terminal.md#search-terminal-checkouts)
 * [Get Terminal Checkout](../../doc/api/terminal.md#get-terminal-checkout)
@@ -132,7 +133,7 @@ CompletableFuture<GetTerminalActionResponse> getTerminalActionAsync(
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `actionId` | `String` | Template, Required | Unique ID for the desired `TerminalAction` |
+| `actionId` | `String` | Template, Required | Unique ID for the desired `TerminalAction`. |
 
 ## Response Type
 
@@ -167,7 +168,7 @@ CompletableFuture<CancelTerminalActionResponse> cancelTerminalActionAsync(
 
 | Parameter | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `actionId` | `String` | Template, Required | Unique ID for the desired `TerminalAction` |
+| `actionId` | `String` | Template, Required | Unique ID for the desired `TerminalAction`. |
 
 ## Response Type
 
@@ -189,6 +190,43 @@ terminalApi.cancelTerminalActionAsync(actionId).thenAccept(result -> {
 ```
 
 
+# Dismiss Terminal Action
+
+Dismisses a Terminal action request if the status and type of the request permits it.
+
+See [Link and Dismiss Actions](https://developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/link-and-dismiss-actions) for more details.
+
+```java
+CompletableFuture<DismissTerminalActionResponse> dismissTerminalActionAsync(
+    final String actionId)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `actionId` | `String` | Template, Required | Unique ID for the `TerminalAction` associated with the waiting dialog to be dismissed. |
+
+## Response Type
+
+[`DismissTerminalActionResponse`](../../doc/models/dismiss-terminal-action-response.md)
+
+## Example Usage
+
+```java
+String actionId = "action_id6";
+
+terminalApi.dismissTerminalActionAsync(actionId).thenAccept(result -> {
+    // TODO success callback handler
+    System.out.println(result);
+}).exceptionally(exception -> {
+    // TODO failure callback handler
+    exception.printStackTrace();
+    return null;
+});
+```
+
+
 # Create Terminal Checkout
 
 Creates a Terminal checkout request and sends it to the specified device to take a payment

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-05-17"` |
+| `squareVersion` | `String` | Square Connect API versions<br>*Default*: `"2023-06-08"` |
 | `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-05-17")
+    .squareVersion("2023-06-08")
     .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-05-17")
+            .squareVersion("2023-06-08")
             .accessToken("AccessToken")
             .build();
 

doc/models/activity-type.md

@@ -44,4 +44,8 @@
 | `THIRD_PARTY_FEE` | Fees collected by a third-party platform. |
 | `THIRD_PARTY_FEE_REFUND` | Refunded fees from a third-party platform. |
 | `PAYOUT` | Balance change due to money transfer. |
+| `AUTOMATIC_BITCOIN_CONVERSIONS` | Indicates the withholding of a portion of each payment by Square that has been<br>automatically converted into bitcoin using Cash App. The seller manages their bitcoin in<br>their Cash App account. |
+| `AUTOMATIC_BITCOIN_CONVERSIONS_REVERSED` | Indicates a return of the payment withholding that had been scheduled to be converted<br>into bitcoin using Cash App to the Square payments balance. |
+| `CREDIT_CARD_REPAYMENT` | The repayment made toward the outstanding balance on the seller's Square credit card. |
+| `CREDIT_CARD_REPAYMENT_REVERSED` | The reversal of the repayment made toward the outstanding balance on the seller's<br>Square credit card. |
 

doc/models/cancel-subscription-response.md

@@ -13,7 +13,7 @@ Defines output parameters in a response from the
 | Name | Type | Tags | Description | Getter |
 |  --- | --- | --- | --- | --- |
 | `Errors` | [`List<Error>`](../../doc/models/error.md) | Optional | Errors encountered during the request. | List<Error> getErrors() |
-| `Subscription` | [`Subscription`](../../doc/models/subscription.md) | Optional | Represents a subscription to a subscription plan by a subscriber.<br><br>For an overview of the `Subscription` type, see<br>[Subscription object](https://developer.squareup.com/docs/subscriptions-api/overview#subscription-object-overview). | Subscription getSubscription() |
+| `Subscription` | [`Subscription`](../../doc/models/subscription.md) | Optional | Represents a subscription purchased by a customer.<br><br>For more information, see<br>[Manage Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions). | Subscription getSubscription() |
 | `Actions` | [`List<SubscriptionAction>`](../../doc/models/subscription-action.md) | Optional | A list of a single `CANCEL` action scheduled for the subscription. | List<SubscriptionAction> getActions() |
 
 ## Example (as JSON)
@@ -35,7 +35,8 @@ Defines output parameters in a response from the
     "start_date": "2021-10-20",
     "status": "ACTIVE",
     "timezone": "America/Los_Angeles",
-    "version": 1594311617331
+    "version": 1594311617331,
+    "plan_variation_id": "plan_variation_id8"
   },
   "errors": [
     {
@@ -62,19 +63,61 @@ Defines output parameters in a response from the
       "id": "id9",
       "type": "PAUSE",
       "effective_date": "effective_date1",
-      "new_plan_id": "new_plan_id5"
+      "phases": [
+        {
+          "uid": "uid6",
+          "ordinal": 186,
+          "order_template_id": "order_template_id8",
+          "plan_phase_uid": "plan_phase_uid2"
+        }
+      ],
+      "new_plan_variation_id": "new_plan_variation_id9"
     },
     {
       "id": "id0",
       "type": "CANCEL",
       "effective_date": "effective_date0",
-      "new_plan_id": "new_plan_id6"
+      "phases": [
+        {
+          "uid": "uid5",
+          "ordinal": 185,
+          "order_template_id": "order_template_id7",
+          "plan_phase_uid": "plan_phase_uid1"
+        },
+        {
+          "uid": "uid6",
+          "ordinal": 186,
+          "order_template_id": "order_template_id8",
+          "plan_phase_uid": "plan_phase_uid2"
+        },
+        {
+          "uid": "uid7",
+          "ordinal": 187,
+          "order_template_id": "order_template_id9",
+          "plan_phase_uid": "plan_phase_uid3"
+        }
+      ],
+      "new_plan_variation_id": "new_plan_variation_id0"
     },
     {
       "id": "id1",
       "type": "SWAP_PLAN",
       "effective_date": "effective_date9",
-      "new_plan_id": "new_plan_id7"
+      "phases": [
+        {
+          "uid": "uid4",
+          "ordinal": 184,
+          "order_template_id": "order_template_id6",
+          "plan_phase_uid": "plan_phase_uid0"
+        },
+        {
+          "uid": "uid5",
+          "ordinal": 185,
+          "order_template_id": "order_template_id7",
+          "plan_phase_uid": "plan_phase_uid1"
+        }
+      ],
+      "new_plan_variation_id": "new_plan_variation_id1"
     }
   ]
 }

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

@@ -24,7 +24,7 @@
     "app_id": "APP_ID",
     "cancel_reason": "SELLER_CANCELED",
     "created_at": "2020-03-16T15:31:19.934Z",
-    "deadline_duration": "PT10M",
+    "deadline_duration": "PT5M",
     "device_options": {
       "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003",
       "skip_receipt_screen": true,

doc/models/catalog-custom-attribute-definition.md

@@ -41,9 +41,9 @@ to store any sensitive information (personally identifiable information, card de
     "name": "name2"
   },
   "allowed_object_types": [
-    "PRICING_RULE",
-    "PRODUCT_SET",
-    "TIME_PERIOD"
+    "TIME_PERIOD",
+    "MEASUREMENT_UNIT",
+    "SUBSCRIPTION_PLAN_VARIATION"
   ],
   "seller_visibility": "SELLER_VISIBILITY_HIDDEN",
   "app_visibility": "APP_VISIBILITY_HIDDEN",

doc/models/catalog-item-option.md

@@ -27,7 +27,7 @@ A group of variations for a `CatalogItem`.
   "show_colors": false,
   "values": [
     {
-      "type": "MODIFIER",
+      "type": "TAX",
       "id": "id0",
       "updated_at": "updated_at6",
       "version": 100,
@@ -71,7 +71,7 @@ A group of variations for a `CatalogItem`.
       ]
     },
     {
-      "type": "MODIFIER_LIST",
+      "type": "ITEM_VARIATION",
       "id": "id1",
       "updated_at": "updated_at7",
       "version": 101,
@@ -100,7 +100,7 @@ A group of variations for a `CatalogItem`.
       ]
     },
     {
-      "type": "DISCOUNT",
+      "type": "CATEGORY",
       "id": "id2",
       "updated_at": "updated_at8",
       "version": 102,