square.rb 6.3.0.20200826 → 17.1.0.20220120

data/lib/square/api/customer_groups_api.rb

@@ -7,18 +7,26 @@ module Square
 
     # Retrieves the list of customer groups of a business.
     # @param [String] cursor Optional parameter: A pagination cursor returned by
-    # a previous call to this endpoint. Provide this to retrieve the next set of
-    # results for your original query.  See the [Pagination
-    # guide](https://developer.squareup.com/docs/working-with-apis/pagination)
-    # for more information.
+    # a previous call to this endpoint. Provide this cursor to retrieve the next
+    # set of results for your original query.  For more information, see
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to return in a single page. This limit is advisory. The response might
+    # contain more or fewer results. The limit is ignored if it is less than 1
+    # or greater than 50. The default value is 50.  For more information, see
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
     # @return [ListCustomerGroupsResponse Hash] response from the API call
-    def list_customer_groups(cursor: nil)
+    def list_customer_groups(cursor: nil,
+                             limit: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/customers/groups'
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
-        'cursor' => cursor
+        'cursor' => cursor,
+        'limit' => limit
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -38,7 +46,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Creates a new customer group for a business.
@@ -56,7 +66,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -71,7 +81,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Deletes a customer group as identified by the `group_id` value.
@@ -84,7 +96,7 @@ module Square
       _query_builder << '/v2/customers/groups/{group_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'group_id' => group_id
+        'group_id' => { 'value' => group_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -104,7 +116,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Retrieves a specific customer group as identified by the `group_id` value.
@@ -117,7 +131,7 @@ module Square
       _query_builder << '/v2/customers/groups/{group_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'group_id' => group_id
+        'group_id' => { 'value' => group_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -137,7 +151,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Updates a customer group as identified by the `group_id` value.
@@ -154,14 +170,14 @@ module Square
       _query_builder << '/v2/customers/groups/{group_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'group_id' => group_id
+        'group_id' => { 'value' => group_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -176,7 +192,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end

data/lib/square/api/customer_segments_api.rb

@@ -7,18 +7,26 @@ module Square
 
     # Retrieves the list of customer segments of a business.
     # @param [String] cursor Optional parameter: A pagination cursor returned by
-    # previous calls to __ListCustomerSegments__. Used to retrieve the next set
-    # of query results.  See the [Pagination
-    # guide](https://developer.squareup.com/docs/docs/working-with-apis/paginati
-    # on) for more information.
+    # previous calls to `ListCustomerSegments`. This cursor is used to retrieve
+    # the next set of query results.  For more information, see
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to return in a single page. This limit is advisory. The response might
+    # contain more or fewer results. The limit is ignored if it is less than 1
+    # or greater than 50. The default value is 50.  For more information, see
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
     # @return [ListCustomerSegmentsResponse Hash] response from the API call
-    def list_customer_segments(cursor: nil)
+    def list_customer_segments(cursor: nil,
+                               limit: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/customers/segments'
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
-        'cursor' => cursor
+        'cursor' => cursor,
+        'limit' => limit
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -38,7 +46,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Retrieves a specific customer segment as identified by the `segment_id`
@@ -52,7 +62,7 @@ module Square
       _query_builder << '/v2/customers/segments/{segment_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'segment_id' => segment_id
+        'segment_id' => { 'value' => segment_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -72,7 +82,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end

data/lib/square/api/customers_api.rb

@@ -10,20 +10,27 @@ module Square
     # profiles become available
     # for the listing operation in well under 30 seconds. Occasionally,
     # propagation of the new or updated
-    # profiles can take closer to one minute or longer, espeically during
+    # profiles can take closer to one minute or longer, especially during
     # network incidents and outages.
     # @param [String] cursor Optional parameter: A pagination cursor returned by
-    # a previous call to this endpoint. Provide this to retrieve the next set of
-    # results for your original query.  See the [Pagination
-    # guide](https://developer.squareup.com/docs/working-with-apis/pagination)
-    # for more information.
+    # a previous call to this endpoint. Provide this cursor to retrieve the next
+    # set of results for your original query.  For more information, see
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to return in a single page. This limit is advisory. The response might
+    # contain more or fewer results. The limit is ignored if it is less than 1
+    # or greater than 100. The default value is 100.  For more information, see
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
     # @param [CustomerSortField] sort_field Optional parameter: Indicates how
-    # Customers should be sorted.  Default: `DEFAULT`.
+    # customers should be sorted.  The default value is `DEFAULT`.
     # @param [SortOrder] sort_order Optional parameter: Indicates whether
-    # Customers should be sorted in ascending (`ASC`) or descending (`DESC`)
-    # order.  Default: `ASC`.
+    # customers should be sorted in ascending (`ASC`) or descending (`DESC`)
+    # order.  The default value is `ASC`.
     # @return [ListCustomersResponse Hash] response from the API call
     def list_customers(cursor: nil,
+                       limit: nil,
                        sort_field: nil,
                        sort_order: nil)
       # Prepare query url.
@@ -32,6 +39,7 @@ module Square
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
         'cursor' => cursor,
+        'limit' => limit,
         'sort_field' => sort_field,
         'sort_order' => sort_order
       )
@@ -53,13 +61,14 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
-    # Creates a new customer for a business, which can have associated cards on
-    # file.
-    # You must provide __at least one__ of the following values in your request
-    # to this
+    # Creates a new customer for a business.
+    # You must provide at least one of the following values in your request to
+    # this
     # endpoint:
     # - `given_name`
     # - `family_name`
@@ -79,7 +88,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -94,11 +103,13 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
-    # Searches the customer profiles associated with a Square account using
-    # one or more supported query filters.
+    # Searches the customer profiles associated with a Square account using a
+    # supported query filter.
     # Calling `SearchCustomers` without any explicit query filter returns all
     # customer profiles ordered alphabetically based on `given_name` and
     # `family_name`.
@@ -106,7 +117,7 @@ module Square
     # profiles become available
     # for the search operation in well under 30 seconds. Occasionally,
     # propagation of the new or updated
-    # profiles can take closer to one minute or longer, espeically during
+    # profiles can take closer to one minute or longer, especially during
     # network incidents and outages.
     # @param [SearchCustomersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -121,7 +132,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -136,24 +147,42 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
-    # Deletes a customer from a business, along with any linked cards on file.
-    # When two profiles
-    # are merged into a single profile, that profile is assigned a new
-    # `customer_id`. You must use the
-    # new `customer_id` to delete merged profiles.
+    # 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.
+    # 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
     # delete.
+    # @param [Long] version Optional parameter: The current version of the
+    # customer profile.  As a best practice, you should include this parameter
+    # to enable [optimistic
+    # concurrency](https://developer.squareup.com/docs/working-with-apis/optimis
+    # tic-concurrency) control.  For more information, see [Delete a customer
+    # profile](https://developer.squareup.com/docs/customers-api/use-the-api/kee
+    # p-records#delete-customer-profile).
     # @return [DeleteCustomerResponse Hash] response from the API call
-    def delete_customer(customer_id:)
+    def delete_customer(customer_id:,
+                        version: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/customers/{customer_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'customer_id' => customer_id
+        'customer_id' => { 'value' => customer_id, 'encode' => true }
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'version' => version
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -173,7 +202,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Returns details for a single customer.
@@ -186,7 +217,7 @@ module Square
       _query_builder << '/v2/customers/{customer_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'customer_id' => customer_id
+        'customer_id' => { 'value' => customer_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -206,19 +237,23 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
-    # Updates the details of an existing customer. When two profiles are merged
-    # into a single profile, that profile is assigned a new `customer_id`. You
-    # must use
-    # the new `customer_id` to update merged profiles.
-    # You cannot edit a customer's cards on file with this endpoint. To make
-    # changes
-    # to a card on file, you must delete the existing card on file with the
-    # [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a
-    # new one with the
-    # [CreateCustomerCard](#endpoint-createcustomercard) endpoint.
+    # 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.
+    # 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
+    # the [Cards API]($e/Cards) or [Gift Cards API]($e/GiftCards).
     # @param [String] customer_id Required parameter: The ID of the customer to
     # update.
     # @param [UpdateCustomerRequest] body Required parameter: An object
@@ -232,14 +267,14 @@ module Square
       _query_builder << '/v2/customers/{customer_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'customer_id' => customer_id
+        'customer_id' => { 'value' => customer_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -254,7 +289,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Adds a card on file to an existing customer.
@@ -270,19 +307,20 @@ module Square
     # @return [CreateCustomerCardResponse Hash] response from the API call
     def create_customer_card(customer_id:,
                              body:)
+      warn 'Endpoint create_customer_card in CustomersApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/customers/{customer_id}/cards'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'customer_id' => customer_id
+        'customer_id' => { 'value' => customer_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -297,7 +335,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Removes a card on file from a customer.
@@ -308,13 +348,14 @@ module Square
     # @return [DeleteCustomerCardResponse Hash] response from the API call
     def delete_customer_card(customer_id:,
                              card_id:)
+      warn 'Endpoint delete_customer_card in CustomersApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/customers/{customer_id}/cards/{card_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'customer_id' => customer_id,
-        'card_id' => card_id
+        'customer_id' => { 'value' => customer_id, 'encode' => true },
+        'card_id' => { 'value' => card_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -334,7 +375,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Removes a group membership from a customer.
@@ -352,8 +395,8 @@ module Square
       _query_builder << '/v2/customers/{customer_id}/groups/{group_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'customer_id' => customer_id,
-        'group_id' => group_id
+        'customer_id' => { 'value' => customer_id, 'encode' => true },
+        'group_id' => { 'value' => group_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -373,7 +416,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Adds a group membership to a customer.
@@ -391,8 +436,8 @@ module Square
       _query_builder << '/v2/customers/{customer_id}/groups/{group_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'customer_id' => customer_id,
-        'group_id' => group_id
+        'customer_id' => { 'value' => customer_id, 'encode' => true },
+        'group_id' => { 'value' => group_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -412,7 +457,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end

data/lib/square/api/devices_api.rb

@@ -9,17 +9,22 @@ module Square
     # @param [String] cursor Optional parameter: A pagination cursor returned by
     # a previous call to this endpoint. Provide this to retrieve the next set of
     # results for your original query.  See [Paginating
-    # results](#paginatingresults) for more information.
+    # results](https://developer.squareup.com/docs/working-with-apis/pagination)
+    # for more information.
     # @param [String] location_id Optional parameter: If specified, only returns
     # DeviceCodes of the specified location. Returns DeviceCodes of all
     # locations if empty.
     # @param [ProductType] product_type Optional parameter: If specified, only
     # returns DeviceCodes targeting the specified product type. Returns
     # DeviceCodes of all product types if empty.
+    # @param [DeviceCodeStatus] status Optional parameter: If specified, returns
+    # DeviceCodes with the specified statuses. Returns DeviceCodes of status
+    # `PAIRED` and `UNPAIRED` if empty.
     # @return [ListDeviceCodesResponse Hash] response from the API call
     def list_device_codes(cursor: nil,
                           location_id: nil,
-                          product_type: nil)
+                          product_type: nil,
+                          status: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/devices/codes'
@@ -27,7 +32,8 @@ module Square
         _query_builder,
         'cursor' => cursor,
         'location_id' => location_id,
-        'product_type' => product_type
+        'product_type' => product_type,
+        'status' => status
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -47,7 +53,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Creates a DeviceCode that can be used to login to a Square Terminal device
@@ -66,7 +74,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -81,7 +89,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Retrieves DeviceCode with the associated ID.
@@ -94,7 +104,7 @@ module Square
       _query_builder << '/v2/devices/codes/{id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'id' => id
+        'id' => { 'value' => id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -114,7 +124,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end