Merge pull request #119 from square/release/31.0.0.20230816

Generated PR for Release: 31.0.0.20230816

Author: daphnechiu

README.md

@@ -77,6 +77,7 @@ rake
 
 ### Orders
 * [Orders]
+* [Order Custom Attributes]
 
 ### Subscriptions
 * [Subscriptions]
@@ -103,10 +104,13 @@ rake
 
 ### Bookings
 * [Bookings]
+* [Booking Custom Attributes]
 
 ### Business
 * [Merchants]
+* [Merchant Custom Attributes]
 * [Locations]
+* [Location Custom Attributes]
 * [Devices]
 * [Cash Drawers]
 * [Vendors]
@@ -162,9 +166,13 @@ The following Square APIs are [deprecated](https://developer.squareup.com/docs/b
 [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 @@ bookings_api = client.bookings
 * [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)
@@ -31,6 +32,7 @@ To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ`
 ```ruby
 def list_bookings(limit: nil,
                   cursor: nil,
+                  customer_id: nil,
                   team_member_id: nil,
                   location_id: nil,
                   start_at_min: nil,
@@ -43,6 +45,7 @@ def list_bookings(limit: nil,
 |  --- | --- | --- | --- |
 | `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. |
+| `customer_id` | `String` | Query, Optional | The [customer](entity:Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved. |
 | `team_member_id` | `String` | Query, Optional | The team member for whom to retrieve bookings. If this is not set, bookings of all members are retrieved. |
 | `location_id` | `String` | Query, Optional | The location for which to retrieve bookings. If this is not set, all locations' bookings are retrieved. |
 | `start_at_min` | `String` | Query, Optional | The RFC 3339 timestamp specifying the earliest of the start time. If this is not set, the current time is used. |
@@ -158,6 +161,49 @@ end
 ```
 
 
+# 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.
+
+```ruby
+def bulk_retrieve_bookings(body:)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `body` | [`Bulk Retrieve Bookings Request Hash`](../../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 `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Retrieve Bookings Response Hash`](../../doc/models/bulk-retrieve-bookings-response.md).
+
+## Example Usage
+
+```ruby
+body = {
+  :booking_ids => [
+    'booking_ids8',
+    'booking_ids9',
+    'booking_ids0'
+  ]
+}
+
+
+result = bookings_api.bulk_retrieve_bookings(body: body)
+
+if result.success?
+  puts result.data
+elsif result.error?
+  warn result.errors
+end
+```
+
+
 # Retrieve Business Booking Profile
 
 Retrieves a seller's booking profile.

doc/api/gift-cards.md

@@ -38,7 +38,7 @@ def list_gift_cards(type: nil,
 |  --- | --- | --- | --- |
 | `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). |
 | `customer_id` | `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

@@ -515,16 +515,12 @@ body = {
     :incentive => {
       :type => 'POINTS_MULTIPLIER',
       :points_multiplier_data => {
-        :points_multiplier => 3
+        :multiplier => '3.0'
       }
     },
     :available_time => {
       :time_periods => [
-        'BEGIN:VEVENT
-DTSTART:20220816T160000
-DURATION:PT2H
-RRULE:FREQ=WEEKLY;BYDAY=TU
-END:VEVENT'
+        'BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT'
       ]
     },
     :trigger_limit => {

doc/client.md

@@ -5,7 +5,7 @@ The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| `square_version` | `String` | Square Connect API versions<br>*Default*: `'2023-07-20'` |
+| `square_version` | `String` | Square Connect API versions<br>*Default*: `'2023-08-16'` |
 | `custom_url` | `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`** |
 | `connection` | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
@@ -25,7 +25,7 @@ The API client can be initialized as follows:
 
 ```ruby
 client = Square::Client.new(
-  square_version: '2023-07-20',
+  square_version: '2023-08-16',
   access_token: 'AccessToken',
   environment: 'production',
   custom_url: 'https://connect.squareup.com'

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
+
+`Archived State`
+
+## 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 |
 |  --- | --- | --- | --- |
-| `booking_id` | `String` | Required | The ID of the target [booking](entity:Booking).<br>**Constraints**: *Minimum Length*: `1` |
+| `booking_id` | `String` | Required | The ID of the target [booking](entity:Booking).<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
 | `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` |
 
 ## Example (as JSON)

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

@@ -13,7 +13,7 @@ and an optional idempotency key.
 
 | Name | Type | Tags | Description |
 |  --- | --- | --- | --- |
-| `booking_id` | `String` | Required | The ID of the target [booking](entity:Booking).<br>**Constraints**: *Minimum Length*: `1` |
+| `booking_id` | `String` | Required | The ID of the target [booking](entity:Booking).<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
 | `custom_attribute` | [`Custom Attribute Hash`](../../doc/models/custom-attribute.md) | Required | A custom attribute value. Each custom attribute value has a corresponding<br>`CustomAttributeDefinition` object. |
 | `idempotency_key` | `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` |
 

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

@@ -0,0 +1,25 @@
+
+# Bulk Retrieve Bookings Request
+
+Request payload for bulk retrieval of bookings.
+
+## Structure
+
+`Bulk Retrieve Bookings Request`
+
+## Fields
+
+| Name | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `booking_ids` | `Array<String>` | Required | A non-empty list of [Booking](entity:Booking) IDs specifying bookings to retrieve. |
+
+## 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
+
+`Bulk Retrieve Bookings Response`
+
+## Fields
+
+| Name | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `bookings` | [`Hash String Retrieve Booking Response Hash`](../../doc/models/retrieve-booking-response.md) | Optional | Requested bookings returned as a map containing `booking_id` as the key and `RetrieveBookingResponse` as the value. |
+| `errors` | [`Array<Error Hash>`](../../doc/models/error.md) | Optional | Errors that occurred during the request. |
+
+## 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": []
+}
+```
+