square.rb 20.0.0.20220512 → 20.1.0.20220616

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1907488e99eddc840ad5c67c38ac3feaacf9b6440359b6085add2d248388ab7a
-  data.tar.gz: e6647691aec85fd628b47ac329248f9171a33570bf0eb37871391f7e246a8014
+  metadata.gz: 68c3c60d1b69c141d163be8e453c91bd76cca35f98228aeae4a41f7b61afe8a6
+  data.tar.gz: 3df6c78f8e6e493967624fca0cd804c1547aa6ccfb2b57daaac05695a33df12d
 SHA512:
-  metadata.gz: 1b0d5825af20339f09f49466d34a46825bc25c995eba52108174d1e78ed58083cc1c5b280fecefe4f1edbf94a8ca45aba427c0c01feafac02b6e0b076224f749
-  data.tar.gz: 572efdbd9f3ebb6915ab82e2c2b554e5b2e53d764f6a64f05c4cfd5373118e73f97b9076ad0ce8d0dc70c3c5a540d29db5fb101ceb4bde7da8638e0edc4eb448
+  metadata.gz: ab11afe945aa6630b158b07040290572d591b15e2d0829363dd334fc38f5197cc2d5eed47a36cf84e68061667d91b874486892da5acebb4f25420b8bec6e190b
+  data.tar.gz: 3427cb9920daac7363c982754ab7a5c8ef1abf609786e9c8b2bb4a6a4f82da77a2b05e9d7758d71c86613ef8dc54536ea44b9c9f9eed44576d90272121327b67

data/lib/square/api/base_api.rb

@@ -38,7 +38,7 @@ module Square
     end
 
     def get_user_agent
-      user_agent = 'Square-Ruby-SDK/20.0.0.20220512 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      user_agent = 'Square-Ruby-SDK/20.1.0.20220616 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
       user_agent['{engine}'] = RUBY_ENGINE
       user_agent['{engine-version}'] = RUBY_ENGINE_VERSION
       user_agent['{os-info}'] = RUBY_PLATFORM

data/lib/square/api/catalog_api.rb

@@ -316,9 +316,9 @@ module Square
     # Square API used to make the request. Object types that are nested onto
     # other object types are not included in the defaults.  At the current API
     # version the default object types are: ITEM, CATEGORY, TAX, DISCOUNT,
-    # MODIFIER_LIST, DINING_OPTION, TAX_EXEMPTION, SERVICE_CHARGE, PRICING_RULE,
-    # PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, SUBSCRIPTION_PLAN,
-    # ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.
+    # MODIFIER_LIST,  PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,
+    # SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION,
+    # QUICK_AMOUNT_SETTINGS.
     # @param [Long] catalog_version Optional parameter: The specific version of
     # the catalog objects to be included in the response.  This allows you to
     # retrieve historical versions of objects. The specified version value is

data/lib/square/api/gift_cards_api.rb

@@ -6,7 +6,8 @@ module Square
     end
 
     # Lists all gift cards. You can specify optional filters to retrieve
-    # a subset of the gift cards.
+    # a subset of the gift cards. Results are sorted by `created_at` in
+    # ascending order.
     # @param [String] type Optional parameter: If a [type]($m/GiftCardType) is
     # provided, the endpoint returns gift cards of the specified type.
     # Otherwise, the endpoint returns gift cards of all types.

data/lib/square/api/loyalty_api.rb

@@ -113,7 +113,7 @@ module Square
       )
     end
 
-    # Adds points to a loyalty account.
+    # Adds points earned from the base loyalty program to a loyalty account.
     # - If you are using the Orders API to manage orders, you only provide the
     # `order_id`.
     # The endpoint reads the order to compute points to add to the buyer's
@@ -124,6 +124,7 @@ module Square
     # [CalculateLoyaltyPoints]($e/Loyalty/CalculateLoyaltyPoints) to compute the
     # points
     # that you provide to this endpoint.
+    # This endpoint excludes additional points earned from loyalty promotions.
     # @param [String] account_id Required parameter: The [loyalty
     # account]($m/LoyaltyAccount) ID to which to add the points.
     # @param [AccumulateLoyaltyPointsRequest] body Required parameter: An object
@@ -329,7 +330,7 @@ module Square
       )
     end
 
-    # Calculates the points a purchase earns.
+    # Calculates the points a purchase earns from the base loyalty program.
     # - If you are using the Orders API to manage orders, you provide the
     # `order_id` in the request. The
     # endpoint calculates the points by reading the order.

data/lib/square/api/terminal_api.rb

@@ -5,9 +5,7 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Creates a Terminal action request and sends it to the specified device to
-    # take a payment
-    # for the requested amount.
+    # Creates a Terminal action request and sends it to the specified device.
     # @param [CreateTerminalActionRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '20.0.0.20220512'
+      '20.1.0.20220616'
     end
 
     def square_version
@@ -231,16 +231,17 @@ module Square
       @vendors ||= VendorsApi.new config
     end
 
-    def initialize(connection: nil, timeout: 60, max_retries: 0,
-                   retry_interval: 1, backoff_factor: 2,
+    def initialize(connection: nil, adapter: Faraday.default_adapter,
+                   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], environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2022-05-12', access_token: '',
+                   square_version: '2022-06-16', access_token: '',
                    user_agent_detail: '', additional_headers: {}, config: nil)
       @config = if config.nil?
-                  Configuration.new(connection: connection, timeout: timeout,
-                                    max_retries: max_retries,
+                  Configuration.new(connection: connection, adapter: adapter,
+                                    timeout: timeout, max_retries: max_retries,
                                     retry_interval: retry_interval,
                                     backoff_factor: backoff_factor,
                                     retry_statuses: retry_statuses,

data/lib/square/configuration.rb

@@ -3,9 +3,9 @@ module Square
   # are configured in this class.
   class Configuration
     # The attribute readers for properties.
-    attr_reader :http_client, :connection, :timeout, :max_retries, :retry_interval, :backoff_factor,
-                :retry_statuses, :retry_methods, :environment, :custom_url, :square_version,
-                :access_token, :user_agent_detail
+    attr_reader :http_client, :connection, :adapter, :timeout, :max_retries, :retry_interval,
+                :backoff_factor, :retry_statuses, :retry_methods, :environment, :custom_url,
+                :square_version, :access_token, :user_agent_detail
 
     def additional_headers
       @additional_headers.clone
@@ -15,16 +15,20 @@ module Square
       attr_reader :environments
     end
 
-    def initialize(connection: nil, timeout: 60, max_retries: 0,
-                   retry_interval: 1, backoff_factor: 2,
+    def initialize(connection: nil, adapter: Faraday.default_adapter,
+                   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], environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2022-05-12', access_token: '',
+                   square_version: '2022-06-16', access_token: '',
                    user_agent_detail: '', additional_headers: {})
       # The Faraday connection object passed by the SDK user for making requests
       @connection = connection
 
+      # The Faraday adapter object passed by the SDK user for performing http requests
+      @adapter = adapter
+
       # The value to use for connection timeout
       @timeout = timeout
 
@@ -66,12 +70,13 @@ module Square
       @user_agent_detail = get_user_agent(user_agent_detail)
     end
 
-    def clone_with(connection: nil, timeout: nil, max_retries: nil,
-                   retry_interval: nil, backoff_factor: nil,
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
                    retry_statuses: nil, retry_methods: nil, environment: nil,
                    custom_url: nil, square_version: nil, access_token: nil,
                    user_agent_detail: nil, additional_headers: nil)
       connection ||= self.connection
+      adapter ||= self.adapter
       timeout ||= self.timeout
       max_retries ||= self.max_retries
       retry_interval ||= self.retry_interval
@@ -85,8 +90,8 @@ module Square
       user_agent_detail ||= self.user_agent_detail
       additional_headers ||= self.additional_headers
 
-      Configuration.new(connection: connection, timeout: timeout,
-                        max_retries: max_retries,
+      Configuration.new(connection: connection, adapter: adapter,
+                        timeout: timeout, max_retries: max_retries,
                         retry_interval: retry_interval,
                         backoff_factor: backoff_factor,
                         retry_statuses: retry_statuses,
@@ -102,7 +107,8 @@ module Square
                         retry_interval: retry_interval,
                         backoff_factor: backoff_factor,
                         retry_statuses: retry_statuses,
-                        retry_methods: retry_methods, connection: connection)
+                        retry_methods: retry_methods, connection: connection,
+                        adapter: adapter)
     end
 
     def get_user_agent(user_agent_detail)

data/lib/square/http/api_response.rb

@@ -18,16 +18,14 @@ module Square
       @request = http_response.request
       @errors = errors
 
-      if data.is_a? Hash
-        if data.keys.any?
-          @body = Struct.new(*data.keys) do
-            define_method(:to_s) { http_response.raw_body }
-          end.new(*data.values)
+      if (data.is_a? Hash) && data.keys.any?
+        @body = Struct.new(*data.keys) do
+          define_method(:to_s) { http_response.raw_body }
+        end.new(*data.values)
 
-          @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?
-        end
+        @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?
       else
         @data = data
         @body = data

data/lib/square/http/faraday_client.rb

@@ -13,12 +13,12 @@ module Square
     # The constructor.
     def initialize(timeout:, max_retries:, retry_interval:,
                    backoff_factor:, retry_statuses:, retry_methods:,
-                   connection: nil, cache: false, verify: true)
+                   connection:, adapter:, cache: false, verify: true)
       @connection = if connection.nil?
                       create_connection(timeout: timeout, max_retries: max_retries,
                                         retry_interval: retry_interval, backoff_factor: backoff_factor,
                                         retry_statuses: retry_statuses, retry_methods: retry_methods,
-                                        cache: cache, verify: verify)
+                                        adapter: adapter, cache: cache, verify: verify)
                     else
                       connection
                     end
@@ -27,7 +27,7 @@ module Square
     # Method to initialize connection.
     def create_connection(timeout:, max_retries:, retry_interval:,
                           backoff_factor:, retry_statuses:, retry_methods:,
-                          cache: false, verify: true)
+                          adapter:, cache: false, verify: true)
       Faraday.new do |faraday|
         faraday.use Faraday::HttpCache, serializer: Marshal if cache
         faraday.use Faraday::FollowRedirects::Middleware
@@ -43,7 +43,7 @@ module Square
                                 retry_if: proc { |env, _exc|
                                             env.request.context['forced_retry'] ||= false
                                           }
-        faraday.adapter Faraday.default_adapter
+        faraday.adapter adapter
         faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
         faraday.options[:timeout] = timeout if timeout.positive?
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 20.0.0.20220512
+  version: 20.1.0.20220616
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-12 00:00:00.000000000 Z
+date: 2022-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging