Generated PR for Release: 32.0.0.20230816

Author: autobot

README.md

@@ -72,6 +72,7 @@ mvn test
 
 ### Orders
 * [Orders]
+* [Order Custom Attributes]
 
 ### Subscriptions
 * [Subscriptions]
@@ -98,10 +99,13 @@ mvn test
 
 ### Bookings
 * [Bookings]
+* [Booking Custom Attributes]
 
 ### Business
 * [Merchants]
+* [Merchant Custom Attributes]
 * [Locations]
+* [Location Custom Attributes]
 * [Devices]
 * [Cash Drawers]
 * [Vendors]
@@ -165,9 +169,13 @@ You'll also need to provide logic to handle paginated results.  For more informa
 [Labor]: doc/api/labor.md
 [Loyalty]: doc/api/loyalty.md
 [Bookings]: doc/api/bookings.md
+[Booking Custom Attributes]: doc/api/booking-custom-attributes.md
 [Locations]: doc/api/locations.md
+[Location Custom Attributes]: doc/api/location-custom-attributes.md
 [Merchants]: doc/api/merchants.md
+[Merchant Custom Attributes]: doc/api/merchant-custom-attributes.md
 [Orders]: doc/api/orders.md
+[Order Custom Attributes]: doc/api/order-custom-attributes.md
 [Invoices]: doc/api/invoices.md
 [Apple Pay]: doc/api/apple-pay.md
 [Refunds]: doc/api/refunds.md

doc/api/bookings.md

@@ -13,6 +13,7 @@ BookingsApi bookingsApi = client.getBookingsApi();
 * [List Bookings](../../doc/api/bookings.md#list-bookings)
 * [Create Booking](../../doc/api/bookings.md#create-booking)
 * [Search Availability](../../doc/api/bookings.md#search-availability)
+* [Bulk Retrieve Bookings](../../doc/api/bookings.md#bulk-retrieve-bookings)
 * [Retrieve Business Booking Profile](../../doc/api/bookings.md#retrieve-business-booking-profile)
 * [List Team Member Booking Profiles](../../doc/api/bookings.md#list-team-member-booking-profiles)
 * [Retrieve Team Member Booking Profile](../../doc/api/bookings.md#retrieve-team-member-booking-profile)
@@ -32,6 +33,7 @@ To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ`
 CompletableFuture<ListBookingsResponse> listBookingsAsync(
     final Integer limit,
     final String cursor,
+    final String customerId,
     final String teamMemberId,
     final String locationId,
     final String startAtMin,
@@ -44,6 +46,7 @@ CompletableFuture<ListBookingsResponse> listBookingsAsync(
 |  --- | --- | --- | --- |
 | `limit` | `Integer` | Query, Optional | The maximum number of results per page to return in a paged response. |
 | `cursor` | `String` | Query, Optional | The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results. |
+| `customerId` | `String` | Query, Optional | The [customer](entity:Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved. |
 | `teamMemberId` | `String` | Query, Optional | The team member for whom to retrieve bookings. If this is not set, bookings of all members are retrieved. |
 | `locationId` | `String` | Query, Optional | The location for which to retrieve bookings. If this is not set, all locations' bookings are retrieved. |
 | `startAtMin` | `String` | Query, Optional | The RFC 3339 timestamp specifying the earliest of the start time. If this is not set, the current time is used. |
@@ -56,7 +59,7 @@ CompletableFuture<ListBookingsResponse> listBookingsAsync(
 ## Example Usage
 
 ```java
-bookingsApi.listBookingsAsync(null, null, null, null, null, null).thenAccept(result -> {
+bookingsApi.listBookingsAsync(null, null, null, null, null, null, null).thenAccept(result -> {
     // TODO success callback handler
     System.out.println(result);
 }).exceptionally(exception -> {
@@ -168,6 +171,51 @@ bookingsApi.searchAvailabilityAsync(body).thenAccept(result -> {
 ```
 
 
+# Bulk Retrieve Bookings
+
+Bulk-Retrieves a list of bookings by booking IDs.
+
+To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
+To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
+
+```java
+CompletableFuture<BulkRetrieveBookingsResponse> bulkRetrieveBookingsAsync(
+    final BulkRetrieveBookingsRequest body)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `body` | [`BulkRetrieveBookingsRequest`](../../doc/models/bulk-retrieve-bookings-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
+
+[`BulkRetrieveBookingsResponse`](../../doc/models/bulk-retrieve-bookings-response.md)
+
+## Example Usage
+
+```java
+BulkRetrieveBookingsRequest body = new BulkRetrieveBookingsRequest.Builder(
+    Arrays.asList(
+        "booking_ids8",
+        "booking_ids9",
+        "booking_ids0"
+    )
+)
+.build();
+
+bookingsApi.bulkRetrieveBookingsAsync(body).thenAccept(result -> {
+    // TODO success callback handler
+    System.out.println(result);
+}).exceptionally(exception -> {
+    // TODO failure callback handler
+    exception.printStackTrace();
+    return null;
+});
+```
+
+
 # Retrieve Business Booking Profile
 
 Retrieves a seller's booking profile.

doc/api/gift-cards.md

@@ -39,7 +39,7 @@ CompletableFuture<ListGiftCardsResponse> listGiftCardsAsync(
 |  --- | --- | --- | --- |
 | `type` | `String` | Query, Optional | If a [type](entity:GiftCardType) is provided, the endpoint returns gift cards of the specified type.<br>Otherwise, the endpoint returns gift cards of all types. |
 | `state` | `String` | Query, Optional | If a [state](entity:GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.<br>Otherwise, the endpoint returns the gift cards of all states. |
-| `limit` | `Integer` | Query, Optional | If a limit is provided, the endpoint returns only the specified number of results per page.<br>The maximum value is 50. The default value is 30.<br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
+| `limit` | `Integer` | Query, Optional | If a limit is provided, the endpoint returns only the specified number of results per page.<br>The maximum value is 200. The default value is 30.<br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
 | `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 the original query.<br>If a cursor is not provided, the endpoint returns the first page of the results.<br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
 | `customerId` | `String` | Query, Optional | If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer. |
 

doc/api/loyalty.md

@@ -519,14 +519,13 @@ CreateLoyaltyPromotionRequest body = new CreateLoyaltyPromotionRequest.Builder(
         new LoyaltyPromotionIncentive.Builder(
             "POINTS_MULTIPLIER"
         )
-        .pointsMultiplierData(new LoyaltyPromotionIncentivePointsMultiplierData.Builder(
-                3
-            )
-            .build())
+        .pointsMultiplierData(new LoyaltyPromotionIncentivePointsMultiplierData.Builder()
+                .multiplier("3.0")
+                .build())
         .build(),
         new LoyaltyPromotionAvailableTimeData.Builder(
             Arrays.asList(
-                "BEGIN:VEVENT\\nDTSTART:20220816T160000\\nDURATION:PT2H\\nRRULE:FREQ=WEEKLY;BYDAY=TU\\nEND:VEVENT"
+                "BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT"
             )
         )
         .build()

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

doc/models/archived-state.md

@@ -0,0 +1,19 @@
+
+# Archived State
+
+Defines the values for the `archived_state` query expression
+used in [SearchCatalogItems](../../doc/api/catalog.md#search-catalog-items)
+to return the archived, not archived or either type of catalog items.
+
+## Enumeration
+
+`ArchivedState`
+
+## Fields
+
+| Name | Description |
+|  --- | --- |
+| `ARCHIVED_STATE_NOT_ARCHIVED` | Requested items are not archived with the `is_archived` attribute set to `false`. |
+| `ARCHIVED_STATE_ARCHIVED` | Requested items are archived with the `is_archived` attribute set to `true`. |
+| `ARCHIVED_STATE_ALL` | Requested items can be archived or not archived. |
+

doc/models/booking-custom-attribute-delete-request.md

@@ -12,7 +12,7 @@ request. An individual request contains a booking ID, the custom attribute to de
 
 | Name | Type | Tags | Description | Getter |
 |  --- | --- | --- | --- | --- |
-| `BookingId` | `String` | Required | The ID of the target [booking](entity:Booking).<br>**Constraints**: *Minimum Length*: `1` | String getBookingId() |
+| `BookingId` | `String` | Required | The ID of the target [booking](entity:Booking).<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | String getBookingId() |
 | `Key` | `String` | Required | The key of the custom attribute to delete. This key must match the `key` of a<br>custom attribute definition in the Square seller account. If the requesting application is not<br>the definition owner, you must use the qualified key.<br>**Constraints**: *Minimum Length*: `1` | String getKey() |
 
 ## Example (as JSON)

doc/models/booking-custom-attribute-upsert-request.md

@@ -13,7 +13,7 @@ and an optional idempotency key.
 
 | Name | Type | Tags | Description | Getter |
 |  --- | --- | --- | --- | --- |
-| `BookingId` | `String` | Required | The ID of the target [booking](entity:Booking).<br>**Constraints**: *Minimum Length*: `1` | String getBookingId() |
+| `BookingId` | `String` | Required | The ID of the target [booking](entity:Booking).<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | String getBookingId() |
 | `CustomAttribute` | [`CustomAttribute`](../../doc/models/custom-attribute.md) | Required | A custom attribute value. Each custom attribute value has a corresponding<br>`CustomAttributeDefinition` object. | CustomAttribute getCustomAttribute() |
 | `IdempotencyKey` | `String` | Optional | A unique identifier for this individual upsert request, used to ensure idempotency.<br>For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).<br>**Constraints**: *Maximum Length*: `45` | String getIdempotencyKey() |
 

doc/models/bulk-retrieve-bookings-request.md

@@ -0,0 +1,25 @@
+
+# Bulk Retrieve Bookings Request
+
+Request payload for bulk retrieval of bookings.
+
+## Structure
+
+`BulkRetrieveBookingsRequest`
+
+## Fields
+
+| Name | Type | Tags | Description | Getter |
+|  --- | --- | --- | --- | --- |
+| `BookingIds` | `List<String>` | Required | A non-empty list of [Booking](entity:Booking) IDs specifying bookings to retrieve. | List<String> getBookingIds() |
+
+## Example (as JSON)
+
+```json
+{
+  "booking_ids": [
+    "booking_ids4"
+  ]
+}
+```
+

doc/models/bulk-retrieve-bookings-response.md

@@ -0,0 +1,89 @@
+
+# Bulk Retrieve Bookings Response
+
+Response payload for bulk retrieval of bookings.
+
+## Structure
+
+`BulkRetrieveBookingsResponse`
+
+## Fields
+
+| Name | Type | Tags | Description | Getter |
+|  --- | --- | --- | --- | --- |
+| `Bookings` | [`Map<String, RetrieveBookingResponse>`](../../doc/models/retrieve-booking-response.md) | Optional | Requested bookings returned as a map containing `booking_id` as the key and `RetrieveBookingResponse` as the value. | Map<String, RetrieveBookingResponse> getBookings() |
+| `Errors` | [`List<Error>`](../../doc/models/error.md) | Optional | Errors that occurred during the request. | List<Error> getErrors() |
+
+## Example (as JSON)
+
+```json
+{
+  "bookings": {
+    "sc3p3m7dvctfr1": {
+      "booking": {
+        "all_day": false,
+        "appointment_segments": [
+          {
+            "any_team_member": false,
+            "duration_minutes": 60,
+            "service_variation_id": "VG4FYBKK3UL6UITOEYQ6MFLS",
+            "service_variation_version": 1641341724039,
+            "team_member_id": "TMjiqI3PxyLMKr4k"
+          }
+        ],
+        "created_at": "2023-04-26T18:19:21Z",
+        "customer_id": "4TDWKN9E8165X8Z77MRS0VFMJM",
+        "id": "sc3p3m7dvctfr1",
+        "location_id": "LY6WNBPVM6VGV",
+        "start_at": "2023-05-01T14:00:00Z",
+        "status": "ACCEPTED",
+        "updated_at": "2023-04-26T18:19:21Z",
+        "version": 0
+      },
+      "errors": []
+    },
+    "tdegug1dvctdef": {
+      "errors": [
+        {
+          "category": "INVALID_REQUEST_ERROR",
+          "code": "NOT_FOUND",
+          "detail": "Specified booking was not found.",
+          "field": "booking_id"
+        }
+      ],
+      "booking": {
+        "id": "id8",
+        "version": 86,
+        "status": "CANCELLED_BY_SELLER",
+        "created_at": "created_at6",
+        "updated_at": "updated_at6"
+      }
+    },
+    "tdegug1fqni3wh": {
+      "booking": {
+        "all_day": false,
+        "appointment_segments": [
+          {
+            "any_team_member": false,
+            "duration_minutes": 60,
+            "service_variation_id": "VG4FYBKK3UL6UITOEYQ6MFLS",
+            "service_variation_version": 1641341724039,
+            "team_member_id": "TMjiqI3PxyLMKr4k"
+          }
+        ],
+        "created_at": "2023-04-26T18:19:30Z",
+        "customer_id": "4TDWKN9E8165X8Z77MRS0VFMJM",
+        "id": "tdegug1fqni3wh",
+        "location_id": "LY6WNBPVM6VGV",
+        "start_at": "2023-05-02T14:00:00Z",
+        "status": "ACCEPTED",
+        "updated_at": "2023-04-26T18:19:30Z",
+        "version": 0
+      },
+      "errors": []
+    }
+  },
+  "errors": []
+}
+```
+