square.rb 44.1.0.20250924 → 45.0.1.20260122

data/lib/square/webhooks/subscriptions/client.rb

@@ -4,187 +4,282 @@ module Square
   module Webhooks
     module Subscriptions
       class Client
-        # @return [Square::Webhooks::Subscriptions::Client]
+        # @param client [Square::Internal::Http::RawClient]
+        #
+        # @return [void]
         def initialize(client:)
           @client = client
         end
 
         # Lists all webhook subscriptions owned by your application.
         #
+        # @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 [Boolean, nil] :include_disabled
+        # @option params [Square::Types::SortOrder, nil] :sort_order
+        # @option params [Integer, nil] :limit
+        #
         # @return [Square::Types::ListWebhookSubscriptionsResponse]
         def list(request_options: {}, **params)
-          _query_param_names = [
-            %w[cursor include_disabled sort_order limit],
-            %i[cursor include_disabled sort_order limit]
-          ].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 include_disabled sort_order limit]
+          query_params = {}
+          query_params["cursor"] = params[:cursor] if params.key?(:cursor)
+          query_params["include_disabled"] = params[:include_disabled] if params.key?(:include_disabled)
+          query_params["sort_order"] = params[:sort_order] if params.key?(:sort_order)
+          query_params["limit"] = params[:limit] if params.key?(:limit)
+          params.except(*query_param_names)
 
-          _request = Square::Internal::JSON::Request.new(
-            base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
-            method: "GET",
-            path: "v2/webhooks/subscriptions",
-            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::ListWebhookSubscriptionsResponse.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: :subscriptions,
+            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/webhooks/subscriptions",
+              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::ListWebhookSubscriptionsResponse.load(response.body)
+            else
+              error_class = Square::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(response.body, code: code)
+            end
           end
         end
 
         # Creates a webhook subscription.
         #
+        # @param request_options [Hash]
+        # @param params [Square::Webhooks::Subscriptions::Types::CreateWebhookSubscriptionRequest]
+        # @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::CreateWebhookSubscriptionResponse]
         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/webhooks/subscriptions",
-            body: params
+            body: Square::Webhooks::Subscriptions::Types::CreateWebhookSubscriptionRequest.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::CreateWebhookSubscriptionResponse.load(_response.body)
+            Square::Types::CreateWebhookSubscriptionResponse.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 webhook subscription identified by its 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] :subscription_id
+        #
         # @return [Square::Types::GetWebhookSubscriptionResponse]
         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/webhooks/subscriptions/#{params[:subscription_id]}"
+            path: "v2/webhooks/subscriptions/#{params[:subscription_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::GetWebhookSubscriptionResponse.load(_response.body)
+            Square::Types::GetWebhookSubscriptionResponse.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
 
         # Updates a webhook subscription.
         #
+        # @param request_options [Hash]
+        # @param params [Square::Webhooks::Subscriptions::Types::UpdateWebhookSubscriptionRequest]
+        # @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] :subscription_id
+        #
         # @return [Square::Types::UpdateWebhookSubscriptionResponse]
         def update(request_options: {}, **params)
-          _path_param_names = ["subscription_id"]
+          params = Square::Internal::Types::Utils.normalize_keys(params)
+          request_data = Square::Webhooks::Subscriptions::Types::UpdateWebhookSubscriptionRequest.new(params).to_h
+          non_body_param_names = ["subscription_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: "PUT",
             path: "v2/webhooks/subscriptions/#{params[:subscription_id]}",
-            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::UpdateWebhookSubscriptionResponse.load(_response.body)
+            Square::Types::UpdateWebhookSubscriptionResponse.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
 
         # Deletes a webhook subscription.
         #
+        # @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] :subscription_id
+        #
         # @return [Square::Types::DeleteWebhookSubscriptionResponse]
         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/webhooks/subscriptions/#{params[:subscription_id]}"
+            path: "v2/webhooks/subscriptions/#{params[:subscription_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::DeleteWebhookSubscriptionResponse.load(_response.body)
+            Square::Types::DeleteWebhookSubscriptionResponse.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
 
         # Updates a webhook subscription by replacing the existing signature key with a new one.
         #
+        # @param request_options [Hash]
+        # @param params [Square::Webhooks::Subscriptions::Types::UpdateWebhookSubscriptionSignatureKeyRequest]
+        # @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] :subscription_id
+        #
         # @return [Square::Types::UpdateWebhookSubscriptionSignatureKeyResponse]
         def update_signature_key(request_options: {}, **params)
-          _path_param_names = ["subscription_id"]
+          params = Square::Internal::Types::Utils.normalize_keys(params)
+          request_data = Square::Webhooks::Subscriptions::Types::UpdateWebhookSubscriptionSignatureKeyRequest.new(params).to_h
+          non_body_param_names = ["subscription_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/webhooks/subscriptions/#{params[:subscription_id]}/signature-key",
-            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::UpdateWebhookSubscriptionSignatureKeyResponse.load(_response.body)
+            Square::Types::UpdateWebhookSubscriptionSignatureKeyResponse.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
 
         # Tests a webhook subscription by sending a test event to the notification URL.
         #
+        # @param request_options [Hash]
+        # @param params [Square::Webhooks::Subscriptions::Types::TestWebhookSubscriptionRequest]
+        # @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] :subscription_id
+        #
         # @return [Square::Types::TestWebhookSubscriptionResponse]
         def test(request_options: {}, **params)
-          _path_param_names = ["subscription_id"]
+          params = Square::Internal::Types::Utils.normalize_keys(params)
+          request_data = Square::Webhooks::Subscriptions::Types::TestWebhookSubscriptionRequest.new(params).to_h
+          non_body_param_names = ["subscription_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/webhooks/subscriptions/#{params[:subscription_id]}/test",
-            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::TestWebhookSubscriptionResponse.load(_response.body)
+            Square::Types::TestWebhookSubscriptionResponse.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