square.rb 44.2.0.20251016 → 45.0.1.20260122

data/lib/square/cards/client.rb

@@ -3,7 +3,9 @@
 module Square
   module Cards
     class Client
-      # @return [Square::Cards::Client]
+      # @param client [Square::Internal::Http::RawClient]
+      #
+      # @return [void]
       def initialize(client:)
         @client = client
       end
@@ -11,103 +13,159 @@ module Square
       # Retrieves a list of cards owned by the account making the request.
       # A max of 25 cards will be returned.
       #
+      # @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, nil] :cursor
+      # @option params [String, nil] :customer_id
+      # @option params [Boolean, nil] :include_disabled
+      # @option params [String, nil] :reference_id
+      # @option params [Square::Types::SortOrder, nil] :sort_order
+      #
       # @return [Square::Types::ListCardsResponse]
       def list(request_options: {}, **params)
-        _query_param_names = [
-          %w[cursor customer_id include_disabled reference_id sort_order],
-          %i[cursor customer_id include_disabled reference_id sort_order]
-        ].flatten
-        _query = params.slice(*_query_param_names)
-        params.except(*_query_param_names)
+        params = Square::Internal::Types::Utils.normalize_keys(params)
+        query_param_names = %i[cursor customer_id include_disabled reference_id sort_order]
+        query_params = {}
+        query_params["cursor"] = params[:cursor] if params.key?(:cursor)
+        query_params["customer_id"] = params[:customer_id] if params.key?(:customer_id)
+        query_params["include_disabled"] = params[:include_disabled] if params.key?(:include_disabled)
+        query_params["reference_id"] = params[:reference_id] if params.key?(:reference_id)
+        query_params["sort_order"] = params[:sort_order] if params.key?(:sort_order)
+        params.except(*query_param_names)
 
-        _request = Square::Internal::JSON::Request.new(
-          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
-          method: "GET",
-          path: "v2/cards",
-          query: _query
-        )
-        begin
-          _response = @client.send(_request)
-        rescue Net::HTTPRequestTimeout
-          raise Square::Errors::TimeoutError
-        end
-        code = _response.code.to_i
-        if code.between?(200, 299)
-          Square::Types::ListCardsResponse.load(_response.body)
-        else
-          error_class = Square::Errors::ResponseError.subclass_for_code(code)
-          raise error_class.new(_response.body, code: code)
+        Square::Internal::CursorItemIterator.new(
+          cursor_field: :cursor,
+          item_field: :cards,
+          initial_cursor: query_params[:cursor]
+        ) do |next_cursor|
+          query_params[:cursor] = next_cursor
+          request = Square::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v2/cards",
+            query: query_params,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Square::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Square::Types::ListCardsResponse.load(response.body)
+          else
+            error_class = Square::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
         end
       end
 
       # Adds a card on file to an existing merchant.
       #
+      # @param request_options [Hash]
+      # @param params [Square::Cards::Types::CreateCardRequest]
+      # @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::CreateCardResponse]
       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/cards",
-          body: params
+          body: Square::Cards::Types::CreateCardRequest.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::CreateCardResponse.load(_response.body)
+          Square::Types::CreateCardResponse.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 details for a specific Card.
       #
+      # @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] :card_id
+      #
       # @return [Square::Types::GetCardResponse]
       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/cards/#{params[:card_id]}"
+          path: "v2/cards/#{params[:card_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::GetCardResponse.load(_response.body)
+          Square::Types::GetCardResponse.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
 
       # Disables the card, preventing any further updates or charges.
       # Disabling an already disabled card is allowed but has no effect.
       #
+      # @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] :card_id
+      #
       # @return [Square::Types::DisableCardResponse]
       def disable(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/cards/#{params[:card_id]}/disable"
+          path: "v2/cards/#{params[:card_id]}/disable",
+          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::DisableCardResponse.load(_response.body)
+          Square::Types::DisableCardResponse.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/cash_drawers/client.rb

@@ -3,7 +3,9 @@
 module Square
   module CashDrawers
     class Client
-      # @return [Square::CashDrawers::Client]
+      # @param client [Square::Internal::Http::RawClient]
+      #
+      # @return [void]
       def initialize(client:)
         @client = client
       end

data/lib/square/cash_drawers/shifts/client.rb

@@ -4,7 +4,9 @@ module Square
   module CashDrawers
     module Shifts
       class Client
-        # @return [Square::CashDrawers::Shifts::Client]
+        # @param client [Square::Internal::Http::RawClient]
+        #
+        # @return [void]
         def initialize(client:)
           @client = client
         end
@@ -12,95 +14,153 @@ module Square
         # Provides the details for all of the cash drawer shifts for a location
         # in a date range.
         #
+        # @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] :location_id
+        # @option params [Square::Types::SortOrder, nil] :sort_order
+        # @option params [String, nil] :begin_time
+        # @option params [String, nil] :end_time
+        # @option params [Integer, nil] :limit
+        # @option params [String, nil] :cursor
+        #
         # @return [Square::Types::ListCashDrawerShiftsResponse]
         def list(request_options: {}, **params)
-          _query_param_names = [
-            %w[location_id sort_order begin_time end_time limit cursor],
-            %i[location_id sort_order begin_time end_time limit cursor]
-          ].flatten
-          _query = params.slice(*_query_param_names)
-          params.except(*_query_param_names)
+          params = Square::Internal::Types::Utils.normalize_keys(params)
+          query_param_names = %i[location_id sort_order begin_time end_time limit cursor]
+          query_params = {}
+          query_params["location_id"] = params[:location_id] if params.key?(:location_id)
+          query_params["sort_order"] = params[:sort_order] if params.key?(:sort_order)
+          query_params["begin_time"] = params[:begin_time] if params.key?(:begin_time)
+          query_params["end_time"] = params[:end_time] if params.key?(:end_time)
+          query_params["limit"] = params[:limit] if params.key?(:limit)
+          query_params["cursor"] = params[:cursor] if params.key?(:cursor)
+          params.except(*query_param_names)
 
-          _request = Square::Internal::JSON::Request.new(
-            base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
-            method: "GET",
-            path: "v2/cash-drawers/shifts",
-            query: _query
-          )
-          begin
-            _response = @client.send(_request)
-          rescue Net::HTTPRequestTimeout
-            raise Square::Errors::TimeoutError
-          end
-          code = _response.code.to_i
-          if code.between?(200, 299)
-            Square::Types::ListCashDrawerShiftsResponse.load(_response.body)
-          else
-            error_class = Square::Errors::ResponseError.subclass_for_code(code)
-            raise error_class.new(_response.body, code: code)
+          Square::Internal::CursorItemIterator.new(
+            cursor_field: :cursor,
+            item_field: :cash_drawer_shifts,
+            initial_cursor: query_params[:cursor]
+          ) do |next_cursor|
+            query_params[:cursor] = next_cursor
+            request = Square::Internal::JSON::Request.new(
+              base_url: request_options[:base_url],
+              method: "GET",
+              path: "v2/cash-drawers/shifts",
+              query: query_params,
+              request_options: request_options
+            )
+            begin
+              response = @client.send(request)
+            rescue Net::HTTPRequestTimeout
+              raise Square::Errors::TimeoutError
+            end
+            code = response.code.to_i
+            if code.between?(200, 299)
+              Square::Types::ListCashDrawerShiftsResponse.load(response.body)
+            else
+              error_class = Square::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(response.body, code: code)
+            end
           end
         end
 
         # Provides the summary details for a single cash drawer shift. See
-        # [ListCashDrawerShiftEvents](api-endpoint:CashDrawers-ListCashDrawerShiftEvents) for a list of cash drawer shift events.
+        # [ListCashDrawerShiftEvents](api-endpoint:CashDrawers-ListCashDrawerShiftEvents) for a list of cash drawer
+        # shift events.
+        #
+        # @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] :shift_id
+        # @option params [String] :location_id
         #
         # @return [Square::Types::GetCashDrawerShiftResponse]
         def get(request_options: {}, **params)
-          _query_param_names = [
-            ["location_id"],
-            %i[location_id]
-          ].flatten
-          _query = params.slice(*_query_param_names)
-          params = params.except(*_query_param_names)
+          params = Square::Internal::Types::Utils.normalize_keys(params)
+          query_param_names = %i[location_id]
+          query_params = {}
+          query_params["location_id"] = params[:location_id] if params.key?(:location_id)
+          params = params.except(*query_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: "GET",
             path: "v2/cash-drawers/shifts/#{params[:shift_id]}",
-            query: _query
+            query: query_params,
+            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::GetCashDrawerShiftResponse.load(_response.body)
+            Square::Types::GetCashDrawerShiftResponse.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
 
         # Provides a paginated list of events for a single cash drawer shift.
         #
+        # @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] :shift_id
+        # @option params [String] :location_id
+        # @option params [Integer, nil] :limit
+        # @option params [String, nil] :cursor
+        #
         # @return [Square::Types::ListCashDrawerShiftEventsResponse]
         def list_events(request_options: {}, **params)
-          _query_param_names = [
-            %w[location_id limit cursor],
-            %i[location_id limit cursor]
-          ].flatten
-          _query = params.slice(*_query_param_names)
-          params = params.except(*_query_param_names)
+          params = Square::Internal::Types::Utils.normalize_keys(params)
+          query_param_names = %i[location_id limit cursor]
+          query_params = {}
+          query_params["location_id"] = params[:location_id] if params.key?(:location_id)
+          query_params["limit"] = params[:limit] if params.key?(:limit)
+          query_params["cursor"] = params[:cursor] if params.key?(:cursor)
+          params = params.except(*query_param_names)
 
-          _request = Square::Internal::JSON::Request.new(
-            base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
-            method: "GET",
-            path: "v2/cash-drawers/shifts/#{params[:shift_id]}/events",
-            query: _query
-          )
-          begin
-            _response = @client.send(_request)
-          rescue Net::HTTPRequestTimeout
-            raise Square::Errors::TimeoutError
-          end
-          code = _response.code.to_i
-          if code.between?(200, 299)
-            Square::Types::ListCashDrawerShiftEventsResponse.load(_response.body)
-          else
-            error_class = Square::Errors::ResponseError.subclass_for_code(code)
-            raise error_class.new(_response.body, code: code)
+          Square::Internal::CursorItemIterator.new(
+            cursor_field: :cursor,
+            item_field: :cash_drawer_shift_events,
+            initial_cursor: query_params[:cursor]
+          ) do |next_cursor|
+            query_params[:cursor] = next_cursor
+            request = Square::Internal::JSON::Request.new(
+              base_url: request_options[:base_url],
+              method: "GET",
+              path: "v2/cash-drawers/shifts/#{params[:shift_id]}/events",
+              query: query_params,
+              request_options: request_options
+            )
+            begin
+              response = @client.send(request)
+            rescue Net::HTTPRequestTimeout
+              raise Square::Errors::TimeoutError
+            end
+            code = response.code.to_i
+            if code.between?(200, 299)
+              Square::Types::ListCashDrawerShiftEventsResponse.load(response.body)
+            else
+              error_class = Square::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(response.body, code: code)
+            end
           end
         end
       end