square.rb 33.0.0.20231018 → 42.1.0.20250416

data/lib/square/api/webhook_subscriptions_api.rb

@@ -5,7 +5,7 @@ module Square
     # @param [String] api_version Optional parameter: The API version for which
     # to list event types. Setting this field overrides the default version used
     # by the application.
-    # @return [ListWebhookEventTypesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_webhook_event_types(api_version: nil)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -15,9 +15,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -37,7 +37,7 @@ module Square
     # to be returned in a single page. It is possible to receive fewer results
     # than the specified limit on a given page. The default value of 100 is also
     # the maximum allowed value.  Default: 100
-    # @return [ListWebhookSubscriptionsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_webhook_subscriptions(cursor: nil,
                                    include_disabled: false,
                                    sort_order: nil,
@@ -53,9 +53,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -63,7 +63,7 @@ module Square
     # @param [CreateWebhookSubscriptionRequest] body Required parameter: An
     # object containing the fields to POST for the request.  See the
     # corresponding object definition for field details.
-    # @return [CreateWebhookSubscriptionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_webhook_subscription(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -75,16 +75,16 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
     # Deletes a webhook subscription.
     # @param [String] subscription_id Required parameter: [REQUIRED] The ID of
     # the [Subscription](entity:WebhookSubscription) to delete.
-    # @return [DeleteWebhookSubscriptionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_webhook_subscription(subscription_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -95,16 +95,16 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
     # Retrieves a webhook subscription identified by its ID.
     # @param [String] subscription_id Required parameter: [REQUIRED] The ID of
     # the [Subscription](entity:WebhookSubscription) to retrieve.
-    # @return [RetrieveWebhookSubscriptionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_webhook_subscription(subscription_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -115,9 +115,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -127,7 +127,7 @@ module Square
     # @param [UpdateWebhookSubscriptionRequest] body Required parameter: An
     # object containing the fields to POST for the request.  See the
     # corresponding object definition for field details.
-    # @return [UpdateWebhookSubscriptionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_webhook_subscription(subscription_id:,
                                     body:)
       new_api_call_builder
@@ -142,9 +142,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -155,7 +155,7 @@ module Square
     # @param [UpdateWebhookSubscriptionSignatureKeyRequest] body Required
     # parameter: An object containing the fields to POST for the request.  See
     # the corresponding object definition for field details.
-    # @return [UpdateWebhookSubscriptionSignatureKeyResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_webhook_subscription_signature_key(subscription_id:,
                                                   body:)
       new_api_call_builder
@@ -170,9 +170,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -183,7 +183,7 @@ module Square
     # @param [TestWebhookSubscriptionRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [TestWebhookSubscriptionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def test_webhook_subscription(subscription_id:,
                                   body:)
       new_api_call_builder
@@ -198,9 +198,9 @@ module Square
                    .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)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
   end

data/lib/square/client.rb

@@ -1,10 +1,11 @@
 module Square
   #  square client class.
   class Client
+    include CoreLibrary
     attr_reader :config, :auth_managers
 
     def sdk_version
-      '33.0.0.20231018'
+      '42.1.0.20250416'
     end
 
     def square_version
@@ -117,6 +118,12 @@ module Square
       @employees ||= EmployeesApi.new @global_configuration
     end
 
+    # Access to events controller.
+    # @return [EventsApi] Returns the controller instance.
+    def events
+      @events ||= EventsApi.new @global_configuration
+    end
+
     # Access to gift_cards controller.
     # @return [GiftCardsApi] Returns the controller instance.
     def gift_cards
@@ -261,28 +268,29 @@ module Square
       @webhook_subscriptions ||= WebhookSubscriptionsApi.new @global_configuration
     end
 
-    def initialize(connection: nil, adapter: :net_http_persistent, timeout: 60,
-                   max_retries: 0, retry_interval: 1, backoff_factor: 2,
-                   retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
-                   retry_methods: %i[get put], http_callback: nil,
-                   environment: 'production',
-                   custom_url: 'https://connect.squareup.com', access_token: '',
-                   square_version: '2023-10-18', user_agent_detail: '',
-                   additional_headers: {}, config: nil)
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, environment: 'production',
+      custom_url: 'https://connect.squareup.com', access_token: nil,
+      bearer_auth_credentials: nil, square_version: '2025-04-16',
+      user_agent_detail: '', additional_headers: {}, config: nil
+    )
       @config = if config.nil?
-                  Configuration.new(connection: connection, adapter: adapter,
-                                    timeout: timeout, max_retries: max_retries,
-                                    retry_interval: retry_interval,
-                                    backoff_factor: backoff_factor,
-                                    retry_statuses: retry_statuses,
-                                    retry_methods: retry_methods,
-                                    http_callback: http_callback,
-                                    environment: environment,
-                                    custom_url: custom_url,
-                                    access_token: access_token,
-                                    square_version: square_version,
-                                    user_agent_detail: user_agent_detail,
-                                    additional_headers: additional_headers)
+                  Configuration.new(
+                    connection: connection, adapter: adapter, timeout: timeout,
+                    max_retries: max_retries, retry_interval: retry_interval,
+                    backoff_factor: backoff_factor,
+                    retry_statuses: retry_statuses,
+                    retry_methods: retry_methods, http_callback: http_callback,
+                    environment: environment, custom_url: custom_url,
+                    access_token: access_token,
+                    bearer_auth_credentials: bearer_auth_credentials,
+                    square_version: square_version,
+                    user_agent_detail: user_agent_detail,
+                    additional_headers: additional_headers
+                  )
                 else
                   config
                 end
@@ -311,8 +319,8 @@ module Square
     def initialize_auth_managers(global_config)
       @auth_managers = {}
       http_client_config = global_config.client_configuration
-      ['global'].each { |auth| @auth_managers[auth] = nil }
-      @auth_managers['global'] = OAuth2.new(http_client_config.access_token)
+      %w[global].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['global'] = OAuth2.new(http_client_config.bearer_auth_credentials)
     end
   end
 end

data/lib/square/configuration.rb

@@ -2,8 +2,13 @@ module Square
   # All configuration including auth info and base URI for the API access
   # are configured in this class.
   class Configuration < CoreLibrary::HttpClientConfiguration
+    def access_token
+      @bearer_auth_credentials.access_token
+    end
+
     # The attribute readers for properties.
-    attr_reader :environment, :custom_url, :access_token, :square_version, :user_agent_detail
+    attr_reader :environment, :custom_url, :bearer_auth_credentials,
+                :square_version, :user_agent_detail
 
     def additional_headers
       @additional_headers.clone
@@ -13,14 +18,15 @@ module Square
       attr_reader :environments
     end
 
-    def initialize(connection: nil, adapter: :net_http_persistent, timeout: 60,
-                   max_retries: 0, retry_interval: 1, backoff_factor: 2,
-                   retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
-                   retry_methods: %i[get put], http_callback: nil,
-                   environment: 'production',
-                   custom_url: 'https://connect.squareup.com', access_token: '',
-                   square_version: '2023-10-18', user_agent_detail: '',
-                   additional_headers: {})
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, environment: 'production',
+      custom_url: 'https://connect.squareup.com', access_token: nil,
+      bearer_auth_credentials: nil, square_version: '2025-04-16',
+      user_agent_detail: '', additional_headers: {}
+    )
 
       super connection: connection, adapter: adapter, timeout: timeout,
             max_retries: max_retries, retry_interval: retry_interval,
@@ -42,6 +48,11 @@ module Square
       # Additional headers to add to each API request
       @additional_headers = additional_headers.clone
 
+      # Initializing OAuth 2 Bearer token credentials with the provided auth parameters
+      @bearer_auth_credentials = create_auth_credentials_object(
+        access_token, bearer_auth_credentials
+      )
+
       # The Http Client to use for making requests.
       set_http_client CoreLibrary::FaradayClient.new(self)
 
@@ -53,8 +64,8 @@ module Square
                    max_retries: nil, retry_interval: nil, backoff_factor: nil,
                    retry_statuses: nil, retry_methods: nil, http_callback: nil,
                    environment: nil, custom_url: nil, access_token: nil,
-                   square_version: nil, user_agent_detail: nil,
-                   additional_headers: nil)
+                   bearer_auth_credentials: nil, square_version: nil,
+                   user_agent_detail: nil, additional_headers: nil)
       connection ||= self.connection
       adapter ||= self.adapter
       timeout ||= self.timeout
@@ -66,10 +77,12 @@ module Square
       http_callback ||= self.http_callback
       environment ||= self.environment
       custom_url ||= self.custom_url
-      access_token ||= self.access_token
       square_version ||= self.square_version
       user_agent_detail ||= self.user_agent_detail
       additional_headers ||= self.additional_headers
+      bearer_auth_credentials = create_auth_credentials_object(
+        access_token, bearer_auth_credentials || self.bearer_auth_credentials
+      )
 
       Configuration.new(connection: connection, adapter: adapter,
                         timeout: timeout, max_retries: max_retries,
@@ -78,10 +91,10 @@ module Square
                         retry_statuses: retry_statuses,
                         retry_methods: retry_methods,
                         http_callback: http_callback, environment: environment,
-                        custom_url: custom_url, access_token: access_token,
-                        square_version: square_version,
+                        custom_url: custom_url, square_version: square_version,
                         user_agent_detail: user_agent_detail,
-                        additional_headers: additional_headers)
+                        additional_headers: additional_headers,
+                        bearer_auth_credentials: bearer_auth_credentials)
     end
 
     def get_user_agent(user_agent_detail)
@@ -91,6 +104,21 @@ module Square
       user_agent_detail
     end
 
+    def create_auth_credentials_object(access_token, bearer_auth_credentials)
+      return bearer_auth_credentials if access_token.nil?
+
+      warn('The \'access_token\' params are deprecated. Use \'bearer_auth_cred'\
+           'entials\' param instead.')
+
+      unless bearer_auth_credentials.nil?
+        return bearer_auth_credentials.clone_with(
+          access_token: access_token
+        )
+      end
+
+      BearerAuthCredentials.new(access_token: access_token)
+    end
+
     # All the environments the SDK can run in.
     ENVIRONMENTS = {
       'production' => {

data/lib/square/http/api_response.rb

@@ -20,7 +20,7 @@ module Square
 
         @cursor = data.fetch(:cursor, nil)
         data.reject! { |k| %i[cursor errors].include?(k) }
-        @data = Struct.new(*data.keys).new(*data.values) if data.keys.any?
+        @data = data.keys.any? ? Struct.new(*data.keys).new(*data.values) : nil
       else
         @data = data
         @body = data

data/lib/square/http/auth/o_auth2.rb

@@ -1,6 +1,7 @@
 module Square
   # Utility class for OAuth 2 authorization and token management.
   class OAuth2 < CoreLibrary::HeaderAuth
+    include CoreLibrary
     # Display error message on occurrence of authentication failure.
     # @returns [String] The oAuth error message.
     def error_message
@@ -8,12 +9,30 @@ module Square
     end
 
     # Initialization constructor.
-    def initialize(access_token)
+    def initialize(bearer_auth_credentials)
       auth_params = {}
-      @_access_token = access_token
+      @_access_token = bearer_auth_credentials.access_token unless
+        bearer_auth_credentials.nil? || bearer_auth_credentials.access_token.nil?
       auth_params['Authorization'] = "Bearer #{@_access_token}" unless @_access_token.nil?
 
       super auth_params
     end
   end
+
+  # Data class for BearerAuthCredentials.
+  class BearerAuthCredentials
+    attr_reader :access_token
+
+    def initialize(access_token:)
+      raise ArgumentError, 'access_token cannot be nil' if access_token.nil?
+
+      @access_token = access_token
+    end
+
+    def clone_with(access_token: nil)
+      access_token ||= self.access_token
+
+      BearerAuthCredentials.new(access_token: access_token)
+    end
+  end
 end

data/lib/square.rb

@@ -1,11 +1,9 @@
 require 'date'
 require 'json'
+
 require 'apimatic_core_interfaces'
 require 'apimatic_core'
 require 'apimatic_faraday_client_adapter'
-# rubocop:disable Style/MixinUsage
-include CoreLibrary
-# rubocop:enable Style/MixinUsage
 
 require_relative 'square/api_helper'
 require_relative 'square/client'
@@ -20,6 +18,8 @@ require_relative 'square/http/http_call_back'
 require_relative 'square/http/http_method_enum'
 require_relative 'square/http/http_request'
 require_relative 'square/http/http_response'
+
+# Logger
 require_relative 'square/http/auth/o_auth2'
 
 # Models
@@ -48,6 +48,7 @@ require_relative 'square/api/customer_segments_api'
 require_relative 'square/api/devices_api'
 require_relative 'square/api/disputes_api'
 require_relative 'square/api/employees_api'
+require_relative 'square/api/events_api'
 require_relative 'square/api/gift_cards_api'
 require_relative 'square/api/gift_card_activities_api'
 require_relative 'square/api/inventory_api'

data/test/api/api_test_base.rb

@@ -9,6 +9,7 @@ require_relative '../http_response_catcher'
 class ApiTestBase < Minitest::Test
   parallelize_me!
   include Square
+  include CoreLibrary
 
   # Create configuration and set any test parameters
   def create_configuration
@@ -22,6 +23,5 @@ class ApiTestBase < Minitest::Test
   def setup_class
     _config = create_configuration
     @client = Client.new(config: _config)
-    _auth_managers = @client.auth_managers
   end
 end

data/test/api/test_locations_api.rb

@@ -9,7 +9,7 @@ class LocationsApiTests < ApiTestBase
   end
 
   # Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api),
-  #including those with an inactive status.
+  #including those with an inactive status. Locations are listed alphabetically by `name`.
   def test_list_locations
 
     # Perform the API call through the SDK function

data/test/api/test_refunds_api.rb

@@ -22,9 +22,12 @@ class RefundsApiTests < ApiTestBase
     location_id = nil
     status = nil
     source_type = nil
+    updated_at_begin_time = nil
+    updated_at_end_time = nil
+    sort_field = nil
 
     # Perform the API call through the SDK function
-    result = @controller.list_payment_refunds(begin_time: begin_time, end_time: end_time, sort_order: sort_order, cursor: cursor, location_id: location_id, status: status, source_type: source_type)
+    result = @controller.list_payment_refunds(begin_time: begin_time, end_time: end_time, sort_order: sort_order, cursor: cursor, location_id: location_id, status: status, source_type: source_type, updated_at_begin_time: updated_at_begin_time, updated_at_end_time: updated_at_end_time, sort_field: sort_field)
 
     # Test response code
     assert_equal(200, @response_catcher.response.status_code)

data/test/webhooks/test_webhooks_helper.rb

@@ -27,6 +27,23 @@ class WebhooksHelperTest < Minitest::Test
     assert_equal true, is_valid
   end
 
+  def test_signature_validation_escaped_pass
+    @logger.info('Running test_signature_validation_pass') # Log a message
+    
+    escpaedRequestBody = '{"data":{"type":"webhooks","id":">id<"}}';
+    newSignatureHeader = "Cxt7+aTi4rKgcA0bC4g9EHdVtLSDWdqccmL5MvihU4U=";
+    signatureKey = "signature-key";
+    url = "https://webhook.site/webhooks";
+
+    is_valid = Square::WebhooksHelper.is_valid_webhook_event_signature(
+      escpaedRequestBody,
+      newSignatureHeader,
+      signatureKey,
+      url
+    )
+    assert_equal true, is_valid
+  end
+
   def test_signature_validation_fails_on_notification_url_mismatch
     @logger.info('Running test_signature_validation_fails_on_notification_url_mismatch') # Log a message
     is_valid = Square::WebhooksHelper.is_valid_webhook_event_signature(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 33.0.0.20231018
+  version: 42.1.0.20250416
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-17 00:00:00.000000000 Z
+date: 2025-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces
@@ -16,62 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: apimatic_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.11
 - !ruby/object:Gem::Dependency
   name: apimatic_faraday_client_adapter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.4
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.14.1
+        version: 5.24.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.14.1
+        version: 5.24.0
 - !ruby/object:Gem::Dependency
   name: minitest-proveit
   requirement: !ruby/object:Gem::Requirement
@@ -112,6 +106,7 @@ files:
 - lib/square/api/devices_api.rb
 - lib/square/api/disputes_api.rb
 - lib/square/api/employees_api.rb
+- lib/square/api/events_api.rb
 - lib/square/api/gift_card_activities_api.rb
 - lib/square/api/gift_cards_api.rb
 - lib/square/api/inventory_api.rb
@@ -163,7 +158,7 @@ files:
 - test/api/test_refunds_api.rb
 - test/http_response_catcher.rb
 - test/webhooks/test_webhooks_helper.rb
-homepage: ''
+homepage: https://squareup.com/developers
 licenses:
 - Apache-2.0
 metadata: {}