square.rb 44.1.0.20250924 → 45.0.1.20260122

data/lib/square/loyalty/accounts/client.rb

@@ -4,83 +4,118 @@ module Square
   module Loyalty
     module Accounts
       class Client
-        # @return [Square::Loyalty::Accounts::Client]
+        # @param client [Square::Internal::Http::RawClient]
+        #
+        # @return [void]
         def initialize(client:)
           @client = client
         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.
+        # 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 request_options [Hash]
+        # @param params [Square::Loyalty::Accounts::Types::CreateLoyaltyAccountRequest]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
         #
         # @return [Square::Types::CreateLoyaltyAccountResponse]
         def create(request_options: {}, **params)
-          _request = Square::Internal::JSON::Request.new(
-            base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          params = Square::Internal::Types::Utils.normalize_keys(params)
+          request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
             method: "POST",
             path: "v2/loyalty/accounts",
-            body: params
+            body: Square::Loyalty::Accounts::Types::CreateLoyaltyAccountRequest.new(params).to_h,
+            request_options: request_options
           )
           begin
-            _response = @client.send(_request)
+            response = @client.send(request)
           rescue Net::HTTPRequestTimeout
             raise Square::Errors::TimeoutError
           end
-          code = _response.code.to_i
+          code = response.code.to_i
           if code.between?(200, 299)
-            Square::Types::CreateLoyaltyAccountResponse.load(_response.body)
+            Square::Types::CreateLoyaltyAccountResponse.load(response.body)
           else
             error_class = Square::Errors::ResponseError.subclass_for_code(code)
-            raise error_class.new(_response.body, code: code)
+            raise error_class.new(response.body, code: code)
           end
         end
 
         # 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.
+        # 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 request_options [Hash]
+        # @param params [Square::Loyalty::Accounts::Types::SearchLoyaltyAccountsRequest]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        #
         # @return [Square::Types::SearchLoyaltyAccountsResponse]
         def search(request_options: {}, **params)
-          _request = Square::Internal::JSON::Request.new(
-            base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          params = Square::Internal::Types::Utils.normalize_keys(params)
+          request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
             method: "POST",
             path: "v2/loyalty/accounts/search",
-            body: params
+            body: Square::Loyalty::Accounts::Types::SearchLoyaltyAccountsRequest.new(params).to_h,
+            request_options: request_options
           )
           begin
-            _response = @client.send(_request)
+            response = @client.send(request)
           rescue Net::HTTPRequestTimeout
             raise Square::Errors::TimeoutError
           end
-          code = _response.code.to_i
+          code = response.code.to_i
           if code.between?(200, 299)
-            Square::Types::SearchLoyaltyAccountsResponse.load(_response.body)
+            Square::Types::SearchLoyaltyAccountsResponse.load(response.body)
           else
             error_class = Square::Errors::ResponseError.subclass_for_code(code)
-            raise error_class.new(_response.body, code: code)
+            raise error_class.new(response.body, code: code)
           end
         end
 
         # Retrieves a loyalty account.
         #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :account_id
+        #
         # @return [Square::Types::GetLoyaltyAccountResponse]
         def get(request_options: {}, **params)
-          _request = Square::Internal::JSON::Request.new(
-            base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          params = Square::Internal::Types::Utils.normalize_keys(params)
+          request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
             method: "GET",
-            path: "v2/loyalty/accounts/#{params[:account_id]}"
+            path: "v2/loyalty/accounts/#{params[:account_id]}",
+            request_options: request_options
           )
           begin
-            _response = @client.send(_request)
+            response = @client.send(request)
           rescue Net::HTTPRequestTimeout
             raise Square::Errors::TimeoutError
           end
-          code = _response.code.to_i
+          code = response.code.to_i
           if code.between?(200, 299)
-            Square::Types::GetLoyaltyAccountResponse.load(_response.body)
+            Square::Types::GetLoyaltyAccountResponse.load(response.body)
           else
             error_class = Square::Errors::ResponseError.subclass_for_code(code)
-            raise error_class.new(_response.body, code: code)
+            raise error_class.new(response.body, code: code)
           end
         end
 
@@ -91,35 +126,52 @@ module Square
         # [loyalty promotion](entity:LoyaltyPromotion). For purchases that qualify for multiple accrual
         # rules, Square computes points based on the accrual rule that grants the most points.
         # For purchases that qualify for multiple promotions, Square computes points based on the most
-        # recently created promotion. A purchase must first qualify for program points to be eligible for promotion points.
+        # recently created promotion. A purchase must first qualify for program points to be eligible for promotion
+        # points.
         #
         # - If you are not using the Orders API to manage orders, provide `points` with the number of points to add.
         # You must first perform a client-side computation of the points earned from the loyalty program and
-        # loyalty promotion. For spend-based and visit-based programs, you can call [CalculateLoyaltyPoints](api-endpoint:Loyalty-CalculateLoyaltyPoints)
-        # to compute the points earned from the base loyalty program. For information about computing points earned from a loyalty promotion, see
-        # [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).
+        # loyalty promotion. For spend-based and visit-based programs, you can call
+        # [CalculateLoyaltyPoints](api-endpoint:Loyalty-CalculateLoyaltyPoints)
+        # to compute the points earned from the base loyalty program. For information about computing points earned from
+        # a loyalty promotion, see
+        # [Calculating promotion
+        # points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).
+        #
+        # @param request_options [Hash]
+        # @param params [Square::Loyalty::Accounts::Types::AccumulateLoyaltyPointsRequest]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :account_id
         #
         # @return [Square::Types::AccumulateLoyaltyPointsResponse]
         def accumulate_points(request_options: {}, **params)
-          _path_param_names = ["account_id"]
+          params = Square::Internal::Types::Utils.normalize_keys(params)
+          request_data = Square::Loyalty::Accounts::Types::AccumulateLoyaltyPointsRequest.new(params).to_h
+          non_body_param_names = ["account_id"]
+          body = request_data.except(*non_body_param_names)
 
-          _request = Square::Internal::JSON::Request.new(
-            base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
             method: "POST",
             path: "v2/loyalty/accounts/#{params[:account_id]}/accumulate",
-            body: params.except(*_path_param_names)
+            body: body,
+            request_options: request_options
           )
           begin
-            _response = @client.send(_request)
+            response = @client.send(request)
           rescue Net::HTTPRequestTimeout
             raise Square::Errors::TimeoutError
           end
-          code = _response.code.to_i
+          code = response.code.to_i
           if code.between?(200, 299)
-            Square::Types::AccumulateLoyaltyPointsResponse.load(_response.body)
+            Square::Types::AccumulateLoyaltyPointsResponse.load(response.body)
           else
             error_class = Square::Errors::ResponseError.subclass_for_code(code)
-            raise error_class.new(_response.body, code: code)
+            raise error_class.new(response.body, code: code)
           end
         end
 
@@ -129,27 +181,40 @@ module Square
         # [AccumulateLoyaltyPoints](api-endpoint:Loyalty-AccumulateLoyaltyPoints)
         # to add points when a buyer pays for the purchase.
         #
+        # @param request_options [Hash]
+        # @param params [Square::Loyalty::Accounts::Types::AdjustLoyaltyPointsRequest]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :account_id
+        #
         # @return [Square::Types::AdjustLoyaltyPointsResponse]
         def adjust(request_options: {}, **params)
-          _path_param_names = ["account_id"]
+          params = Square::Internal::Types::Utils.normalize_keys(params)
+          request_data = Square::Loyalty::Accounts::Types::AdjustLoyaltyPointsRequest.new(params).to_h
+          non_body_param_names = ["account_id"]
+          body = request_data.except(*non_body_param_names)
 
-          _request = Square::Internal::JSON::Request.new(
-            base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
             method: "POST",
             path: "v2/loyalty/accounts/#{params[:account_id]}/adjust",
-            body: params.except(*_path_param_names)
+            body: body,
+            request_options: request_options
           )
           begin
-            _response = @client.send(_request)
+            response = @client.send(request)
           rescue Net::HTTPRequestTimeout
             raise Square::Errors::TimeoutError
           end
-          code = _response.code.to_i
+          code = response.code.to_i
           if code.between?(200, 299)
-            Square::Types::AdjustLoyaltyPointsResponse.load(_response.body)
+            Square::Types::AdjustLoyaltyPointsResponse.load(response.body)
           else
             error_class = Square::Errors::ResponseError.subclass_for_code(code)
-            raise error_class.new(_response.body, code: code)
+            raise error_class.new(response.body, code: code)
           end
         end
       end

data/lib/square/loyalty/accounts/types/search_loyalty_accounts_request.rb

@@ -5,9 +5,7 @@ module Square
     module Accounts
       module Types
         class SearchLoyaltyAccountsRequest < Internal::Types::Model
-          field :query, lambda {
-            Square::Types::SearchLoyaltyAccountsRequestLoyaltyAccountQuery
-          }, optional: true, nullable: false
+          field :query, -> { Square::Types::SearchLoyaltyAccountsRequestLoyaltyAccountQuery }, optional: true, nullable: false
           field :limit, -> { Integer }, optional: true, nullable: false
           field :cursor, -> { String }, optional: true, nullable: false
         end

data/lib/square/loyalty/client.rb

@@ -3,7 +3,9 @@
 module Square
   module Loyalty
     class Client
-      # @return [Square::Loyalty::Client]
+      # @param client [Square::Internal::Http::RawClient]
+      #
+      # @return [void]
       def initialize(client:)
         @client = client
       end
@@ -17,25 +19,35 @@ module Square
       #
       # Search results are sorted by `created_at` in descending order.
       #
+      # @param request_options [Hash]
+      # @param params [Square::Loyalty::Types::SearchLoyaltyEventsRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
       # @return [Square::Types::SearchLoyaltyEventsResponse]
       def search_events(request_options: {}, **params)
-        _request = Square::Internal::JSON::Request.new(
-          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+        params = Square::Internal::Types::Utils.normalize_keys(params)
+        request = Square::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
           method: "POST",
           path: "v2/loyalty/events/search",
-          body: params
+          body: Square::Loyalty::Types::SearchLoyaltyEventsRequest.new(params).to_h,
+          request_options: request_options
         )
         begin
-          _response = @client.send(_request)
+          response = @client.send(request)
         rescue Net::HTTPRequestTimeout
           raise Square::Errors::TimeoutError
         end
-        code = _response.code.to_i
+        code = response.code.to_i
         if code.between?(200, 299)
-          Square::Types::SearchLoyaltyEventsResponse.load(_response.body)
+          Square::Types::SearchLoyaltyEventsResponse.load(response.body)
         else
           error_class = Square::Errors::ResponseError.subclass_for_code(code)
-          raise error_class.new(_response.body, code: code)
+          raise error_class.new(response.body, code: code)
         end
       end
 

data/lib/square/loyalty/programs/client.rb

@@ -4,67 +4,96 @@ module Square
   module Loyalty
     module Programs
       class Client
-        # @return [Square::Loyalty::Programs::Client]
+        # @param client [Square::Internal::Http::RawClient]
+        #
+        # @return [void]
         def initialize(client:)
           @client = client
         end
 
         # Returns a list of loyalty programs in the seller's account.
-        # Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).
+        # Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only
+        # one loyalty program, which is created and managed from the Seller Dashboard. For more information, see
+        # [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).
+        #
         #
+        # Replaced with [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) when used with the keyword
+        # `main`.
         #
-        # Replaced with [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) when used with the keyword `main`.
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
         #
         # @return [Square::Types::ListLoyaltyProgramsResponse]
-        def list(request_options: {}, **_params)
-          _request = Square::Internal::JSON::Request.new(
-            base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+        def list(request_options: {}, **params)
+          Square::Internal::Types::Utils.normalize_keys(params)
+          request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
             method: "GET",
-            path: "v2/loyalty/programs"
+            path: "v2/loyalty/programs",
+            request_options: request_options
           )
           begin
-            _response = @client.send(_request)
+            response = @client.send(request)
           rescue Net::HTTPRequestTimeout
             raise Square::Errors::TimeoutError
           end
-          code = _response.code.to_i
+          code = response.code.to_i
           if code.between?(200, 299)
-            Square::Types::ListLoyaltyProgramsResponse.load(_response.body)
+            Square::Types::ListLoyaltyProgramsResponse.load(response.body)
           else
             error_class = Square::Errors::ResponseError.subclass_for_code(code)
-            raise error_class.new(_response.body, code: code)
+            raise error_class.new(response.body, code: code)
           end
         end
 
         # Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword `main`.
         #
-        # Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).
+        # Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only
+        # one loyalty program, which is created and managed from the Seller Dashboard. For more information, see
+        # [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :program_id
         #
         # @return [Square::Types::GetLoyaltyProgramResponse]
         def get(request_options: {}, **params)
-          _request = Square::Internal::JSON::Request.new(
-            base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          params = Square::Internal::Types::Utils.normalize_keys(params)
+          request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
             method: "GET",
-            path: "v2/loyalty/programs/#{params[:program_id]}"
+            path: "v2/loyalty/programs/#{params[:program_id]}",
+            request_options: request_options
           )
           begin
-            _response = @client.send(_request)
+            response = @client.send(request)
           rescue Net::HTTPRequestTimeout
             raise Square::Errors::TimeoutError
           end
-          code = _response.code.to_i
+          code = response.code.to_i
           if code.between?(200, 299)
-            Square::Types::GetLoyaltyProgramResponse.load(_response.body)
+            Square::Types::GetLoyaltyProgramResponse.load(response.body)
           else
             error_class = Square::Errors::ResponseError.subclass_for_code(code)
-            raise error_class.new(_response.body, code: code)
+            raise error_class.new(response.body, code: code)
           end
         end
 
         # Calculates the number of points a buyer can earn from a purchase. Applications might call this endpoint
         # to display the points to the buyer.
         #
-        # - If you are using the Orders API to manage orders, provide the `order_id` and (optional) `loyalty_account_id`.
+        # - If you are using the Orders API to manage orders, provide the `order_id` and (optional)
+        # `loyalty_account_id`.
         # Square reads the order to compute the points earned from the base loyalty program and an associated
         # [loyalty promotion](entity:LoyaltyPromotion).
         #
@@ -75,29 +104,43 @@ module Square
         # If the purchase qualifies for program points, call
         # [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions) and perform a client-side computation
         # to calculate whether the purchase also qualifies for promotion points. For more information, see
-        # [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).
+        # [Calculating promotion
+        # points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).
+        #
+        # @param request_options [Hash]
+        # @param params [Square::Loyalty::Programs::Types::CalculateLoyaltyPointsRequest]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :program_id
         #
         # @return [Square::Types::CalculateLoyaltyPointsResponse]
         def calculate(request_options: {}, **params)
-          _path_param_names = ["program_id"]
+          params = Square::Internal::Types::Utils.normalize_keys(params)
+          request_data = Square::Loyalty::Programs::Types::CalculateLoyaltyPointsRequest.new(params).to_h
+          non_body_param_names = ["program_id"]
+          body = request_data.except(*non_body_param_names)
 
-          _request = Square::Internal::JSON::Request.new(
-            base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
+          request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
             method: "POST",
             path: "v2/loyalty/programs/#{params[:program_id]}/calculate",
-            body: params.except(*_path_param_names)
+            body: body,
+            request_options: request_options
           )
           begin
-            _response = @client.send(_request)
+            response = @client.send(request)
           rescue Net::HTTPRequestTimeout
             raise Square::Errors::TimeoutError
           end
-          code = _response.code.to_i
+          code = response.code.to_i
           if code.between?(200, 299)
-            Square::Types::CalculateLoyaltyPointsResponse.load(_response.body)
+            Square::Types::CalculateLoyaltyPointsResponse.load(response.body)
           else
             error_class = Square::Errors::ResponseError.subclass_for_code(code)
-            raise error_class.new(_response.body, code: code)
+            raise error_class.new(response.body, code: code)
           end
         end