square.rb 6.0.0.20200625 → 6.5.0.20201028

data/lib/square/api/labor_api.rb

@@ -44,7 +44,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 `BreakType`.
@@ -88,7 +90,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 an existing `BreakType`.
@@ -102,7 +106,7 @@ module Square
       _query_builder << '/v2/labor/break-types/{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
 
@@ -122,7 +126,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 a single `BreakType` specified by id.
@@ -135,7 +141,7 @@ module Square
       _query_builder << '/v2/labor/break-types/{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
 
@@ -155,7 +161,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 an existing `BreakType`.
@@ -172,7 +180,7 @@ module Square
       _query_builder << '/v2/labor/break-types/{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
 
@@ -194,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 a paginated list of `EmployeeWage` instances for a business.
@@ -209,6 +219,7 @@ module Square
     def list_employee_wages(employee_id: nil,
                             limit: nil,
                             cursor: nil)
+      warn 'Endpoint list_employee_wages in LaborApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/labor/employee-wages'
@@ -236,7 +247,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 a single `EmployeeWage` specified by id.
@@ -244,12 +257,13 @@ module Square
     # retrieved.
     # @return [GetEmployeeWageResponse Hash] response from the API call
     def get_employee_wage(id:)
+      warn 'Endpoint get_employee_wage in LaborApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/labor/employee-wages/{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
 
@@ -269,7 +283,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 `Shift`.
@@ -317,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
 
     # Returns a paginated list of `Shift` records for a business.
@@ -361,7 +379,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 `Shift`.
@@ -374,7 +394,7 @@ module Square
       _query_builder << '/v2/labor/shifts/{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
 
@@ -394,7 +414,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 a single `Shift` specified by id.
@@ -407,7 +429,7 @@ module Square
       _query_builder << '/v2/labor/shifts/{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
 
@@ -427,7 +449,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 an existing `Shift`.
@@ -449,7 +473,7 @@ module Square
       _query_builder << '/v2/labor/shifts/{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
 
@@ -471,7 +495,88 @@ 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 a paginated list of `TeamMemberWage` instances for a business.
+    # @param [String] team_member_id Optional parameter: Filter wages returned
+    # to only those that are associated with the specified team member.
+    # @param [Integer] limit Optional parameter: Maximum number of Team Member
+    # Wages to return per page. Can range between 1 and 200. The default is the
+    # maximum at 200.
+    # @param [String] cursor Optional parameter: Pointer to the next page of
+    # Employee Wage results to fetch.
+    # @return [ListTeamMemberWagesResponse Hash] response from the API call
+    def list_team_member_wages(team_member_id: nil,
+                               limit: nil,
+                               cursor: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/labor/team-member-wages'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'team_member_id' => team_member_id,
+        '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
+
+    # Returns a single `TeamMemberWage` specified by id.
+    # @param [String] id Required parameter: UUID for the `TeamMemberWage` being
+    # retrieved.
+    # @return [GetTeamMemberWageResponse Hash] response from the API call
+    def get_team_member_wage(id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/labor/team-member-wages/{id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'id' => { 'value' => id, 'encode' => true }
+      )
+      _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
 
     # Returns a list of `WorkweekConfig` instances for a business.
@@ -508,7 +613,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 `WorkweekConfig`.
@@ -525,7 +632,7 @@ module Square
       _query_builder << '/v2/labor/workweek-configs/{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
 
@@ -547,7 +654,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/locations_api.rb

@@ -6,8 +6,7 @@ module Square
     end
 
     # Provides information of all locations of a business.
-    # Most other Connect API endpoints have a required `location_id` path
-    # parameter.
+    # Many Square API endpoints require a `location_id` parameter.
     # The `id` field of the [`Location`](#type-location) objects returned by
     # this
     # endpoint correspond to that `location_id` parameter.
@@ -34,12 +33,12 @@ 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 location.
-    # For more information about locations, see [Locations API
-    # Overview](https://developer.squareup.com/docs/locations-api).
     # @param [CreateLocationRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -68,12 +67,17 @@ 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 details of a location.
+    # Retrieves details of a location. You can specify "main"
+    # as the location ID to retrieve details of the
+    # main location.
     # @param [String] location_id Required parameter: The ID of the location to
-    # retrieve.
+    # retrieve. If you specify the string "main", then the endpoint returns the
+    # main location.
     # @return [RetrieveLocationResponse Hash] response from the API call
     def retrieve_location(location_id:)
       # Prepare query url.
@@ -81,7 +85,7 @@ module Square
       _query_builder << '/v2/locations/{location_id}'
       _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
 
@@ -101,7 +105,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 location.
@@ -118,7 +124,7 @@ module Square
       _query_builder << '/v2/locations/{location_id}'
       _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
 
@@ -140,7 +146,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/loyalty_api.rb

@@ -5,10 +5,7 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Creates a loyalty account. For more information, see
-    # [Create a loyalty
-    # account](https://developer.squareup.com/docs/docs/loyalty-api/overview/#lo
-    # yalty-overview-create-account).
+    # Creates a loyalty account.
     # @param [CreateLoyaltyAccountRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -37,13 +34,16 @@ 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 for loyalty accounts.
-    # In the current implementation, you can search for a loyalty account using
-    # the phone number associated with the account.
-    # If no phone number is provided, all loyalty accounts are returned.
+    # Searches for loyalty accounts in a loyalty program.
+    # You can search for a loyalty account using the phone number or customer ID
+    # associated with the account. To return all loyalty accounts, specify an
+    # empty `query` object or omit it entirely.
+    # Search results are sorted by `created_at` in ascending order.
     # @param [SearchLoyaltyAccountsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -72,7 +72,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 loyalty account.
@@ -85,7 +87,7 @@ module Square
       _query_builder << '/v2/loyalty/accounts/{account_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'account_id' => account_id
+        'account_id' => { 'value' => account_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -105,7 +107,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 points to a loyalty account.
@@ -116,13 +120,11 @@ module Square
     # - If you are not using the Orders API to manage orders,
     # you first perform a client-side computation to compute the points.
     # For spend-based and visit-based programs, you can call
-    # `CalculateLoyaltyPoints` to compute the points. For more information,
+    # [CalculateLoyaltyPoints](#endpoint-Loyalty-CalculateLoyaltyPoints) to
+    # compute the points. For more information,
     # see [Loyalty Program
     # Overview](https://developer.squareup.com/docs/docs/loyalty/overview).
     # You then provide the points in a request to this endpoint.
-    # For more information, see [Accumulate
-    # points](https://developer.squareup.com/docs/docs/loyalty-api/overview/#acc
-    # umulate-points).
     # @param [String] account_id Required parameter: The [loyalty
     # account](#type-LoyaltyAccount) ID to which to add the points.
     # @param [AccumulateLoyaltyPointsRequest] body Required parameter: An object
@@ -136,7 +138,7 @@ module Square
       _query_builder << '/v2/loyalty/accounts/{account_id}/accumulate'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'account_id' => account_id
+        'account_id' => { 'value' => account_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -158,14 +160,15 @@ 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 points to or subtracts points from a buyer's account.
     # Use this endpoint only when you need to manually adjust points. Otherwise,
     # in your application flow, you call
-    # [AccumulateLoyaltyPoints](https://developer.squareup.com/docs/reference/sq
-    # uare/loyalty-api/accumulate-loyalty-points)
+    # [AccumulateLoyaltyPoints](#endpoint-Loyalty-AccumulateLoyaltyPoints)
     # to add points when a buyer pays for the purchase.
     # @param [String] account_id Required parameter: The ID of the [loyalty
     # account](#type-LoyaltyAccount) in which to adjust the points.
@@ -180,7 +183,7 @@ module Square
       _query_builder << '/v2/loyalty/accounts/{account_id}/adjust'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'account_id' => account_id
+        'account_id' => { 'value' => account_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -202,7 +205,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
 
     # Searches for loyalty events.
@@ -212,10 +217,6 @@ module Square
     # (for example, points earned, points redeemed, and points expired) is
     # recorded in the ledger. Using this endpoint, you can search the ledger for
     # events.
-    # For more information, see
-    # [Loyalty
-    # events](https://developer.squareup.com/docs/docs/loyalty-api/overview/#loy
-    # alty-events).
     # @param [SearchLoyaltyEventsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -244,15 +245,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
 
     # Returns a list of loyalty programs in the seller's account.
-    # Currently, a seller can only have one loyalty program. For more
-    # information, see
-    # [Loyalty
-    # Overview](https://developer.squareup.com/docs/docs/loyalty/overview).
-    # .
+    # Currently, a seller can only have one loyalty program.
     # @return [ListLoyaltyProgramsResponse Hash] response from the API call
     def list_loyalty_programs
       # Prepare query url.
@@ -276,7 +275,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
 
     # Calculates the points a purchase earns.
@@ -303,7 +304,7 @@ module Square
       _query_builder << '/v2/loyalty/programs/{program_id}/calculate'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'program_id' => program_id
+        'program_id' => { 'value' => program_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -325,7 +326,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 loyalty reward. In the process, the endpoint does following:
@@ -336,10 +339,6 @@ module Square
     # discount to the order.
     # After a reward is created, the points are locked and
     # not available for the buyer to redeem another reward.
-    # For more information, see
-    # [Loyalty
-    # rewards](https://developer.squareup.com/docs/docs/loyalty-api/overview/#lo
-    # yalty-overview-loyalty-rewards).
     # @param [CreateLoyaltyRewardRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -368,19 +367,16 @@ 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 for loyalty rewards in a loyalty account.
     # In the current implementation, the endpoint supports search by the reward
     # `status`.
     # If you know a reward ID, use the
-    # [RetrieveLoyaltyReward](https://developer.squareup.com/docs/reference/squa
-    # re/loyalty-api/retrieve-loyalty-reward) endpoint.
-    # For more information about loyalty rewards, see
-    # [Loyalty
-    # Rewards](https://developer.squareup.com/docs/docs/loyalty-api/overview/#lo
-    # yalty-rewards).
+    # [RetrieveLoyaltyReward](#endpoint-Loyalty-RetrieveLoyaltyReward) endpoint.
     # @param [SearchLoyaltyRewardsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -409,22 +405,18 @@ 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 loyalty reward by doing the following:
     # - Returns the loyalty points back to the loyalty account.
     # - If an order ID was specified when the reward was created
-    # (see
-    # [CreateLoyaltyReward](https://developer.squareup.com/docs/reference/square
-    # /loyalty-api/create-loyalty-reward)),
+    # (see [CreateLoyaltyReward](#endpoint-Loyalty-CreateLoyaltyReward)),
     # it updates the order by removing the reward and related
     # discounts.
     # You cannot delete a reward that has reached the terminal state (REDEEMED).
-    # For more information, see
-    # [Loyalty
-    # rewards](https://developer.squareup.com/docs/docs/loyalty-api/overview/#lo
-    # yalty-overview-loyalty-rewards).
     # @param [String] reward_id Required parameter: The ID of the [loyalty
     # reward](#type-LoyaltyReward) to delete.
     # @return [DeleteLoyaltyRewardResponse Hash] response from the API call
@@ -434,7 +426,7 @@ module Square
       _query_builder << '/v2/loyalty/rewards/{reward_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'reward_id' => reward_id
+        'reward_id' => { 'value' => reward_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -454,7 +446,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 loyalty reward.
@@ -467,7 +461,7 @@ module Square
       _query_builder << '/v2/loyalty/rewards/{reward_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'reward_id' => reward_id
+        'reward_id' => { 'value' => reward_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -487,21 +481,19 @@ 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
 
     # Redeems a loyalty reward.
-    # The endpoint sets the reward to the terminal state (`REDEEMED`).
+    # The endpoint sets the reward to the `REDEEMED` terminal state.
     # If you are using your own order processing system (not using the
     # Orders API), you call this endpoint after the buyer paid for the
     # purchase.
     # After the reward reaches the terminal state, it cannot be deleted.
     # In other words, points used for the reward cannot be returned
     # to the account.
-    # For more information, see
-    # [Loyalty
-    # rewards](https://developer.squareup.com/docs/docs/loyalty-api/overview/#lo
-    # yalty-overview-loyalty-rewards).
     # @param [String] reward_id Required parameter: The ID of the [loyalty
     # reward](#type-LoyaltyReward) to redeem.
     # @param [RedeemLoyaltyRewardRequest] body Required parameter: An object
@@ -515,7 +507,7 @@ module Square
       _query_builder << '/v2/loyalty/rewards/{reward_id}/redeem'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'reward_id' => reward_id
+        'reward_id' => { 'value' => reward_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -537,7 +529,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