Merge pull request #129 from square/release/36.1.0.20240320

Generated PR for Release: 36.1.0.20240320

doc/api/bookings.md

@@ -79,7 +79,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

@@ -314,20 +314,20 @@ end
 
 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.
@@ -397,19 +397,19 @@ end
 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`
 
 ```ruby
 def search_shifts(body:)

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*: `'2024-02-22'` |
+| `square_version` | `String` | Square Connect API versions<br>*Default*: `'2024-03-20'` |
 | `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: '2024-02-22',
+  square_version: '2024-03-20',
   bearer_auth_credentials: BearerAuthCredentials.new(
     access_token: 'AccessToken'
   ),

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

@@ -14,8 +14,8 @@ and specifies supported behaviors of the application.
 |  --- | --- | --- | --- |
 | `modifier_list_id` | `String` | Required | The ID of the `CatalogModifierList` controlled by this `CatalogModifierListInfo`.<br>**Constraints**: *Minimum Length*: `1` |
 | `modifier_overrides` | [`Array<Catalog Modifier Override Hash>`](../../doc/models/catalog-modifier-override.md) | Optional | A set of `CatalogModifierOverride` objects that override whether a given `CatalogModifier` is enabled by default. |
-| `min_selected_modifiers` | `Integer` | Optional | If 0 or larger, the smallest number of `CatalogModifier`s that must be selected from this `CatalogModifierList`. |
-| `max_selected_modifiers` | `Integer` | Optional | If 0 or larger, the largest number of `CatalogModifier`s that can be selected from this `CatalogModifierList`. |
+| `min_selected_modifiers` | `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` |
+| `max_selected_modifiers` | `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` |
 | `enabled` | `TrueClass \| FalseClass` | Optional | If `true`, enable this `CatalogModifierList`. The default value is `true`. |
 | `ordinal` | `Integer` | Optional | The position of this `CatalogItemModifierListInfo` object within the `modifier_list_info` list applied<br>to a `CatalogItem` instance. |
 

doc/models/digital-wallet-details.md

@@ -12,7 +12,7 @@ Additional details about `WALLET` type payments. Contains only non-confidential
 | Name | Type | Tags | Description |
 |  --- | --- | --- | --- |
 | `status` | `String` | Optional | The status of the `WALLET` payment. The status can be `AUTHORIZED`, `CAPTURED`, `VOIDED`, or<br>`FAILED`.<br>**Constraints**: *Maximum Length*: `50` |
-| `brand` | `String` | Optional | The brand used for the `WALLET` payment. The brand can be `CASH_APP`, `PAYPAY` or `UNKNOWN`.<br>**Constraints**: *Maximum Length*: `50` |
+| `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` |
 | `cash_app_details` | [`Cash App Details Hash`](../../doc/models/cash-app-details.md) | Optional | Additional details about `WALLET` type payments with the `brand` of `CASH_APP`. |
 
 ## 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. |

lib/square/api/base_api.rb

@@ -5,7 +5,7 @@ class BaseApi
     attr_accessor :config, :http_call_back
 
     def self.user_agent
-      'Square-Ruby-SDK/36.0.0.20240222 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      'Square-Ruby-SDK/36.1.0.20240320 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
     end
 
     def self.user_agent_parameters

lib/square/api/bookings_api.rb

@@ -58,7 +58,7 @@ def list_bookings(limit: nil,
     # 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`
     # To call this endpoint with buyer-level permissions, set

lib/square/api/labor_api.rb

@@ -183,19 +183,20 @@ def get_employee_wage(id:)
     end
 
     # 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.
@@ -222,17 +223,17 @@ def create_shift(body:)
 
     # 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 Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
@@ -355,7 +356,7 @@ def list_team_member_wages(team_member_id: nil,
         .execute
     end
 
-    # Returns a single `TeamMemberWage` specified by `id `.
+    # Returns a single `TeamMemberWage` specified by `id`.
     # @param [String] id Required parameter: The UUID for the `TeamMemberWage`
     # being retrieved.
     # @return [GetTeamMemberWageResponse Hash] response from the API call

lib/square/client.rb

@@ -5,7 +5,7 @@ class Client
     attr_reader :config, :auth_managers
 
     def sdk_version
-      '36.0.0.20240222'
+      '36.1.0.20240320'
     end
 
     def square_version
@@ -268,7 +268,7 @@ def initialize(
       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
       retry_methods: %i[get put], http_callback: nil, environment: 'production',
       custom_url: 'https://connect.squareup.com', access_token: nil,
-      bearer_auth_credentials: nil, square_version: '2024-02-22',
+      bearer_auth_credentials: nil, square_version: '2024-03-20',
       user_agent_detail: '', additional_headers: {}, config: nil
     )
       @config = if config.nil?

lib/square/configuration.rb

@@ -24,7 +24,7 @@ def initialize(
       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
       retry_methods: %i[get put], http_callback: nil, environment: 'production',
       custom_url: 'https://connect.squareup.com', access_token: nil,
-      bearer_auth_credentials: nil, square_version: '2024-02-22',
+      bearer_auth_credentials: nil, square_version: '2024-03-20',
       user_agent_detail: '', additional_headers: {}
     )
 

lib/square/http/api_response.rb

@@ -20,7 +20,7 @@ def initialize(http_response,
 
         @cursor = data.fetch(:cursor, nil)
         data.reject! { |k| %i[cursor errors].include?(k) }
-        @data = Struct.new(*data.keys).new(*data.values) if data.keys.any?
+        @data = data.keys.any? ? Struct.new(*data.keys).new(*data.values) : nil
       else
         @data = data
         @body = data

square.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'square.rb'
-  s.version = '36.0.0.20240222'
+  s.version = '36.1.0.20240320'
   s.summary = 'square'
   s.description = ''
   s.authors = ['Square Developer Platform']