square.rb 44.2.0.20251016 → 45.0.1.20260122

data/lib/square/refunds/client.rb

@@ -3,7 +3,9 @@
 module Square
   module Refunds
     class Client
-      # @return [Square::Refunds::Client]
+      # @param client [Square::Internal::Http::RawClient]
+      #
+      # @return [void]
       def initialize(client:)
         @client = client
       end
@@ -15,34 +17,68 @@ module Square
       #
       # The maximum results per page is 100.
       #
+      # @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] :begin_time
+      # @option params [String, nil] :end_time
+      # @option params [String, nil] :sort_order
+      # @option params [String, nil] :cursor
+      # @option params [String, nil] :location_id
+      # @option params [String, nil] :status
+      # @option params [String, nil] :source_type
+      # @option params [Integer, nil] :limit
+      # @option params [String, nil] :updated_at_begin_time
+      # @option params [String, nil] :updated_at_end_time
+      # @option params [Square::Types::ListPaymentRefundsRequestSortField, nil] :sort_field
+      #
       # @return [Square::Types::ListPaymentRefundsResponse]
       def list(request_options: {}, **params)
-        _query_param_names = [
-          %w[begin_time end_time sort_order cursor location_id status source_type limit
-             updated_at_begin_time updated_at_end_time sort_field],
-          %i[begin_time end_time sort_order cursor location_id status source_type limit updated_at_begin_time
-             updated_at_end_time sort_field]
-        ].flatten
-        _query = params.slice(*_query_param_names)
-        params.except(*_query_param_names)
+        params = Square::Internal::Types::Utils.normalize_keys(params)
+        query_param_names = %i[begin_time end_time sort_order cursor location_id status source_type limit updated_at_begin_time updated_at_end_time sort_field]
+        query_params = {}
+        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["sort_order"] = params[:sort_order] if params.key?(:sort_order)
+        query_params["cursor"] = params[:cursor] if params.key?(:cursor)
+        query_params["location_id"] = params[:location_id] if params.key?(:location_id)
+        query_params["status"] = params[:status] if params.key?(:status)
+        query_params["source_type"] = params[:source_type] if params.key?(:source_type)
+        query_params["limit"] = params[:limit] if params.key?(:limit)
+        query_params["updated_at_begin_time"] = params[:updated_at_begin_time] if params.key?(:updated_at_begin_time)
+        query_params["updated_at_end_time"] = params[:updated_at_end_time] if params.key?(:updated_at_end_time)
+        query_params["sort_field"] = params[:sort_field] if params.key?(:sort_field)
+        params.except(*query_param_names)
 
-        _request = Square::Internal::JSON::Request.new(
-          base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
-          method: "GET",
-          path: "v2/refunds",
-          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::ListPaymentRefundsResponse.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: :refunds,
+          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/refunds",
+            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::ListPaymentRefundsResponse.load(response.body)
+          else
+            error_class = Square::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
         end
       end
 
@@ -51,48 +87,69 @@ module Square
       # refund of a cash or external payment. For more information, see
       # [Refund Payment](https://developer.squareup.com/docs/payments-api/refund-payments).
       #
+      # @param request_options [Hash]
+      # @param params [Square::Refunds::Types::RefundPaymentRequest]
+      # @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::RefundPaymentResponse]
       def refund_payment(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/refunds",
-          body: params
+          body: Square::Refunds::Types::RefundPaymentRequest.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::RefundPaymentResponse.load(_response.body)
+          Square::Types::RefundPaymentResponse.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 specific refund using the `refund_id`.
       #
+      # @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] :refund_id
+      #
       # @return [Square::Types::GetPaymentRefundResponse]
       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/refunds/#{params[:refund_id]}"
+          path: "v2/refunds/#{params[:refund_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::GetPaymentRefundResponse.load(_response.body)
+          Square::Types::GetPaymentRefundResponse.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/refunds/types/refund_payment_request.rb

@@ -16,9 +16,7 @@ module Square
         field :payment_version_token, -> { String }, optional: true, nullable: false
         field :team_member_id, -> { String }, optional: true, nullable: false
         field :cash_details, -> { Square::Types::DestinationDetailsCashRefundDetails }, optional: true, nullable: false
-        field :external_details, lambda {
-          Square::Types::DestinationDetailsExternalRefundDetails
-        }, optional: true, nullable: false
+        field :external_details, -> { Square::Types::DestinationDetailsExternalRefundDetails }, optional: true, nullable: false
       end
     end
   end

data/lib/square/sites/client.rb

@@ -3,34 +3,49 @@
 module Square
   module Sites
     class Client
-      # @return [Square::Sites::Client]
+      # @param client [Square::Internal::Http::RawClient]
+      #
+      # @return [void]
       def initialize(client:)
         @client = client
       end
 
-      # Lists the Square Online sites that belong to a seller. Sites are listed in descending order by the `created_at` date.
+      # Lists the Square Online sites that belong to a seller. Sites are listed in descending order by the `created_at`
+      # date.
+      #
       #
+      # __Note:__ Square Online APIs are publicly available as part of an early access program. For more information,
+      # see [Early access program for Square Online
+      # APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).
       #
-      # __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).
+      # @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::ListSitesResponse]
-      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/sites"
+          path: "v2/sites",
+          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::ListSitesResponse.load(_response.body)
+          Square::Types::ListSitesResponse.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/snippets/client.rb

@@ -3,68 +3,100 @@
 module Square
   module Snippets
     class Client
-      # @return [Square::Snippets::Client]
+      # @param client [Square::Internal::Http::RawClient]
+      #
+      # @return [void]
       def initialize(client:)
         @client = client
       end
 
-      # Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application.
+      # Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet
+      # applications, but you can retrieve only the snippet that was added by your application.
       #
       # You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller.
       #
       #
-      # __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).
+      # __Note:__ Square Online APIs are publicly available as part of an early access program. For more information,
+      # see [Early access program for Square Online
+      # APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).
+      #
+      # @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] :site_id
       #
       # @return [Square::Types::GetSnippetResponse]
       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/sites/#{params[:site_id]}/snippet"
+          path: "v2/sites/#{params[:site_id]}/snippet",
+          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::GetSnippetResponse.load(_response.body)
+          Square::Types::GetSnippetResponse.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
 
       # Adds a snippet to a Square Online site or updates the existing snippet on the site.
-      # The snippet code is appended to the end of the `head` element on every page of the site, except checkout pages. A snippet application can add one snippet to a given site.
+      # The snippet code is appended to the end of the `head` element on every page of the site, except checkout pages.
+      # A snippet application can add one snippet to a given site.
       #
       # You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller.
       #
       #
-      # __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).
+      # __Note:__ Square Online APIs are publicly available as part of an early access program. For more information,
+      # see [Early access program for Square Online
+      # APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).
+      #
+      # @param request_options [Hash]
+      # @param params [Square::Snippets::Types::UpsertSnippetRequest]
+      # @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] :site_id
       #
       # @return [Square::Types::UpsertSnippetResponse]
       def upsert(request_options: {}, **params)
-        _path_param_names = ["site_id"]
+        params = Square::Internal::Types::Utils.normalize_keys(params)
+        request_data = Square::Snippets::Types::UpsertSnippetRequest.new(params).to_h
+        non_body_param_names = ["site_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/sites/#{params[:site_id]}/snippet",
-          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::UpsertSnippetResponse.load(_response.body)
+          Square::Types::UpsertSnippetResponse.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
 
@@ -73,26 +105,39 @@ module Square
       # You can call [ListSites](api-endpoint:Sites-ListSites) to get the IDs of the sites that belong to a seller.
       #
       #
-      # __Note:__ Square Online APIs are publicly available as part of an early access program. For more information, see [Early access program for Square Online APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).
+      # __Note:__ Square Online APIs are publicly available as part of an early access program. For more information,
+      # see [Early access program for Square Online
+      # APIs](https://developer.squareup.com/docs/online-api#early-access-program-for-square-online-apis).
+      #
+      # @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] :site_id
       #
       # @return [Square::Types::DeleteSnippetResponse]
       def delete(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: "DELETE",
-          path: "v2/sites/#{params[:site_id]}/snippet"
+          path: "v2/sites/#{params[:site_id]}/snippet",
+          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::DeleteSnippetResponse.load(_response.body)
+          Square::Types::DeleteSnippetResponse.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