Merge pull request #116 from square/release/38.1.0.20240320

Generated PR for Release: 38.1.0.20240320

.github/workflows/maven.yml

@@ -56,4 +56,4 @@ jobs:
         uses: "pascalgn/[email protected]"
         env:
           GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
-          MERGE_LABELS: "automerge,automerge-branch,automerge-author"
+          MERGE_LABELS: "automerge,automerge-branch,automerge-author"

doc/api/bookings.md

@@ -81,7 +81,7 @@ The required input must include the following:
 
 - `Booking.location_id`
 - `Booking.start_at`
-- `Booking.team_member_id`
+- `Booking.AppointmentSegment.team_member_id`
 - `Booking.AppointmentSegment.service_variation_id`
 - `Booking.AppointmentSegment.service_variation_version`
 

doc/api/labor.md

@@ -323,20 +323,20 @@ laborApi.getEmployeeWageAsync(id).thenAccept(result -> {
 
 Creates a new `Shift`.
 
-A `Shift` represents a complete workday for a single employee.
+A `Shift` represents a complete workday for a single team member.
 You must provide the following values in your request to this
 endpoint:
 
 - `location_id`
-- `employee_id`
+- `team_member_id`
 - `start_at`
 
 An attempt to create a new `Shift` can result in a `BAD_REQUEST` error when:
 
-- The `status` of the new `Shift` is `OPEN` and the employee has another
+- The `status` of the new `Shift` is `OPEN` and the team member has another
   shift with an `OPEN` status.
 - The `start_at` date is in the future.
-- The `start_at` or `end_at` date overlaps another shift for the same employee.
+- The `start_at` or `end_at` date overlaps another shift for the same team member.
 - The `Break` instances are set in the request and a break `start_at`
   is before the `Shift.start_at`, a break `end_at` is after
   the `Shift.end_at`, or both.
@@ -410,19 +410,19 @@ laborApi.createShiftAsync(body).thenAccept(result -> {
 Returns a paginated list of `Shift` records for a business.
 The list to be returned can be filtered by:
 
-- Location IDs.
-- Employee IDs.
-- Shift status (`OPEN` and `CLOSED`).
-- Shift start.
-- Shift end.
-- Workday details.
+- Location IDs
+- Team member IDs
+- Shift status (`OPEN` or `CLOSED`)
+- Shift start
+- Shift end
+- Workday details
 
 The list can be sorted by:
 
-- `start_at`.
-- `end_at`.
-- `created_at`.
-- `updated_at`.
+- `START_AT`
+- `END_AT`
+- `CREATED_AT`
+- `UPDATED_AT`
 
 ```java
 CompletableFuture<SearchShiftsResponse> searchShiftsAsync(

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*: `"2024-02-22"` |
+| `squareVersion` | `String` | Square Connect API versions<br>*Default*: `"2024-03-20"` |
 | `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("2024-02-22")
+    .squareVersion("2024-03-20")
     .bearerAuthCredentials(new BearerAuthModel.Builder(
             "AccessToken"
         )
@@ -44,7 +44,7 @@ public class Program {
         SquareClient client = new SquareClient.Builder()
             .httpClientConfig(configBuilder -> configBuilder
                     .timeout(0))
-            .squareVersion("2024-02-22")
+            .squareVersion("2024-03-20")
             .bearerAuthCredentials(new BearerAuthModel.Builder(
                     "AccessToken"
                 )

doc/models/catalog-item-modifier-list-info.md

@@ -14,8 +14,8 @@ and specifies supported behaviors of the application.
 |  --- | --- | --- | --- | --- |
 | `ModifierListId` | `String` | Required | The ID of the `CatalogModifierList` controlled by this `CatalogModifierListInfo`.<br>**Constraints**: *Minimum Length*: `1` | String getModifierListId() |
 | `ModifierOverrides` | [`List<CatalogModifierOverride>`](../../doc/models/catalog-modifier-override.md) | Optional | A set of `CatalogModifierOverride` objects that override whether a given `CatalogModifier` is enabled by default. | List<CatalogModifierOverride> getModifierOverrides() |
-| `MinSelectedModifiers` | `Integer` | Optional | If 0 or larger, the smallest number of `CatalogModifier`s that must be selected from this `CatalogModifierList`. | Integer getMinSelectedModifiers() |
-| `MaxSelectedModifiers` | `Integer` | Optional | If 0 or larger, the largest number of `CatalogModifier`s that can be selected from this `CatalogModifierList`. | Integer getMaxSelectedModifiers() |
+| `MinSelectedModifiers` | `Integer` | Optional | If 0 or larger, the smallest number of `CatalogModifier`s that must be selected from this `CatalogModifierList`.<br>The default value is `-1`.<br><br>When  `CatalogModifierList.selection_type` is `MULTIPLE`, `CatalogModifierListInfo.min_selected_modifiers=-1`<br>and `CatalogModifierListInfo.max_selected_modifier=-1` means that from zero to the maximum number of modifiers of<br>the `CatalogModifierList` can be selected from the `CatalogModifierList`.<br><br>When the `CatalogModifierList.selection_type` is `SINGLE`, `CatalogModifierListInfo.min_selected_modifiers=-1`<br>and `CatalogModifierListInfo.max_selected_modifier=-1` means that exactly one modifier must be present in<br>and can be selected from the `CatalogModifierList` | Integer getMinSelectedModifiers() |
+| `MaxSelectedModifiers` | `Integer` | Optional | If 0 or larger, the largest number of `CatalogModifier`s that can be selected from this `CatalogModifierList`.<br>The default value is `-1`.<br><br>When  `CatalogModifierList.selection_type` is `MULTIPLE`, `CatalogModifierListInfo.min_selected_modifiers=-1`<br>and `CatalogModifierListInfo.max_selected_modifier=-1` means that from zero to the maximum number of modifiers of<br>the `CatalogModifierList` can be selected from the `CatalogModifierList`.<br><br>When the `CatalogModifierList.selection_type` is `SINGLE`, `CatalogModifierListInfo.min_selected_modifiers=-1`<br>and `CatalogModifierListInfo.max_selected_modifier=-1` means that exactly one modifier must be present in<br>and can be selected from the `CatalogModifierList` | Integer getMaxSelectedModifiers() |
 | `Enabled` | `Boolean` | Optional | If `true`, enable this `CatalogModifierList`. The default value is `true`. | Boolean getEnabled() |
 | `Ordinal` | `Integer` | Optional | The position of this `CatalogItemModifierListInfo` object within the `modifier_list_info` list applied<br>to a `CatalogItem` instance. | Integer getOrdinal() |
 

doc/models/digital-wallet-details.md

@@ -12,7 +12,7 @@ Additional details about `WALLET` type payments. Contains only non-confidential
 | Name | Type | Tags | Description | Getter |
 |  --- | --- | --- | --- | --- |
 | `Status` | `String` | Optional | The status of the `WALLET` payment. The status can be `AUTHORIZED`, `CAPTURED`, `VOIDED`, or<br>`FAILED`.<br>**Constraints**: *Maximum Length*: `50` | String getStatus() |
-| `Brand` | `String` | Optional | The brand used for the `WALLET` payment. The brand can be `CASH_APP`, `PAYPAY` or `UNKNOWN`.<br>**Constraints**: *Maximum Length*: `50` | String getBrand() |
+| `Brand` | `String` | Optional | The brand used for the `WALLET` payment. The brand can be `CASH_APP`, `PAYPAY`, `ALIPAY`,<br>`RAKUTEN_PAY`, `AU_PAY`, `D_BARAI`, `MERPAY`, `WECHAT_PAY` or `UNKNOWN`.<br>**Constraints**: *Maximum Length*: `50` | String getBrand() |
 | `CashAppDetails` | [`CashAppDetails`](../../doc/models/cash-app-details.md) | Optional | Additional details about `WALLET` type payments with the `brand` of `CASH_APP`. | CashAppDetails getCashAppDetails() |
 
 ## Example (as JSON)

doc/models/list-location-booking-profiles-response.md

@@ -17,44 +17,20 @@
 
 ```json
 {
+  "errors": [],
   "location_booking_profiles": [
     {
-      "location_id": "location_id0",
-      "booking_site_url": "booking_site_url2",
-      "online_booking_enabled": false
+      "booking_site_url": "https://squareup.com/book/LY6WNBPVM6VGV/testbusiness",
+      "location_id": "LY6WNBPVM6VGV",
+      "online_booking_enabled": true
     },
     {
-      "location_id": "location_id0",
-      "booking_site_url": "booking_site_url2",
-      "online_booking_enabled": false
-    },
-    {
-      "location_id": "location_id0",
-      "booking_site_url": "booking_site_url2",
-      "online_booking_enabled": false
+      "location_id": "PYTRNBPVMJUPV",
+      "online_booking_enabled": false,
+      "booking_site_url": "booking_site_url2"
     }
   ],
-  "cursor": "cursor8",
-  "errors": [
-    {
-      "category": "MERCHANT_SUBSCRIPTION_ERROR",
-      "code": "MAP_KEY_LENGTH_TOO_LONG",
-      "detail": "detail6",
-      "field": "field4"
-    },
-    {
-      "category": "MERCHANT_SUBSCRIPTION_ERROR",
-      "code": "MAP_KEY_LENGTH_TOO_LONG",
-      "detail": "detail6",
-      "field": "field4"
-    },
-    {
-      "category": "MERCHANT_SUBSCRIPTION_ERROR",
-      "code": "MAP_KEY_LENGTH_TOO_LONG",
-      "detail": "detail6",
-      "field": "field4"
-    }
-  ]
+  "cursor": "cursor8"
 }
 ```
 

doc/models/tender-type.md

@@ -17,7 +17,7 @@ Indicates a tender's type.
 | `SQUARE_GIFT_CARD` | A Square gift card. |
 | `NO_SALE` | This tender represents the register being opened for a "no sale" event. |
 | `BANK_ACCOUNT` | A bank account payment. |
-| `WALLET` | A payment from a digital wallet, e.g. Cash App.<br><br>Note: Some "digital wallets", including Google Pay and Apple Pay, facilitate<br>card payments.  Those payments have the `CARD` type. |
+| `WALLET` | A payment from a digital wallet, e.g. Cash App, Paypay, Rakuten Pay,<br>Au Pay, D Barai, Merpay, Wechat Pay, Alipay.<br><br>Note: Some "digital wallets", including Google Pay and Apple Pay, facilitate<br>card payments.  Those payments have the `CARD` type. |
 | `BUY_NOW_PAY_LATER` | A Buy Now Pay Later payment. |
 | `SQUARE_ACCOUNT` | A Square House Account payment. |
 | `OTHER` | A form of tender that does not match any other value. |

pom.xml

@@ -3,7 +3,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.squareup</groupId>
   <artifactId>square</artifactId>
-  <version>38.0.0.20240222</version>
+  <version>38.1.0.20240320</version>
   <packaging>jar</packaging>
   <name>Square</name>
   <description>Java client library for the Square API</description>

src/main/java/com/squareup/square/SquareClient.java

@@ -153,7 +153,7 @@ public final class SquareClient implements SquareClientInterface {
 
     private static final CompatibilityFactory compatibilityFactory = new CompatibilityFactoryImpl();
 
-    private static String userAgent = "Square-Java-SDK/38.0.0.20240222 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}";
+    private static String userAgent = "Square-Java-SDK/38.1.0.20240320 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}";
 
     /**
      * Current API environment.
@@ -714,7 +714,7 @@ public String getAccessToken() {
      * @return sdkVersion
      */
     public String getSdkVersion() {
-        return "38.0.0.20240222";
+        return "38.1.0.20240320";
     }
 
     /**
@@ -829,7 +829,7 @@ public static class Builder {
 
         private Environment environment = Environment.PRODUCTION;
         private String customUrl = "https://connect.squareup.com";
-        private String squareVersion = "2024-02-22";
+        private String squareVersion = "2024-03-20";
         private HttpClient httpClient;
         private Headers additionalHeaders = new Headers();
         private String userAgentDetail = null;

src/main/java/com/squareup/square/api/BookingsApi.java

@@ -93,7 +93,7 @@ CompletableFuture<ListBookingsResponse> listBookingsAsync(
 
     /**
      * Creates a booking. The required input must include the following: - `Booking.location_id` -
-     * `Booking.start_at` - `Booking.team_member_id` -
+     * `Booking.start_at` - `Booking.AppointmentSegment.team_member_id` -
      * `Booking.AppointmentSegment.service_variation_id` -
      * `Booking.AppointmentSegment.service_variation_version` To call this endpoint with buyer-level
      * permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with
@@ -111,7 +111,7 @@ CreateBookingResponse createBooking(
 
     /**
      * Creates a booking. The required input must include the following: - `Booking.location_id` -
-     * `Booking.start_at` - `Booking.team_member_id` -
+     * `Booking.start_at` - `Booking.AppointmentSegment.team_member_id` -
      * `Booking.AppointmentSegment.service_variation_id` -
      * `Booking.AppointmentSegment.service_variation_version` To call this endpoint with buyer-level
      * permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with

src/main/java/com/squareup/square/api/DefaultBookingsApi.java

@@ -163,7 +163,7 @@ private ApiCall<ListBookingsResponse, ApiException> prepareListBookingsRequest(
 
     /**
      * Creates a booking. The required input must include the following: - `Booking.location_id` -
-     * `Booking.start_at` - `Booking.team_member_id` -
+     * `Booking.start_at` - `Booking.AppointmentSegment.team_member_id` -
      * `Booking.AppointmentSegment.service_variation_id` -
      * `Booking.AppointmentSegment.service_variation_version` To call this endpoint with buyer-level
      * permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with
@@ -183,7 +183,7 @@ public CreateBookingResponse createBooking(
 
     /**
      * Creates a booking. The required input must include the following: - `Booking.location_id` -
-     * `Booking.start_at` - `Booking.team_member_id` -
+     * `Booking.start_at` - `Booking.AppointmentSegment.team_member_id` -
      * `Booking.AppointmentSegment.service_variation_id` -
      * `Booking.AppointmentSegment.service_variation_version` To call this endpoint with buyer-level
      * permissions, set `APPOINTMENTS_WRITE` for the OAuth scope. To call this endpoint with

src/main/java/com/squareup/square/api/DefaultLaborApi.java

@@ -490,14 +490,14 @@ private ApiCall<GetEmployeeWageResponse, ApiException> prepareGetEmployeeWageReq
     }
 
     /**
-     * Creates a new `Shift`. A `Shift` represents a complete workday for a single employee. You
+     * Creates a new `Shift`. A `Shift` represents a complete workday for a single team member. You
      * must provide the following values in your request to this endpoint: - `location_id` -
-     * `employee_id` - `start_at` An attempt to create a new `Shift` can result in a `BAD_REQUEST`
-     * error when: - The `status` of the new `Shift` is `OPEN` and the employee has another shift
-     * with an `OPEN` status. - The `start_at` date is in the future. - The `start_at` or `end_at`
-     * date overlaps another shift for the same employee. - The `Break` instances are set in the
-     * request and a break `start_at` is before the `Shift.start_at`, a break `end_at` is after the
-     * `Shift.end_at`, or both.
+     * `team_member_id` - `start_at` An attempt to create a new `Shift` can result in a
+     * `BAD_REQUEST` error when: - The `status` of the new `Shift` is `OPEN` and the team member has
+     * another shift with an `OPEN` status. - The `start_at` date is in the future. - The `start_at`
+     * or `end_at` date overlaps another shift for the same team member. - The `Break` instances are
+     * set in the request and a break `start_at` is before the `Shift.start_at`, a break `end_at` is
+     * after the `Shift.end_at`, or both.
      * @param  body  Required parameter: An object containing the fields to POST for the request.
      *         See the corresponding object definition for field details.
      * @return    Returns the CreateShiftResponse response from the API call
@@ -510,14 +510,14 @@ public CreateShiftResponse createShift(
     }
 
     /**
-     * Creates a new `Shift`. A `Shift` represents a complete workday for a single employee. You
+     * Creates a new `Shift`. A `Shift` represents a complete workday for a single team member. You
      * must provide the following values in your request to this endpoint: - `location_id` -
-     * `employee_id` - `start_at` An attempt to create a new `Shift` can result in a `BAD_REQUEST`
-     * error when: - The `status` of the new `Shift` is `OPEN` and the employee has another shift
-     * with an `OPEN` status. - The `start_at` date is in the future. - The `start_at` or `end_at`
-     * date overlaps another shift for the same employee. - The `Break` instances are set in the
-     * request and a break `start_at` is before the `Shift.start_at`, a break `end_at` is after the
-     * `Shift.end_at`, or both.
+     * `team_member_id` - `start_at` An attempt to create a new `Shift` can result in a
+     * `BAD_REQUEST` error when: - The `status` of the new `Shift` is `OPEN` and the team member has
+     * another shift with an `OPEN` status. - The `start_at` date is in the future. - The `start_at`
+     * or `end_at` date overlaps another shift for the same team member. - The `Break` instances are
+     * set in the request and a break `start_at` is before the `Shift.start_at`, a break `end_at` is
+     * after the `Shift.end_at`, or both.
      * @param  body  Required parameter: An object containing the fields to POST for the request.
      *         See the corresponding object definition for field details.
      * @return    Returns the CreateShiftResponse response from the API call
@@ -561,9 +561,9 @@ private ApiCall<CreateShiftResponse, ApiException> prepareCreateShiftRequest(
 
     /**
      * Returns a paginated list of `Shift` records for a business. The list to be returned can be
-     * filtered by: - Location IDs. - Employee IDs. - Shift status (`OPEN` and `CLOSED`). - Shift
-     * start. - Shift end. - Workday details. The list can be sorted by: - `start_at`. - `end_at`. -
-     * `created_at`. - `updated_at`.
+     * filtered by: - Location IDs - Team member IDs - Shift status (`OPEN` or `CLOSED`) - Shift
+     * start - Shift end - Workday details The list can be sorted by: - `START_AT` - `END_AT` -
+     * `CREATED_AT` - `UPDATED_AT`.
      * @param  body  Required parameter: An object containing the fields to POST for the request.
      *         See the corresponding object definition for field details.
      * @return    Returns the SearchShiftsResponse response from the API call
@@ -577,9 +577,9 @@ public SearchShiftsResponse searchShifts(
 
     /**
      * Returns a paginated list of `Shift` records for a business. The list to be returned can be
-     * filtered by: - Location IDs. - Employee IDs. - Shift status (`OPEN` and `CLOSED`). - Shift
-     * start. - Shift end. - Workday details. The list can be sorted by: - `start_at`. - `end_at`. -
-     * `created_at`. - `updated_at`.
+     * filtered by: - Location IDs - Team member IDs - Shift status (`OPEN` or `CLOSED`) - Shift
+     * start - Shift end - Workday details The list can be sorted by: - `START_AT` - `END_AT` -
+     * `CREATED_AT` - `UPDATED_AT`.
      * @param  body  Required parameter: An object containing the fields to POST for the request.
      *         See the corresponding object definition for field details.
      * @return    Returns the SearchShiftsResponse response from the API call
@@ -867,7 +867,7 @@ private ApiCall<ListTeamMemberWagesResponse, ApiException> prepareListTeamMember
     }
 
     /**
-     * Returns a single `TeamMemberWage` specified by `id `.
+     * Returns a single `TeamMemberWage` specified by `id`.
      * @param  id  Required parameter: The UUID for the `TeamMemberWage` being retrieved.
      * @return    Returns the GetTeamMemberWageResponse response from the API call
      * @throws    ApiException    Represents error response from the server.
@@ -879,7 +879,7 @@ public GetTeamMemberWageResponse getTeamMemberWage(
     }
 
     /**
-     * Returns a single `TeamMemberWage` specified by `id `.
+     * Returns a single `TeamMemberWage` specified by `id`.
      * @param  id  Required parameter: The UUID for the `TeamMemberWage` being retrieved.
      * @return    Returns the GetTeamMemberWageResponse response from the API call
      */