square.rb 6.3.0.20200826 → 17.1.0.20220120

data/lib/square/api/transactions_api.rb

@@ -5,95 +5,33 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Lists refunds for one of a business's locations.
-    # In addition to full or partial tender refunds processed through Square
-    # APIs,
-    # refunds may result from itemized returns or exchanges through Square's
-    # Point of Sale applications.
-    # Refunds with a `status` of `PENDING` are not currently included in this
-    # endpoint's response.
-    # Max results per [page](#paginatingresults): 50
-    # @param [String] location_id Required parameter: The ID of the location to
-    # list refunds for.
-    # @param [String] begin_time Optional parameter: The beginning of the
-    # requested reporting period, in RFC 3339 format.  See [Date
-    # ranges](#dateranges) for details on date inclusivity/exclusivity.  Default
-    # value: The current time minus one year.
-    # @param [String] end_time Optional parameter: The end of the requested
-    # reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for
-    # details on date inclusivity/exclusivity.  Default value: The current
-    # time.
-    # @param [SortOrder] sort_order Optional parameter: The order in which
-    # results are listed in the response (`ASC` for oldest first, `DESC` for
-    # newest first).  Default value: `DESC`
-    # @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.
-    # @return [ListRefundsResponse Hash] response from the API call
-    def list_refunds(location_id:,
-                     begin_time: nil,
-                     end_time: nil,
-                     sort_order: nil,
-                     cursor: nil)
-      warn 'Endpoint list_refunds in TransactionsApi is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/refunds'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => location_id
-      )
-      _query_builder = APIHelper.append_url_with_query_parameters(
-        _query_builder,
-        'begin_time' => begin_time,
-        'end_time' => end_time,
-        'sort_order' => sort_order,
-        '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
-
     # Lists transactions for a particular location.
     # Transactions include payment information from sales and exchanges and
     # refund
     # information from returns and exchanges.
-    # Max results per [page](#paginatingresults): 50
+    # Max results per
+    # [page](https://developer.squareup.com/docs/working-with-apis/pagination):
+    # 50
     # @param [String] location_id Required parameter: The ID of the location to
     # list transactions for.
     # @param [String] begin_time Optional parameter: The beginning of the
     # requested reporting period, in RFC 3339 format.  See [Date
-    # ranges](#dateranges) for details on date inclusivity/exclusivity.  Default
-    # value: The current time minus one year.
+    # ranges](https://developer.squareup.com/docs/build-basics/working-with-date
+    # s) for details on date inclusivity/exclusivity.  Default value: The
+    # current time minus one year.
     # @param [String] end_time Optional parameter: The end of the requested
-    # reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for
-    # details on date inclusivity/exclusivity.  Default value: The current
-    # time.
+    # reporting period, in RFC 3339 format.  See [Date
+    # ranges](https://developer.squareup.com/docs/build-basics/working-with-date
+    # s) for details on date inclusivity/exclusivity.  Default value: The
+    # current time.
     # @param [SortOrder] sort_order Optional parameter: The order in which
     # results are listed in the response (`ASC` for oldest first, `DESC` for
     # newest first).  Default value: `DESC`
     # @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.
     # @return [ListTransactionsResponse Hash] response from the API call
     def list_transactions(location_id:,
                           begin_time: nil,
@@ -106,7 +44,7 @@ module Square
       _query_builder << '/v2/locations/{location_id}/transactions'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -133,65 +71,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)
-    end
-
-    # Charges a card represented by a card nonce or a customer's card on file.
-    # Your request to this endpoint must include _either_:
-    # - A value for the `card_nonce` parameter (to charge a card nonce generated
-    # with the `SqPaymentForm`)
-    # - Values for the `customer_card_id` and `customer_id` parameters (to
-    # charge
-    # a customer's card on file)
-    # In order for an eCommerce payment to potentially qualify for
-    # [Square chargeback protection](https://squareup.com/help/article/5394),
-    # you
-    # _must_ provide values for the following parameters in your request:
-    # - `buyer_email_address`
-    # - At least one of `billing_address` or `shipping_address`
-    # When this response is returned, the amount of Square's processing fee
-    # might not yet be
-    # calculated. To obtain the processing fee, wait about ten seconds and call
-    # [RetrieveTransaction](#endpoint-retrievetransaction). See the
-    # `processing_fee_money`
-    # field of each [Tender included](#type-tender) in the transaction.
-    # @param [String] location_id Required parameter: The ID of the location to
-    # associate the created transaction with.
-    # @param [ChargeRequest] body Required parameter: An object containing the
-    # fields to POST for the request.  See the corresponding object definition
-    # for field details.
-    # @return [ChargeResponse Hash] response from the API call
-    def charge(location_id:,
-               body:)
-      warn 'Endpoint charge in TransactionsApi is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/transactions'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => location_id
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
       )
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
-      }
-
-      # 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
 
     # Retrieves details for a single transaction.
@@ -208,8 +90,8 @@ module Square
       _query_builder << '/v2/locations/{location_id}/transactions/{transaction_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'transaction_id' => transaction_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'transaction_id' => { 'value' => transaction_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -229,11 +111,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
 
     # Captures a transaction that was created with the
-    # [Charge](#endpoint-charge)
+    # [Charge]($e/Transactions/Charge)
     # endpoint with a `delay_capture` value of `true`.
     # See [Delayed capture
     # transactions](https://developer.squareup.com/docs/payments/transactions/ov
@@ -250,8 +134,8 @@ module Square
       _query_builder << '/v2/locations/{location_id}/transactions/{transaction_id}/capture'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'transaction_id' => transaction_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'transaction_id' => { 'value' => transaction_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -271,61 +155,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)
-    end
-
-    # Initiates a refund for a previously charged tender.
-    # You must issue a refund within 120 days of the associated payment. See
-    # [this article](https://squareup.com/help/us/en/article/5060) for more
-    # information
-    # on refund behavior.
-    # NOTE: Card-present transactions with Interac credit cards **cannot be
-    # refunded using the Connect API**. Interac transactions must refunded
-    # in-person (e.g., dipping the card using POS app).
-    # @param [String] location_id Required parameter: The ID of the original
-    # transaction's associated location.
-    # @param [String] transaction_id Required parameter: The ID of the original
-    # transaction that includes the tender to refund.
-    # @param [CreateRefundRequest] body Required parameter: An object containing
-    # the fields to POST for the request.  See the corresponding object
-    # definition for field details.
-    # @return [CreateRefundResponse Hash] response from the API call
-    def create_refund(location_id:,
-                      transaction_id:,
-                      body:)
-      warn 'Endpoint create_refund in TransactionsApi is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/transactions/{transaction_id}/refund'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => location_id,
-        'transaction_id' => transaction_id
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
       )
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
-      }
-
-      # 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
 
-    # Cancels a transaction that was created with the [Charge](#endpoint-charge)
+    # Cancels a transaction that was created with the
+    # [Charge]($e/Transactions/Charge)
     # endpoint with a `delay_capture` value of `true`.
     # See [Delayed capture
     # transactions](https://developer.squareup.com/docs/payments/transactions/ov
@@ -342,8 +178,8 @@ module Square
       _query_builder << '/v2/locations/{location_id}/transactions/{transaction_id}/void'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'transaction_id' => transaction_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'transaction_id' => { 'value' => transaction_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -363,7 +199,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/v1_transactions_api.rb

@@ -5,87 +5,10 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Provides non-confidential details for all of a location's associated bank
-    # accounts. This endpoint does not provide full bank account numbers, and
-    # there is no way to obtain a full bank account number with the Connect API.
-    # @param [String] location_id Required parameter: The ID of the location to
-    # list bank accounts for.
-    # @return [List of V1BankAccount Hash] response from the API call
-    def list_bank_accounts(location_id:)
-      warn 'Endpoint list_bank_accounts in V1TransactionsApi is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v1/{location_id}/bank-accounts'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => location_id
-      )
-      _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
-
-    # Provides non-confidential details for a merchant's associated bank
-    # account. This endpoint does not provide full bank account numbers, and
-    # there is no way to obtain a full bank account number with the Connect API.
-    # @param [String] location_id Required parameter: The ID of the bank
-    # account's associated location.
-    # @param [String] bank_account_id Required parameter: The bank account's
-    # Square-issued ID. You obtain this value from Settlement objects
-    # returned.
-    # @return [V1BankAccount Hash] response from the API call
-    def retrieve_bank_account(location_id:,
-                              bank_account_id:)
-      warn 'Endpoint retrieve_bank_account in V1TransactionsApi is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v1/{location_id}/bank-accounts/{bank_account_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => location_id,
-        'bank_account_id' => bank_account_id
-      )
-      _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
-
     # Provides summary information for a merchant's online store orders.
     # @param [String] location_id Required parameter: The ID of the location to
     # list online store orders for.
-    # @param [SortOrder] order Optional parameter: TThe order in which payments
+    # @param [SortOrder] order Optional parameter: The order in which payments
     # are listed in the response.
     # @param [Integer] limit Optional parameter: The maximum number of payments
     # to return in a single response. This value cannot exceed 200.
@@ -97,12 +20,13 @@ module Square
                     order: nil,
                     limit: nil,
                     batch_token: nil)
+      warn 'Endpoint list_orders in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/orders'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -128,7 +52,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
 
     # Provides comprehensive information for a single online store order,
@@ -141,13 +67,14 @@ module Square
     # @return [V1Order Hash] response from the API call
     def retrieve_order(location_id:,
                        order_id:)
+      warn 'Endpoint retrieve_order in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/orders/{order_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'order_id' => order_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'order_id' => { 'value' => order_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -167,7 +94,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 the details of an online store order. Every update you perform on
@@ -184,20 +113,21 @@ module Square
     def update_order(location_id:,
                      order_id:,
                      body:)
+      warn 'Endpoint update_order in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/orders/{order_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'order_id' => order_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'order_id' => { 'value' => order_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.
@@ -212,7 +142,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
 
     # Provides summary information for all payments taken for a given
@@ -255,12 +187,13 @@ module Square
                       limit: nil,
                       batch_token: nil,
                       include_partial: false)
+      warn 'Endpoint list_payments in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/payments'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -289,7 +222,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
 
     # Provides comprehensive information for a single payment.
@@ -302,13 +237,14 @@ module Square
     # @return [V1Payment Hash] response from the API call
     def retrieve_payment(location_id:,
                          payment_id:)
+      warn 'Endpoint retrieve_payment in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/payments/{payment_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'payment_id' => payment_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'payment_id' => { 'value' => payment_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -328,7 +264,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
 
     # Provides the details for all refunds initiated by a merchant or any of the
@@ -336,7 +274,7 @@ module Square
     # year in length.
     # @param [String] location_id Required parameter: The ID of the location to
     # list refunds for.
-    # @param [SortOrder] order Optional parameter: TThe order in which payments
+    # @param [SortOrder] order Optional parameter: The order in which payments
     # are listed in the response.
     # @param [String] begin_time Optional parameter: The beginning of the
     # requested reporting period, in ISO 8601 format. If this value is before
@@ -361,12 +299,13 @@ module Square
                      end_time: nil,
                      limit: nil,
                      batch_token: nil)
+      warn 'Endpoint list_refunds in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/refunds'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -394,7 +333,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
 
     # Issues a refund for a previously processed payment. You must issue
@@ -415,19 +356,20 @@ module Square
     # @return [V1Refund Hash] response from the API call
     def create_refund(location_id:,
                       body:)
+      warn 'Endpoint create_refund in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/refunds'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_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.
@@ -442,7 +384,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
 
     # Provides summary information for all deposits and withdrawals
@@ -480,12 +424,13 @@ module Square
                          limit: nil,
                          status: nil,
                          batch_token: nil)
+      warn 'Endpoint list_settlements in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/settlements'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -514,7 +459,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
 
     # Provides comprehensive information for a single settlement.
@@ -540,13 +487,14 @@ module Square
     # @return [V1Settlement Hash] response from the API call
     def retrieve_settlement(location_id:,
                             settlement_id:)
+      warn 'Endpoint retrieve_settlement in V1TransactionsApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v1/{location_id}/settlements/{settlement_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'settlement_id' => settlement_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'settlement_id' => { 'value' => settlement_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -566,7 +514,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