RubyGems - square.rb - Versions diffs - 26.0.0.20221214 → 26.2.0.20230315 - Mend

square.rb 26.0.0.20221214 → 26.2.0.20230315

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (71) hide show

checksums.yaml +4 -4
data/LICENSE +1 -1
data/lib/square/api/apple_pay_api.rb +14 -30
data/lib/square/api/bank_accounts_api.rb +40 -90
data/lib/square/api/base_api.rb +42 -42
data/lib/square/api/booking_custom_attributes_api.rb +164 -329
data/lib/square/api/bookings_api.rb +135 -260
data/lib/square/api/cards_api.rb +56 -118
data/lib/square/api/cash_drawers_api.rb +47 -103
data/lib/square/api/catalog_api.rb +197 -423
data/lib/square/api/checkout_api.rb +85 -175
data/lib/square/api/customer_custom_attributes_api.rb +150 -303
data/lib/square/api/customer_groups_api.rb +69 -145
data/lib/square/api/customer_segments_api.rb +26 -61
data/lib/square/api/customers_api.rb +147 -294
data/lib/square/api/devices_api.rb +42 -89
data/lib/square/api/disputes_api.rb +130 -288
data/lib/square/api/employees_api.rb +28 -63
data/lib/square/api/gift_card_activities_api.rb +33 -65
data/lib/square/api/gift_cards_api.rb +103 -202
data/lib/square/api/inventory_api.rb +179 -366
data/lib/square/api/invoices_api.rb +118 -237
data/lib/square/api/labor_api.rb +223 -459
data/lib/square/api/location_custom_attributes_api.rb +419 -0
data/lib/square/api/locations_api.rb +54 -112
data/lib/square/api/loyalty_api.rb +259 -512
data/lib/square/api/merchants_api.rb +25 -60
data/lib/square/api/mobile_authorization_api.rb +14 -30
data/lib/square/api/o_auth_api.rb +54 -109
data/lib/square/api/order_custom_attributes_api.rb +168 -333
data/lib/square/api/orders_api.rb +115 -222
data/lib/square/api/payments_api.rb +106 -208
data/lib/square/api/payouts_api.rb +47 -100
data/lib/square/api/refunds_api.rb +46 -93
data/lib/square/api/sites_api.rb +11 -28
data/lib/square/api/snippets_api.rb +42 -90
data/lib/square/api/subscriptions_api.rb +150 -299
data/lib/square/api/team_api.rb +114 -224
data/lib/square/api/terminal_api.rb +162 -328
data/lib/square/api/transactions_api.rb +62 -126
data/lib/square/api/v1_transactions_api.rb +155 -296
data/lib/square/api/vendors_api.rb +99 -192
data/lib/square/api/webhook_subscriptions_api.rb +115 -235
data/lib/square/api_helper.rb +1 -437
data/lib/square/client.rb +82 -46
data/lib/square/configuration.rb +28 -53
data/lib/square/exceptions/api_exception.rb +1 -11
data/lib/square/http/api_response.rb +13 -19
data/lib/square/http/auth/o_auth2.rb +14 -7
data/lib/square/http/http_call_back.rb +1 -15
data/lib/square/http/http_method_enum.rb +1 -4
data/lib/square/http/http_request.rb +1 -45
data/lib/square/http/http_response.rb +1 -20
data/lib/square/utilities/date_time_helper.rb +1 -146
data/lib/square/utilities/file_wrapper.rb +5 -5
data/lib/square.rb +7 -6
data/spec/user_journey_spec.rb +2 -2
data/test/api/api_test_base.rb +13 -5
data/test/api/test_catalog_api.rb +5 -4
data/test/api/test_customers_api.rb +3 -2
data/test/api/test_employees_api.rb +4 -3
data/test/api/test_labor_api.rb +6 -5
data/test/api/test_locations_api.rb +3 -2
data/test/api/test_merchants_api.rb +4 -3
data/test/api/test_payments_api.rb +4 -3
data/test/api/test_refunds_api.rb +4 -3
metadata +12 -111
data/lib/square/exceptions/validation_exception.rb +0 -13
data/lib/square/http/faraday_client.rb +0 -93
data/lib/square/http/http_client.rb +0 -118
data/test/test_helper.rb +0 -89

data/lib/square/api/loyalty_api.rb CHANGED Viewed

@@ -1,10 +1,6 @@
 module Square
   # LoyaltyApi
   class LoyaltyApi < BaseApi
-    def initialize(config, http_call_back: nil)
-      super(config, http_call_back: http_call_back)
-    end
     # Creates a loyalty account. To create a loyalty account, you must provide
     # the `program_id` and a `mapping` with the `phone_number` of the buyer.
     # @param [CreateLoyaltyAccountRequest] body Required parameter: An object
@@ -12,32 +8,20 @@ module Square
     # object definition for field details.
     # @return [CreateLoyaltyAccountResponse Hash] response from the API call
     def create_loyalty_account(body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/loyalty/accounts'
-      _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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/loyalty/accounts',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
     # Searches for loyalty accounts in a loyalty program.
@@ -50,32 +34,20 @@ module Square
     # object definition for field details.
     # @return [SearchLoyaltyAccountsResponse Hash] response from the API call
     def search_loyalty_accounts(body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/loyalty/accounts/search'
-      _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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/loyalty/accounts/search',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
     # Retrieves a loyalty account.
@@ -83,34 +55,19 @@ module Square
     # account]($m/LoyaltyAccount) to retrieve.
     # @return [RetrieveLoyaltyAccountResponse Hash] response from the API call
     def retrieve_loyalty_account(account_id:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/loyalty/accounts/{account_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'account_id' => { 'value' => account_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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/loyalty/accounts/{account_id}',
+                                     'default')
+                   .template_param(new_parameter(account_id, key: 'account_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
     # Adds points earned from a purchase to a [loyalty
@@ -146,36 +103,22 @@ module Square
     # @return [AccumulateLoyaltyPointsResponse Hash] response from the API call
     def accumulate_loyalty_points(account_id:,
                                   body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/loyalty/accounts/{account_id}/accumulate'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'account_id' => { 'value' => account_id, '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.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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/loyalty/accounts/{account_id}/accumulate',
+                                     'default')
+                   .template_param(new_parameter(account_id, key: 'account_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
     # Adds points to or subtracts points from a buyer's account.
@@ -191,36 +134,22 @@ module Square
     # @return [AdjustLoyaltyPointsResponse Hash] response from the API call
     def adjust_loyalty_points(account_id:,
                               body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/loyalty/accounts/{account_id}/adjust'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'account_id' => { 'value' => account_id, '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.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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/loyalty/accounts/{account_id}/adjust',
+                                     'default')
+                   .template_param(new_parameter(account_id, key: 'account_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
     # Searches for loyalty events.
@@ -236,32 +165,20 @@ module Square
     # object definition for field details.
     # @return [SearchLoyaltyEventsResponse Hash] response from the API call
     def search_loyalty_events(body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/loyalty/events/search'
-      _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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/loyalty/events/search',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
     # Returns a list of loyalty programs in the seller's account.
@@ -275,30 +192,17 @@ module Square
     # @return [ListLoyaltyProgramsResponse Hash] response from the API call
     def list_loyalty_programs
       warn 'Endpoint list_loyalty_programs in LoyaltyApi is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/loyalty/programs'
-      _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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/loyalty/programs',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
     # Retrieves the loyalty program in a seller's account, specified by the
@@ -313,34 +217,19 @@ module Square
     # single loyalty program that belongs to the seller.
     # @return [RetrieveLoyaltyProgramResponse Hash] response from the API call
     def retrieve_loyalty_program(program_id:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/loyalty/programs/{program_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'program_id' => { 'value' => program_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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/loyalty/programs/{program_id}',
+                                     'default')
+                   .template_param(new_parameter(program_id, key: 'program_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
     # Calculates the number of points a buyer can earn from a purchase.
@@ -376,36 +265,22 @@ module Square
     # @return [CalculateLoyaltyPointsResponse Hash] response from the API call
     def calculate_loyalty_points(program_id:,
                                  body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/loyalty/programs/{program_id}/calculate'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'program_id' => { 'value' => program_id, '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.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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/loyalty/programs/{program_id}/calculate',
+                                     'default')
+                   .template_param(new_parameter(program_id, key: 'program_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
     # Lists the loyalty promotions associated with a [loyalty
@@ -436,40 +311,22 @@ module Square
                                 status: nil,
                                 cursor: nil,
                                 limit: nil)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/loyalty/programs/{program_id}/promotions'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'program_id' => { 'value' => program_id, 'encode' => true }
-      )
-      _query_builder = APIHelper.append_url_with_query_parameters(
-        _query_builder,
-        'status' => status,
-        'cursor' => cursor,
-        'limit' => limit
-      )
-      _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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/loyalty/programs/{program_id}/promotions',
+                                     'default')
+                   .template_param(new_parameter(program_id, key: 'program_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(status, key: 'status'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
     # Creates a loyalty promotion for a [loyalty program]($m/LoyaltyProgram). A
@@ -492,36 +349,22 @@ module Square
     # @return [CreateLoyaltyPromotionResponse Hash] response from the API call
     def create_loyalty_promotion(program_id:,
                                  body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/loyalty/programs/{program_id}/promotions'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'program_id' => { 'value' => program_id, '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.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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/loyalty/programs/{program_id}/promotions',
+                                     'default')
+                   .template_param(new_parameter(program_id, key: 'program_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
     # Retrieves a loyalty promotion.
@@ -534,35 +377,21 @@ module Square
     # @return [RetrieveLoyaltyPromotionResponse Hash] response from the API call
     def retrieve_loyalty_promotion(promotion_id:,
                                    program_id:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/loyalty/programs/{program_id}/promotions/{promotion_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'promotion_id' => { 'value' => promotion_id, 'encode' => true },
-        'program_id' => { 'value' => program_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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/loyalty/programs/{program_id}/promotions/{promotion_id}',
+                                     'default')
+                   .template_param(new_parameter(promotion_id, key: 'promotion_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(program_id, key: 'program_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
     # Cancels a loyalty promotion. Use this endpoint to cancel an `ACTIVE`
@@ -581,35 +410,21 @@ module Square
     # @return [CancelLoyaltyPromotionResponse Hash] response from the API call
     def cancel_loyalty_promotion(promotion_id:,
                                  program_id:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/loyalty/programs/{program_id}/promotions/{promotion_id}/cancel'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'promotion_id' => { 'value' => promotion_id, 'encode' => true },
-        'program_id' => { 'value' => program_id, 'encode' => true }
-      )
-      _query_url = APIHelper.clean_url _query_builder
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json'
-      }
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.post(
-        _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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/loyalty/programs/{program_id}/promotions/{promotion_id}/cancel',
+                                     'default')
+                   .template_param(new_parameter(promotion_id, key: 'promotion_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(program_id, key: 'program_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
     # Creates a loyalty reward. In the process, the endpoint does following:
@@ -625,32 +440,20 @@ module Square
     # object definition for field details.
     # @return [CreateLoyaltyRewardResponse Hash] response from the API call
     def create_loyalty_reward(body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/loyalty/rewards'
-      _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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/loyalty/rewards',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
     # Searches for loyalty rewards. This endpoint accepts a request with no
@@ -665,32 +468,20 @@ module Square
     # object definition for field details.
     # @return [SearchLoyaltyRewardsResponse Hash] response from the API call
     def search_loyalty_rewards(body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/loyalty/rewards/search'
-      _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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/loyalty/rewards/search',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
     # Deletes a loyalty reward by doing the following:
@@ -704,34 +495,19 @@ module Square
     # reward]($m/LoyaltyReward) to delete.
     # @return [DeleteLoyaltyRewardResponse Hash] response from the API call
     def delete_loyalty_reward(reward_id:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/loyalty/rewards/{reward_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'reward_id' => { 'value' => reward_id, '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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/v2/loyalty/rewards/{reward_id}',
+                                     'default')
+                   .template_param(new_parameter(reward_id, key: 'reward_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
     # Retrieves a loyalty reward.
@@ -739,34 +515,19 @@ module Square
     # reward]($m/LoyaltyReward) to retrieve.
     # @return [RetrieveLoyaltyRewardResponse Hash] response from the API call
     def retrieve_loyalty_reward(reward_id:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/loyalty/rewards/{reward_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'reward_id' => { 'value' => reward_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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/loyalty/rewards/{reward_id}',
+                                     'default')
+                   .template_param(new_parameter(reward_id, key: 'reward_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
     # Redeems a loyalty reward.
@@ -785,36 +546,22 @@ module Square
     # @return [RedeemLoyaltyRewardResponse Hash] response from the API call
     def redeem_loyalty_reward(reward_id:,
                               body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/loyalty/rewards/{reward_id}/redeem'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'reward_id' => { 'value' => reward_id, '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.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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/loyalty/rewards/{reward_id}/redeem',
+                                     'default')
+                   .template_param(new_parameter(reward_id, key: 'reward_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
   end
 end