Merge pull request #132 from square/release/35.1.0.20240320

Generated PR for Release: 35.1.0.20240320

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "square/square",
     "description": "Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.",
-    "version": "35.0.0.20240222",
+    "version": "35.1.0.20240320",
     "type": "library",
     "keywords": [
         "Square",

doc/apis/bookings.md

@@ -85,7 +85,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/apis/labor.md

@@ -334,20 +334,20 @@ var_dump($apiResponse->getHeaders());
 
 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.
@@ -431,19 +431,19 @@ var_dump($apiResponse->getHeaders());
 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`
 
 ```php
 function searchShifts(SearchShiftsRequest $body): ApiResponse

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`** |
 | `timeout` | `int` | Timeout for API calls in seconds.<br>*Default*: `60` |
@@ -30,7 +30,7 @@ $client = SquareClientBuilder::init()
             'AccessToken'
         )
     )
-    ->squareVersion('2024-02-22')
+    ->squareVersion('2024-03-20')
     ->environment('production')
     ->customUrl('https://connect.squareup.com')
     ->build();
@@ -60,7 +60,7 @@ $client = SquareClientBuilder::init()
             'AccessToken'
         )
     )
-    ->squareVersion('2024-02-22')
+    ->squareVersion('2024-03-20')
     ->build();
 
 $apiResponse = $client->getLocationsApi()->listLocations();

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` | getModifierListId(): string | setModifierListId(string modifierListId): void |
 | `modifierOverrides` | [`?(CatalogModifierOverride[])`](../../doc/models/catalog-modifier-override.md) | Optional | A set of `CatalogModifierOverride` objects that override whether a given `CatalogModifier` is enabled by default. | getModifierOverrides(): ?array | setModifierOverrides(?array modifierOverrides): void |
-| `minSelectedModifiers` | `?int` | Optional | If 0 or larger, the smallest number of `CatalogModifier`s that must be selected from this `CatalogModifierList`. | getMinSelectedModifiers(): ?int | setMinSelectedModifiers(?int minSelectedModifiers): void |
-| `maxSelectedModifiers` | `?int` | Optional | If 0 or larger, the largest number of `CatalogModifier`s that can be selected from this `CatalogModifierList`. | getMaxSelectedModifiers(): ?int | setMaxSelectedModifiers(?int maxSelectedModifiers): void |
+| `minSelectedModifiers` | `?int` | 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` | getMinSelectedModifiers(): ?int | setMinSelectedModifiers(?int minSelectedModifiers): void |
+| `maxSelectedModifiers` | `?int` | 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` | getMaxSelectedModifiers(): ?int | setMaxSelectedModifiers(?int maxSelectedModifiers): void |
 | `enabled` | `?bool` | Optional | If `true`, enable this `CatalogModifierList`. The default value is `true`. | getEnabled(): ?bool | setEnabled(?bool enabled): void |
 | `ordinal` | `?int` | Optional | The position of this `CatalogItemModifierListInfo` object within the `modifier_list_info` list applied<br>to a `CatalogItem` instance. | getOrdinal(): ?int | setOrdinal(?int ordinal): void |
 

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 | Setter |
 |  --- | --- | --- | --- | --- | --- |
 | `status` | `?string` | Optional | The status of the `WALLET` payment. The status can be `AUTHORIZED`, `CAPTURED`, `VOIDED`, or<br>`FAILED`.<br>**Constraints**: *Maximum Length*: `50` | getStatus(): ?string | setStatus(?string status): void |
-| `brand` | `?string` | Optional | The brand used for the `WALLET` payment. The brand can be `CASH_APP`, `PAYPAY` or `UNKNOWN`.<br>**Constraints**: *Maximum Length*: `50` | getBrand(): ?string | setBrand(?string brand): void |
+| `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` | getBrand(): ?string | setBrand(?string brand): void |
 | `cashAppDetails` | [`?CashAppDetails`](../../doc/models/cash-app-details.md) | Optional | Additional details about `WALLET` type payments with the `brand` of `CASH_APP`. | getCashAppDetails(): ?CashAppDetails | setCashAppDetails(?CashAppDetails cashAppDetails): void |
 
 ## 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. |

src/Apis/BookingsApi.php

@@ -88,7 +88,7 @@ public function listBookings(
      * 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`
      *

src/Apis/LaborApi.php

@@ -216,19 +216,19 @@ public function getEmployeeWage(string $id): ApiResponse
     /**
      * 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.
@@ -252,18 +252,18 @@ public function createShift(CreateShiftRequest $body): ApiResponse
     /**
      * 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`
      *
      * @param SearchShiftsRequest $body An object containing the fields to POST for the request. See
      *        the corresponding object definition for field details.
@@ -379,7 +379,7 @@ public function listTeamMemberWages(
     }
 
     /**
-     * Returns a single `TeamMemberWage` specified by `id `.
+     * Returns a single `TeamMemberWage` specified by `id`.
      *
      * @param string $id The UUID for the `TeamMemberWage` being retrieved.
      *

src/ConfigurationDefaults.php

@@ -27,7 +27,7 @@ class ConfigurationDefaults
 
     public const HTTP_METHODS_TO_RETRY = ['GET', 'PUT'];
 
-    public const SQUARE_VERSION = '2024-02-22';
+    public const SQUARE_VERSION = '2024-03-20';
 
     public const ADDITIONAL_HEADERS = [];
 

src/Models/CatalogItemModifierListInfo.php

@@ -115,6 +115,19 @@ public function unsetModifierOverrides(): void
      * Returns Min Selected Modifiers.
      * If 0 or larger, the smallest number of `CatalogModifier`s that must be selected from this
      * `CatalogModifierList`.
+     * The default value is `-1`.
+     *
+     * When  `CatalogModifierList.selection_type` is `MULTIPLE`, `CatalogModifierListInfo.
+     * min_selected_modifiers=-1`
+     * and `CatalogModifierListInfo.max_selected_modifier=-1` means that from zero to the maximum number of
+     * modifiers of
+     * the `CatalogModifierList` can be selected from the `CatalogModifierList`.
+     *
+     * When the `CatalogModifierList.selection_type` is `SINGLE`, `CatalogModifierListInfo.
+     * min_selected_modifiers=-1`
+     * and `CatalogModifierListInfo.max_selected_modifier=-1` means that exactly one modifier must be
+     * present in
+     * and can be selected from the `CatalogModifierList`
      */
     public function getMinSelectedModifiers(): ?int
     {
@@ -128,6 +141,19 @@ public function getMinSelectedModifiers(): ?int
      * Sets Min Selected Modifiers.
      * If 0 or larger, the smallest number of `CatalogModifier`s that must be selected from this
      * `CatalogModifierList`.
+     * The default value is `-1`.
+     *
+     * When  `CatalogModifierList.selection_type` is `MULTIPLE`, `CatalogModifierListInfo.
+     * min_selected_modifiers=-1`
+     * and `CatalogModifierListInfo.max_selected_modifier=-1` means that from zero to the maximum number of
+     * modifiers of
+     * the `CatalogModifierList` can be selected from the `CatalogModifierList`.
+     *
+     * When the `CatalogModifierList.selection_type` is `SINGLE`, `CatalogModifierListInfo.
+     * min_selected_modifiers=-1`
+     * and `CatalogModifierListInfo.max_selected_modifier=-1` means that exactly one modifier must be
+     * present in
+     * and can be selected from the `CatalogModifierList`
      *
      * @maps min_selected_modifiers
      */
@@ -140,6 +166,19 @@ public function setMinSelectedModifiers(?int $minSelectedModifiers): void
      * Unsets Min Selected Modifiers.
      * If 0 or larger, the smallest number of `CatalogModifier`s that must be selected from this
      * `CatalogModifierList`.
+     * The default value is `-1`.
+     *
+     * When  `CatalogModifierList.selection_type` is `MULTIPLE`, `CatalogModifierListInfo.
+     * min_selected_modifiers=-1`
+     * and `CatalogModifierListInfo.max_selected_modifier=-1` means that from zero to the maximum number of
+     * modifiers of
+     * the `CatalogModifierList` can be selected from the `CatalogModifierList`.
+     *
+     * When the `CatalogModifierList.selection_type` is `SINGLE`, `CatalogModifierListInfo.
+     * min_selected_modifiers=-1`
+     * and `CatalogModifierListInfo.max_selected_modifier=-1` means that exactly one modifier must be
+     * present in
+     * and can be selected from the `CatalogModifierList`
      */
     public function unsetMinSelectedModifiers(): void
     {
@@ -150,6 +189,19 @@ public function unsetMinSelectedModifiers(): void
      * Returns Max Selected Modifiers.
      * If 0 or larger, the largest number of `CatalogModifier`s that can be selected from this
      * `CatalogModifierList`.
+     * The default value is `-1`.
+     *
+     * When  `CatalogModifierList.selection_type` is `MULTIPLE`, `CatalogModifierListInfo.
+     * min_selected_modifiers=-1`
+     * and `CatalogModifierListInfo.max_selected_modifier=-1` means that from zero to the maximum number of
+     * modifiers of
+     * the `CatalogModifierList` can be selected from the `CatalogModifierList`.
+     *
+     * When the `CatalogModifierList.selection_type` is `SINGLE`, `CatalogModifierListInfo.
+     * min_selected_modifiers=-1`
+     * and `CatalogModifierListInfo.max_selected_modifier=-1` means that exactly one modifier must be
+     * present in
+     * and can be selected from the `CatalogModifierList`
      */
     public function getMaxSelectedModifiers(): ?int
     {
@@ -163,6 +215,19 @@ public function getMaxSelectedModifiers(): ?int
      * Sets Max Selected Modifiers.
      * If 0 or larger, the largest number of `CatalogModifier`s that can be selected from this
      * `CatalogModifierList`.
+     * The default value is `-1`.
+     *
+     * When  `CatalogModifierList.selection_type` is `MULTIPLE`, `CatalogModifierListInfo.
+     * min_selected_modifiers=-1`
+     * and `CatalogModifierListInfo.max_selected_modifier=-1` means that from zero to the maximum number of
+     * modifiers of
+     * the `CatalogModifierList` can be selected from the `CatalogModifierList`.
+     *
+     * When the `CatalogModifierList.selection_type` is `SINGLE`, `CatalogModifierListInfo.
+     * min_selected_modifiers=-1`
+     * and `CatalogModifierListInfo.max_selected_modifier=-1` means that exactly one modifier must be
+     * present in
+     * and can be selected from the `CatalogModifierList`
      *
      * @maps max_selected_modifiers
      */
@@ -175,6 +240,19 @@ public function setMaxSelectedModifiers(?int $maxSelectedModifiers): void
      * Unsets Max Selected Modifiers.
      * If 0 or larger, the largest number of `CatalogModifier`s that can be selected from this
      * `CatalogModifierList`.
+     * The default value is `-1`.
+     *
+     * When  `CatalogModifierList.selection_type` is `MULTIPLE`, `CatalogModifierListInfo.
+     * min_selected_modifiers=-1`
+     * and `CatalogModifierListInfo.max_selected_modifier=-1` means that from zero to the maximum number of
+     * modifiers of
+     * the `CatalogModifierList` can be selected from the `CatalogModifierList`.
+     *
+     * When the `CatalogModifierList.selection_type` is `SINGLE`, `CatalogModifierListInfo.
+     * min_selected_modifiers=-1`
+     * and `CatalogModifierListInfo.max_selected_modifier=-1` means that exactly one modifier must be
+     * present in
+     * and can be selected from the `CatalogModifierList`
      */
     public function unsetMaxSelectedModifiers(): void
     {