Merge pull request #121 from square/release/30.0.0.20230816

Generated PR for Release: 30.0.0.20230816

Author: daphnechiu

README.md

@@ -87,6 +87,7 @@ All environment variables:
 
 ### Orders
 * [Orders]
+* [Order Custom Attributes]
 
 ### Subscriptions
 * [Subscriptions]
@@ -113,10 +114,13 @@ All environment variables:
 
 ### Bookings
 * [Bookings]
+* [Booking Custom Attributes]
 
 ### Business
 * [Merchants]
+* [Merchant Custom Attributes]
 * [Locations]
+* [Location Custom Attributes]
 * [Devices]
 * [Cash Drawers]
 * [Vendors]
@@ -170,9 +174,13 @@ The following Square APIs are [deprecated](https://developer.squareup.com/docs/b
 [Labor]: doc/apis/labor.md
 [Loyalty]: doc/apis/loyalty.md
 [Bookings]: doc/apis/bookings.md
+[Booking Custom Attributes]: doc/api/booking-custom-attributes.md
 [Locations]: doc/apis/locations.md
+[Location Custom Attributes]: doc/api/location-custom-attributes.md
 [Merchants]: doc/apis/merchants.md
+[Merchant Custom Attributes]: doc/api/merchant-custom-attributes.md
 [Orders]: doc/apis/orders.md
+[Order Custom Attributes]: doc/api/order-custom-attributes.md
 [Invoices]: doc/apis/invoices.md
 [Apple Pay]: doc/apis/apple-pay.md
 [Refunds]: doc/apis/refunds.md

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": "29.1.0.20230720",
+    "version": "30.0.0.20230816",
     "type": "library",
     "keywords": [
         "Square",

doc/apis/bookings.md

@@ -13,6 +13,7 @@ $bookingsApi = $client->getBookingsApi();
 * [List Bookings](../../doc/apis/bookings.md#list-bookings)
 * [Create Booking](../../doc/apis/bookings.md#create-booking)
 * [Search Availability](../../doc/apis/bookings.md#search-availability)
+* [Bulk Retrieve Bookings](../../doc/apis/bookings.md#bulk-retrieve-bookings)
 * [Retrieve Business Booking Profile](../../doc/apis/bookings.md#retrieve-business-booking-profile)
 * [List Team Member Booking Profiles](../../doc/apis/bookings.md#list-team-member-booking-profiles)
 * [Retrieve Team Member Booking Profile](../../doc/apis/bookings.md#retrieve-team-member-booking-profile)
@@ -32,6 +33,7 @@ To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ`
 function listBookings(
     ?int $limit = null,
     ?string $cursor = null,
+    ?string $customerId = null,
     ?string $teamMemberId = null,
     ?string $locationId = null,
     ?string $startAtMin = null,
@@ -45,6 +47,7 @@ function listBookings(
 |  --- | --- | --- | --- |
 | `limit` | `?int` | 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. |
@@ -170,6 +173,52 @@ var_dump($apiResponse->getHeaders());
 ```
 
 
+# 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.
+
+```php
+function bulkRetrieveBookings(BulkRetrieveBookingsRequest $body): ApiResponse
+```
+
+## 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
+
+This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`BulkRetrieveBookingsResponse`](../../doc/models/bulk-retrieve-bookings-response.md).
+
+## Example Usage
+
+```php
+$body = BulkRetrieveBookingsRequestBuilder::init(
+    [
+        'booking_ids8',
+        'booking_ids9',
+        'booking_ids0'
+    ]
+)->build();
+
+$apiResponse = $bookingsApi->bulkRetrieveBookings($body);
+
+if ($apiResponse->isSuccess()) {
+    $bulkRetrieveBookingsResponse = $apiResponse->getResult();
+} else {
+    $errors = $apiResponse->getErrors();
+}
+
+// Getting more response information
+var_dump($apiResponse->getStatusCode());
+var_dump($apiResponse->getHeaders());
+```
+
+
 # Retrieve Business Booking Profile
 
 Retrieves a seller's booking profile.

doc/apis/gift-cards.md

@@ -40,7 +40,7 @@ function listGiftCards(
 |  --- | --- | --- | --- |
 | `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` | `?int` | 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` | `?int` | 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/apis/loyalty.md

@@ -557,10 +557,11 @@ $body = CreateLoyaltyPromotionRequestBuilder::init(
             LoyaltyPromotionIncentiveType::POINTS_MULTIPLIER
         )
             ->pointsMultiplierData(
-                LoyaltyPromotionIncentivePointsMultiplierDataBuilder::init(
-                    3
-                )->build()
-            )->build(),
+                LoyaltyPromotionIncentivePointsMultiplierDataBuilder::init()
+                    ->multiplier('3.0')
+                    ->build()
+            )
+            ->build(),
         LoyaltyPromotionAvailableTimeDataBuilder::init(
             [
                 'BEGIN:VEVENT

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`** |
 | `timeout` | `int` | Timeout for API calls in seconds.<br>*Default*: `60` |
@@ -26,7 +26,7 @@ The API client can be initialized as follows:
 ```php
 $client = SquareClientBuilder::init()
     ->accessToken('AccessToken')
-    ->squareVersion('2023-07-20')
+    ->squareVersion('2023-08-16')
     ->environment('production')
     ->customUrl('https://connect.squareup.com')
     ->build();
@@ -51,7 +51,7 @@ use Square\SquareClientBuilder;
 
 $client = SquareClientBuilder::init()
     ->accessToken('AccessToken')
-    ->squareVersion('2023-07-20')
+    ->squareVersion('2023-08-16')
     ->build();
 
 $apiResponse = $client->getLocationsApi()->listLocations();

doc/models/archived-state.md

@@ -0,0 +1,19 @@
+
+# Archived State
+
+Defines the values for the `archived_state` query expression
+used in [SearchCatalogItems](../../doc/apis/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 | Setter |
 |  --- | --- | --- | --- | --- | --- |
-| `bookingId` | `string` | Required | The ID of the target [booking](entity:Booking).<br>**Constraints**: *Minimum Length*: `1` | getBookingId(): string | setBookingId(string bookingId): void |
+| `bookingId` | `string` | Required | The ID of the target [booking](entity:Booking).<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | getBookingId(): string | setBookingId(string bookingId): void |
 | `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` | getKey(): string | setKey(string key): void |
 
 ## 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 | Setter |
 |  --- | --- | --- | --- | --- | --- |
-| `bookingId` | `string` | Required | The ID of the target [booking](entity:Booking).<br>**Constraints**: *Minimum Length*: `1` | getBookingId(): string | setBookingId(string bookingId): void |
+| `bookingId` | `string` | Required | The ID of the target [booking](entity:Booking).<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | getBookingId(): string | setBookingId(string bookingId): void |
 | `customAttribute` | [`CustomAttribute`](../../doc/models/custom-attribute.md) | Required | A custom attribute value. Each custom attribute value has a corresponding<br>`CustomAttributeDefinition` object. | getCustomAttribute(): CustomAttribute | setCustomAttribute(CustomAttribute customAttribute): void |
 | `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` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
 

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 | Setter |
+|  --- | --- | --- | --- | --- | --- |
+| `bookingIds` | `string[]` | Required | A non-empty list of [Booking](entity:Booking) IDs specifying bookings to retrieve. | getBookingIds(): array | setBookingIds(array bookingIds): void |
+
+## Example (as JSON)
+
+```json
+{
+  "booking_ids": [
+    "booking_ids4"
+  ]
+}
+```
+