square.rb 24.0.0.20221019 → 25.0.0.20221116

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f44f7db801dca9eabe4e9ec3b3a9efebaf9d7e67573a3f15a19bd998a13f9cbf
-  data.tar.gz: f5c70958388a7a72f45bd286403db52c72c525beb52b3dd70fe076ee31eb2384
+  metadata.gz: 5dc4e9fcd63b3813aa4ad5988917a80efbd309ea3b794f430c8b272936337c97
+  data.tar.gz: 403fdfd4137b70d63cc475967d937ec84022732b3b6a553b31320e700acfa7d9
 SHA512:
-  metadata.gz: d512e32b13ae4d8d7d1ca7ef3e71576a6b8f79b52c990c9ae438dfcf612236d371cf62a5101643d9b2b6ab7f3e49f0ca66bebfb35adf73cf7fb20347dfc279e3
-  data.tar.gz: 5d4bfd92ee8d7fb2598b49861fb36b46250d0517a73235b9a3f28b43306d7db295ade4ddd22f96b317a201ae1b544a7c032674a6901cd2265a00e21cce25b24c
+  metadata.gz: f4200d28c6187cc9c01c528a01626bf2d5e38288ef66100ad799a0948485af0ca2b5b3ace39d6b84cb3685abe45f2a5298e5e93392b1cb2b396b873a65fb3e73
+  data.tar.gz: 7e3f21e90b2e4609c48463883c9ec4fa6555d28b6eccc9e71a89879384de1d9635309a5bbe1c0c0e5b7661a2fffa4b6b95b6d1ab2700a6d7d19a2d66f9e7d1f9

data/lib/square/api/base_api.rb

@@ -45,7 +45,7 @@ module Square
     end
 
     def get_user_agent
-      user_agent = 'Square-Ruby-SDK/24.0.0.20221019 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      user_agent = 'Square-Ruby-SDK/25.0.0.20221116 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
       user_agent['{engine}'] = RUBY_ENGINE
       user_agent['{engine-version}'] = RUBY_ENGINE_VERSION
       user_agent['{os-info}'] = RUBY_PLATFORM

data/lib/square/api/booking_custom_attributes_api.rb

@@ -0,0 +1,555 @@
+module Square
+  # BookingCustomAttributesApi
+  class BookingCustomAttributesApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Get all bookings custom attribute definitions.
+    # 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.
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to return in a single paged response. This limit is advisory. The response
+    # might contain more or fewer results. The minimum value is 1 and the
+    # maximum value is 100. The default value is 20. For more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
+    # @param [String] cursor Optional parameter: The cursor returned in the
+    # paged response from the previous call to this endpoint. Provide this
+    # cursor to retrieve the next page of results for your original request. For
+    # more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
+    # @return [ListBookingCustomAttributeDefinitionsResponse Hash] response from the API call
+    def list_booking_custom_attribute_definitions(limit: nil,
+                                                  cursor: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/custom-attribute-definitions'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'limit' => limit,
+        'cursor' => cursor
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Creates a bookings custom attribute definition.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_WRITE` for the OAuth scope.
+    # To call this endpoint with seller-level permissions, set
+    # `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+    # For calls to this endpoint with seller-level permissions to succeed, the
+    # seller must have subscribed to *Appointments Plus*
+    # or *Appointments Premium*.
+    # @param [CreateBookingCustomAttributeDefinitionRequest] body Required
+    # parameter: An object containing the fields to POST for the request.  See
+    # the corresponding object definition for field details.
+    # @return [CreateBookingCustomAttributeDefinitionResponse Hash] response from the API call
+    def create_booking_custom_attribute_definition(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/custom-attribute-definitions'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Deletes a bookings custom attribute definition.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_WRITE` for the OAuth scope.
+    # To call this endpoint with seller-level permissions, set
+    # `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+    # For calls to this endpoint with seller-level permissions to succeed, the
+    # seller must have subscribed to *Appointments Plus*
+    # or *Appointments Premium*.
+    # @param [String] key Required parameter: The key of the custom attribute
+    # definition to delete.
+    # @return [DeleteBookingCustomAttributeDefinitionResponse Hash] response from the API call
+    def delete_booking_custom_attribute_definition(key:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/custom-attribute-definitions/{key}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'key' => { 'value' => key, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Retrieves a bookings custom attribute definition.
+    # 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.
+    # @param [String] key Required parameter: The key of the custom attribute
+    # definition to retrieve. If the requesting application is not the
+    # definition owner, you must use the qualified key.
+    # @param [Integer] version Optional parameter: The current version of the
+    # custom attribute definition, which is used for strongly consistent reads
+    # to guarantee that you receive the most up-to-date data. When included in
+    # the request, Square returns the specified version or a higher version if
+    # one exists. If the specified version is higher than the current version,
+    # Square returns a `BAD_REQUEST` error.
+    # @return [RetrieveBookingCustomAttributeDefinitionResponse Hash] response from the API call
+    def retrieve_booking_custom_attribute_definition(key:,
+                                                     version: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/custom-attribute-definitions/{key}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'key' => { 'value' => key, 'encode' => true }
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'version' => version
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Updates a bookings custom attribute definition.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_WRITE` for the OAuth scope.
+    # To call this endpoint with seller-level permissions, set
+    # `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+    # For calls to this endpoint with seller-level permissions to succeed, the
+    # seller must have subscribed to *Appointments Plus*
+    # or *Appointments Premium*.
+    # @param [String] key Required parameter: The key of the custom attribute
+    # definition to update.
+    # @param [UpdateBookingCustomAttributeDefinitionRequest] body Required
+    # parameter: An object containing the fields to POST for the request.  See
+    # the corresponding object definition for field details.
+    # @return [UpdateBookingCustomAttributeDefinitionResponse Hash] response from the API call
+    def update_booking_custom_attribute_definition(key:,
+                                                   body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/custom-attribute-definitions/{key}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'key' => { 'value' => key, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.put(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Bulk deletes bookings custom attributes.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_WRITE` for the OAuth scope.
+    # To call this endpoint with seller-level permissions, set
+    # `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+    # For calls to this endpoint with seller-level permissions to succeed, the
+    # seller must have subscribed to *Appointments Plus*
+    # or *Appointments Premium*.
+    # @param [BulkDeleteBookingCustomAttributesRequest] body Required parameter:
+    # An object containing the fields to POST for the request.  See the
+    # corresponding object definition for field details.
+    # @return [BulkDeleteBookingCustomAttributesResponse Hash] response from the API call
+    def bulk_delete_booking_custom_attributes(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/custom-attributes/bulk-delete'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Bulk upserts bookings custom attributes.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_WRITE` for the OAuth scope.
+    # To call this endpoint with seller-level permissions, set
+    # `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+    # For calls to this endpoint with seller-level permissions to succeed, the
+    # seller must have subscribed to *Appointments Plus*
+    # or *Appointments Premium*.
+    # @param [BulkUpsertBookingCustomAttributesRequest] body Required parameter:
+    # An object containing the fields to POST for the request.  See the
+    # corresponding object definition for field details.
+    # @return [BulkUpsertBookingCustomAttributesResponse Hash] response from the API call
+    def bulk_upsert_booking_custom_attributes(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/custom-attributes/bulk-upsert'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Lists a booking's custom attributes.
+    # 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.
+    # @param [String] booking_id Required parameter: The ID of the target
+    # [booking]($m/Booking).
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to return in a single paged response. This limit is advisory. The response
+    # might contain more or fewer results. The minimum value is 1 and the
+    # maximum value is 100. The default value is 20. For more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
+    # @param [String] cursor Optional parameter: The cursor returned in the
+    # paged response from the previous call to this endpoint. Provide this
+    # cursor to retrieve the next page of results for your original request. For
+    # more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
+    # @param [TrueClass|FalseClass] with_definitions Optional parameter:
+    # Indicates whether to return the [custom attribute
+    # definition]($m/CustomAttributeDefinition) in the `definition` field of
+    # each custom attribute. Set this parameter to `true` to get the name and
+    # description of each custom attribute, information about the data type, or
+    # other definition details. The default value is `false`.
+    # @return [ListBookingCustomAttributesResponse Hash] response from the API call
+    def list_booking_custom_attributes(booking_id:,
+                                       limit: nil,
+                                       cursor: nil,
+                                       with_definitions: false)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/{booking_id}/custom-attributes'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'booking_id' => { 'value' => booking_id, 'encode' => true }
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'limit' => limit,
+        'cursor' => cursor,
+        'with_definitions' => with_definitions
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Deletes a bookings custom attribute.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_WRITE` for the OAuth scope.
+    # To call this endpoint with seller-level permissions, set
+    # `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+    # For calls to this endpoint with seller-level permissions to succeed, the
+    # seller must have subscribed to *Appointments Plus*
+    # or *Appointments Premium*.
+    # @param [String] booking_id Required parameter: The ID of the target
+    # [booking]($m/Booking).
+    # @param [String] key Required parameter: The key of the custom attribute to
+    # delete. This key must match the `key` of a custom attribute definition in
+    # the Square seller account. If the requesting application is not the
+    # definition owner, you must use the qualified key.
+    # @return [DeleteBookingCustomAttributeResponse Hash] response from the API call
+    def delete_booking_custom_attribute(booking_id:,
+                                        key:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/{booking_id}/custom-attributes/{key}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'booking_id' => { 'value' => booking_id, 'encode' => true },
+        'key' => { 'value' => key, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Retrieves a bookings custom attribute.
+    # 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.
+    # @param [String] booking_id Required parameter: The ID of the target
+    # [booking]($m/Booking).
+    # @param [String] key Required parameter: The key of the custom attribute to
+    # retrieve. This key must match the `key` of a custom attribute definition
+    # in the Square seller account. If the requesting application is not the
+    # definition owner, you must use the qualified key.
+    # @param [TrueClass|FalseClass] with_definition Optional parameter:
+    # Indicates whether to return the [custom attribute
+    # definition]($m/CustomAttributeDefinition) in the `definition` field of the
+    # custom attribute. Set this parameter to `true` to get the name and
+    # description of the custom attribute, information about the data type, or
+    # other definition details. The default value is `false`.
+    # @param [Integer] version Optional parameter: The current version of the
+    # custom attribute, which is used for strongly consistent reads to guarantee
+    # that you receive the most up-to-date data. When included in the request,
+    # Square returns the specified version or a higher version if one exists. If
+    # the specified version is higher than the current version, Square returns a
+    # `BAD_REQUEST` error.
+    # @return [RetrieveBookingCustomAttributeResponse Hash] response from the API call
+    def retrieve_booking_custom_attribute(booking_id:,
+                                          key:,
+                                          with_definition: false,
+                                          version: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/{booking_id}/custom-attributes/{key}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'booking_id' => { 'value' => booking_id, 'encode' => true },
+        'key' => { 'value' => key, 'encode' => true }
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'with_definition' => with_definition,
+        'version' => version
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Upserts a bookings custom attribute.
+    # To call this endpoint with buyer-level permissions, set
+    # `APPOINTMENTS_WRITE` for the OAuth scope.
+    # To call this endpoint with seller-level permissions, set
+    # `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+    # For calls to this endpoint with seller-level permissions to succeed, the
+    # seller must have subscribed to *Appointments Plus*
+    # or *Appointments Premium*.
+    # @param [String] booking_id Required parameter: The ID of the target
+    # [booking]($m/Booking).
+    # @param [String] key Required parameter: The key of the custom attribute to
+    # create or update. This key must match the `key` of a custom attribute
+    # definition in the Square seller account. If the requesting application is
+    # not the definition owner, you must use the qualified key.
+    # @param [UpsertBookingCustomAttributeRequest] body Required parameter: An
+    # object containing the fields to POST for the request.  See the
+    # corresponding object definition for field details.
+    # @return [UpsertBookingCustomAttributeResponse Hash] response from the API call
+    def upsert_booking_custom_attribute(booking_id:,
+                                        key:,
+                                        body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings/{booking_id}/custom-attributes/{key}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'booking_id' => { 'value' => booking_id, 'encode' => true },
+        'key' => { 'value' => key, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.put(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+  end
+end

data/lib/square/api/catalog_api.rb

@@ -16,6 +16,11 @@ module Square
     # targeted
     # IDs can be deleted. The response will only include IDs that were
     # actually deleted.
+    # To ensure consistency, only one delete request is processed at a time per
+    # seller account.
+    # While one (batch or non-batch) delete request is being processed, other
+    # (batched and non-batched)
+    # delete requests are rejected with the `429` error code.
     # @param [BatchDeleteCatalogObjectsRequest] body Required parameter: An
     # object containing the fields to POST for the request.  See the
     # corresponding object definition for field details.
@@ -102,6 +107,11 @@ module Square
     # request (items, variations, modifier lists, discounts, and taxes) is no
     # more
     # than 10,000.
+    # To ensure consistency, only one update request is processed at a time per
+    # seller account.
+    # While one (batch or non-batch) update request is being processed, other
+    # (batched and non-batched)
+    # update requests are rejected with the `429` error code.
     # @param [BatchUpsertCatalogObjectsRequest] body Required parameter: An
     # object containing the fields to POST for the request.  See the
     # corresponding object definition for field details.
@@ -320,7 +330,7 @@ module Square
     # SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION,
     # QUICK_AMOUNT_SETTINGS.
     # @param [Integer] catalog_version Optional parameter: The specific version
-    # of the catalog objects to be included in the response.  This allows you to
+    # of the catalog objects to be included in the response. This allows you to
     # retrieve historical versions of objects. The specified version value is
     # matched against the [CatalogObject]($m/CatalogObject)s' `version`
     # attribute.  If not included, results will be from the current version of
@@ -361,7 +371,12 @@ module Square
       )
     end
 
-    # Creates or updates the target [CatalogObject]($m/CatalogObject).
+    # Creates a new or updates the specified [CatalogObject]($m/CatalogObject).
+    # To ensure consistency, only one update request is processed at a time per
+    # seller account.
+    # While one (batch or non-batch) update request is being processed, other
+    # (batched and non-batched)
+    # update requests are rejected with the `429` error code.
     # @param [UpsertCatalogObjectRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -403,6 +418,11 @@ module Square
     # are also deleted. For example, deleting a [CatalogItem]($m/CatalogItem)
     # will also delete all of its
     # [CatalogItemVariation]($m/CatalogItemVariation) children.
+    # To ensure consistency, only one delete request is processed at a time per
+    # seller account.
+    # While one (batch or non-batch) delete request is being processed, other
+    # (batched and non-batched)
+    # delete requests are rejected with the `429` error code.
     # @param [String] object_id Required parameter: The ID of the catalog object
     # to be deleted. When an object is deleted, other objects in the graph that
     # depend on that object will be deleted as well (for example, deleting a

data/lib/square/api/customers_api.rb

@@ -156,11 +156,12 @@ module Square
 
     # Deletes a customer profile from a business. This operation also unlinks
     # any associated cards on file.
-    # As a best practice, you should include the `version` field in the request
-    # to enable [optimistic
-    # concurrency](https://developer.squareup.com/docs/working-with-apis/optimis
-    # tic-concurrency) control. The value must be set to the current version of
-    # the customer profile.
+    # As a best practice, include the `version` field in the request to enable
+    # [optimistic
+    # concurrency](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/optimistic-concurrency) control.
+    # If included, the value must be set to the current version of the customer
+    # profile.
     # To delete a customer profile that was created by merging existing
     # profiles, you must use the ID of the newly created profile.
     # @param [String] customer_id Required parameter: The ID of the customer to
@@ -245,14 +246,17 @@ module Square
       )
     end
 
-    # Updates a customer profile. To change an attribute, specify the new value.
-    # To remove an attribute, specify the value as an empty string or empty
-    # object.
-    # As a best practice, you should include the `version` field in the request
-    # to enable [optimistic
-    # concurrency](https://developer.squareup.com/docs/working-with-apis/optimis
-    # tic-concurrency) control. The value must be set to the current version of
-    # the customer profile.
+    # Updates a customer profile. This endpoint supports sparse updates, so only
+    # new or changed fields are required in the request.
+    # To add or update a field, specify the new value. To remove a field,
+    # specify `null` and include the `X-Clear-Null` header set to `true`
+    # (recommended) or specify an empty string (string fields only).
+    # As a best practice, include the `version` field in the request to enable
+    # [optimistic
+    # concurrency](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/optimistic-concurrency) control.
+    # If included, the value must be set to the current version of the customer
+    # profile.
     # To update a customer profile that was created by merging existing
     # profiles, you must use the ID of the newly created profile.
     # You cannot use this endpoint to change cards on file. To make changes, use