square.rb 20.1.0.20220616 → 21.0.0.20220720

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68c3c60d1b69c141d163be8e453c91bd76cca35f98228aeae4a41f7b61afe8a6
-  data.tar.gz: 3df6c78f8e6e493967624fca0cd804c1547aa6ccfb2b57daaac05695a33df12d
+  metadata.gz: b8c49dc5dec3f51ebfdb70e1789d9ffd0c1826b9f953c7a1e0fa59b62dae9d4f
+  data.tar.gz: b49dd9dbf71cdb0c1371dc0f5fb9505a26aaffe5c1905a366a3e46ecae5ea7fe
 SHA512:
-  metadata.gz: ab11afe945aa6630b158b07040290572d591b15e2d0829363dd334fc38f5197cc2d5eed47a36cf84e68061667d91b874486892da5acebb4f25420b8bec6e190b
-  data.tar.gz: 3427cb9920daac7363c982754ab7a5c8ef1abf609786e9c8b2bb4a6a4f82da77a2b05e9d7758d71c86613ef8dc54536ea44b9c9f9eed44576d90272121327b67
+  metadata.gz: bf2fcb52842fd5fc4f4b0cce1196a0276b882ec2d27d9a1d1eb6c717c0130eca6c52c0fda1d176bf4cc7f78f64b018162a58e484aa548534f58bf5738cee0e8d
+  data.tar.gz: d2efdfc7be2f8afde9906e01bc3b6dac865fd092f0394ea5ebe3e427101752251100ff409e8a9fff7b5c7d7af5d52278ec641289b90a52a8c6aa70715ce6c39c

data/lib/square/api/base_api.rb

@@ -20,6 +20,13 @@ module Square
       end
     end
 
+    def validate_parameters_types(args)
+      args.each do |_name, type|
+        key, val = type.first
+        APIHelper.validate_types(key, val) unless key.nil?
+      end
+    end
+
     def execute_request(request, binary: false)
       @http_call_back&.on_before_request(request)
 
@@ -38,7 +45,7 @@ module Square
     end
 
     def get_user_agent
-      user_agent = 'Square-Ruby-SDK/20.1.0.20220616 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      user_agent = 'Square-Ruby-SDK/21.0.0.20220720 ({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/bookings_api.rb

@@ -178,9 +178,9 @@ module Square
     end
 
     # Lists booking profiles for team members.
-    # @param [Boolean] bookable_only Optional parameter: Indicates whether to
-    # include only bookable team members in the returned result (`true`) or not
-    # (`false`).
+    # @param [TrueClass|FalseClass] bookable_only Optional parameter: Indicates
+    # whether to include only bookable team members in the returned result
+    # (`true`) or not (`false`).
     # @param [Integer] limit Optional parameter: The maximum number of results
     # to return in a paged response.
     # @param [String] cursor Optional parameter: The pagination cursor from the

data/lib/square/api/cards_api.rb

@@ -15,8 +15,9 @@ module Square
     # @param [String] customer_id Optional parameter: Limit results to cards
     # associated with the customer supplied. By default, all cards owned by the
     # merchant are returned.
-    # @param [Boolean] include_disabled Optional parameter: Includes disabled
-    # cards. By default, all enabled cards owned by the merchant are returned.
+    # @param [TrueClass|FalseClass] include_disabled Optional parameter:
+    # Includes disabled cards. By default, all enabled cards owned by the
+    # merchant are returned.
     # @param [String] reference_id Optional parameter: Limit results to cards
     # associated with the reference_id supplied.
     # @param [SortOrder] sort_order Optional parameter: Sorts the returned list

data/lib/square/api/catalog_api.rb

@@ -319,8 +319,8 @@ module Square
     # 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
+    # @param [Integer] 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
     # matched against the [CatalogObject]($m/CatalogObject)s' `version`
     # attribute.  If not included, results will be from the current version of
@@ -448,26 +448,26 @@ module Square
     # any [CatalogTax]($m/CatalogTax) objects that apply to it.
     # @param [String] object_id Required parameter: The object ID of any type of
     # catalog objects to be retrieved.
-    # @param [Boolean] include_related_objects Optional parameter: If `true`,
-    # the response will include additional objects that are related to the
-    # requested objects. Related objects are defined as any objects referenced
-    # by ID by the results in the `objects` field of the response. These objects
-    # are put in the `related_objects` field. Setting this to `true` is helpful
-    # when the objects are needed for immediate display to a user. This process
-    # only goes one level deep. Objects referenced by the related objects will
-    # not be included. For example,  if the `objects` field of the response
-    # contains a CatalogItem, its associated CatalogCategory objects, CatalogTax
-    # objects, CatalogImage objects and CatalogModifierLists will be returned in
-    # the `related_objects` field of the response. If the `objects` field of the
-    # response contains a CatalogItemVariation, its parent CatalogItem will be
-    # returned in the `related_objects` field of the response.  Default value:
-    # `false`
-    # @param [Long] catalog_version Optional parameter: Requests objects as of a
-    # specific version of the catalog. This allows you to retrieve historical
-    # versions of objects. The value to retrieve a specific version of an object
-    # can be found in the version field of [CatalogObject]($m/CatalogObject)s.
-    # If not included, results will be from the current version of the
-    # catalog.
+    # @param [TrueClass|FalseClass] include_related_objects Optional parameter:
+    # If `true`, the response will include additional objects that are related
+    # to the requested objects. Related objects are defined as any objects
+    # referenced by ID by the results in the `objects` field of the response.
+    # These objects are put in the `related_objects` field. Setting this to
+    # `true` is helpful when the objects are needed for immediate display to a
+    # user. This process only goes one level deep. Objects referenced by the
+    # related objects will not be included. For example,  if the `objects` field
+    # of the response contains a CatalogItem, its associated CatalogCategory
+    # objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists
+    # will be returned in the `related_objects` field of the response. If the
+    # `objects` field of the response contains a CatalogItemVariation, its
+    # parent CatalogItem will be returned in the `related_objects` field of the
+    # response.  Default value: `false`
+    # @param [Integer] catalog_version Optional parameter: Requests objects as
+    # of a specific version of the catalog. This allows you to retrieve
+    # historical versions of objects. The value to retrieve a specific version
+    # of an object can be found in the version field of
+    # [CatalogObject]($m/CatalogObject)s. If not included, results will be from
+    # the current version of the catalog.
     # @return [RetrieveCatalogObjectResponse Hash] response from the API call
     def retrieve_catalog_object(object_id:,
                                 include_related_objects: false,

data/lib/square/api/customer_custom_attributes_api.rb

@@ -323,12 +323,12 @@ module Square
     # more information, see
     # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
     # atterns/pagination).
-    # @param [Boolean] with_definitions Optional parameter: Indicates whether to
-    # return the [custom attribute definition]($m/CustomAttributeDefinition) in
-    # the `definition` field of each custom attribute. Set this parameter to
-    # `true` to get the name and description of each custom attribute,
-    # information about the data type, or other definition details. The default
-    # value is `false`.
+    # @param [TrueClass|FalseClass] with_definitions Optional parameter:
+    # Indicates whether to return the [custom attribute
+    # definition]($m/CustomAttributeDefinition) in the `definition` field of
+    # each custom attribute. Set this parameter to `true` to get the name and
+    # description of each custom attribute, information about the data type, or
+    # other definition details. The default value is `false`.
     # @return [ListCustomerCustomAttributesResponse Hash] response from the API call
     def list_customer_custom_attributes(customer_id:,
                                         limit: nil,
@@ -427,12 +427,12 @@ module Square
     # retrieve. This key must match the `key` of a custom attribute definition
     # in the Square seller account. If the requesting application is not the
     # definition owner, you must use the qualified key.
-    # @param [Boolean] with_definition Optional parameter: Indicates whether to
-    # return the [custom attribute definition]($m/CustomAttributeDefinition) in
-    # the `definition` field of the custom attribute. Set this parameter to
-    # `true` to get the name and description of the custom attribute,
-    # information about the data type, or other definition details. The default
-    # value is `false`.
+    # @param [TrueClass|FalseClass] with_definition Optional parameter:
+    # Indicates whether to return the [custom attribute
+    # definition]($m/CustomAttributeDefinition) in the `definition` field of the
+    # custom attribute. Set this parameter to `true` to get the name and
+    # description of the custom attribute, information about the data type, or
+    # other definition details. The default value is `false`.
     # @param [Integer] version Optional parameter: The current version of the
     # custom attribute, which is used for strongly consistent reads to guarantee
     # that you receive the most up-to-date data. When included in the request,

data/lib/square/api/customers_api.rb

@@ -165,7 +165,7 @@ module Square
     # profiles, you must use the ID of the newly created profile.
     # @param [String] customer_id Required parameter: The ID of the customer to
     # delete.
-    # @param [Long] version Optional parameter: The current version of the
+    # @param [Integer] version Optional parameter: The current version of the
     # customer profile.  As a best practice, you should include this parameter
     # to enable [optimistic
     # concurrency](https://developer.squareup.com/docs/build-basics/common-api-p

data/lib/square/api/orders_api.rb

@@ -244,8 +244,8 @@ module Square
     # - The `order_id` in the endpoint path, identifying the order to update.
     # - The latest `version` of the order to update.
     # - The [sparse
-    # order](https://developer.squareup.com/docs/orders-api/manage-orders#sparse
-    # -order-objects)
+    # order](https://developer.squareup.com/docs/orders-api/manage-orders/update
+    # -orders#sparse-order-objects)
     # containing only the fields to update and the version to which the update
     # is
     # being applied.

data/lib/square/api/payments_api.rb

@@ -26,7 +26,7 @@ module Square
     # @param [String] location_id Optional parameter: Limit results to the
     # location supplied. By default, results are returned for the default (main)
     # location associated with the seller.
-    # @param [Long] total Optional parameter: The exact amount in the
+    # @param [Integer] total Optional parameter: The exact amount in the
     # `total_money` for a payment.
     # @param [String] last_4 Optional parameter: The last four digits of a
     # payment card.

data/lib/square/api/v1_transactions_api.rb

@@ -175,10 +175,10 @@ module Square
     # @param [String] batch_token Optional parameter: A pagination cursor to
     # retrieve the next set of results for your original query to the
     # endpoint.
-    # @param [Boolean] include_partial Optional parameter: Indicates whether or
-    # not to include partial payments in the response. Partial payments will
-    # have the tenders collected so far, but the itemizations will be empty
-    # until the payment is completed.
+    # @param [TrueClass|FalseClass] include_partial Optional parameter:
+    # Indicates whether or not to include partial payments in the response.
+    # Partial payments will have the tenders collected so far, but the
+    # itemizations will be empty until the payment is completed.
     # @return [List of V1Payment Hash] response from the API call
     def list_payments(location_id:,
                       order: nil,

data/lib/square/api_helper.rb

@@ -130,6 +130,12 @@ module Square
       raise TypeError, 'Server responded with invalid JSON.'
     end
 
+    # Parses JSON string.
+    # @param [object] The object to serialize.
+    def self.json_serialize(obj)
+      serializable_types.map { |x| obj.is_a? x }.any? ? obj.to_s : obj.to_json
+    end
+
     # Removes elements with empty values from a hash.
     # @param [Hash] The hash to clean.
     def self.clean_hash(hash)
@@ -199,9 +205,6 @@ module Square
     def self.form_encode(obj, instance_name, formatting: 'indexed')
       retval = {}
 
-      serializable_types = [String, Numeric, TrueClass,
-                            FalseClass, Date, DateTime]
-
       # Create a form encoded hash for this object.
       if obj.nil?
         nil
@@ -210,7 +213,7 @@ module Square
           obj.each_with_index do |value, index|
             retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{index}]"))
           end
-        elsif serializable_types.map { |x| obj[0].is_a? x }.any?
+        elsif APIHelper.serializable_types.map { |x| obj[0].is_a? x }.any?
           obj.each do |value|
             abc = if formatting == 'unindexed'
                     APIHelper.form_encode(value, "#{instance_name}[]",
@@ -265,5 +268,174 @@ module Square
       end
       val
     end
+
+    # Deserialize the value against the template (group of types).
+    # @param [String] The value to be deserialized.
+    # @param [String] The parameter indicates the type-combination
+    # against which the value will be mapped (oneOf(Integer, String)).
+    def self.deserialize(template, value)
+      decoded = APIHelper.json_deserialize(value)
+      map_types(decoded, template)
+    end
+
+    # Validates and processes the value against the template(group of types).
+    # @param [String] The value to be mapped against the template.
+    # @param [String] The parameter indicates the group of types (oneOf(Integer, String)).
+    # @param [String] The parameter indicates the group (oneOf|anyOf).
+    def self.map_types(value, template, group_name: nil)
+      result_value = nil
+      matches = 0
+      types = []
+      group_name = template.partition('(').first if group_name.nil? && template.match?(/anyOf|oneOf/)
+
+      return if value.nil?
+
+      if template.end_with?('{}') || template.end_with?('[]')
+        types = template.split(group_name, 2).last.gsub(/\s+/, '').split
+      else
+        template = template.split(group_name, 2).last.delete_prefix('(').delete_suffix(')')
+        types = template.scan(/(anyOf|oneOf)[(]([^[)]]*)[)]/).flatten.combination(2).map { |a, b| "#{a}(#{b})" }
+        types.each { |t| template = template.gsub(", #{t}", '') }
+        types = template.gsub(/\s+/, '').split(',').push(*types)
+      end
+      types.each do |element|
+        if element.match?(/^(oneOf|anyOf)[(].*$/)
+          begin
+            result_value = map_types(value, element, matches)
+            matches += 1
+          rescue ValidationException
+            next
+          end
+        elsif element.end_with?('{}')
+          result_value, matches = map_hash_type(value, element, group_name, matches)
+        elsif element.end_with?('[]')
+          result_value, matches = map_array_type(value, element, group_name, matches)
+        else
+          begin
+            result_value, matches = map_type(value, element, group_name, matches)
+          rescue StandardError
+            next
+          end
+        end
+        break if group_name == 'anyOf' && matches == 1
+      end
+      raise ValidationException.new(value, template) unless matches == 1
+
+      value = result_value unless result_value.nil?
+      value
+    end
+
+    # Validates and processes the value against the [Hash] type.
+    # @param [String] The value to be mapped against the type.
+    # @param [String] The possible type of the value.
+    # @param [String] The parameter indicates the group (oneOf|anyOf).
+    # @param [Integer] The parameter indicates the number of matches of value against types.
+    def self.map_hash_type(value, type, group_name, matches)
+      if value.instance_of? Hash
+        decoded = {}
+        value.each do |key, val|
+          type = type.chomp('{}').to_s
+          val = map_types(val, type, group_name: group_name)
+          decoded[key] = val unless type.empty?
+        rescue ValidationException
+          next
+        end
+        matches += 1 if decoded.length == value.length
+        value = decoded unless decoded.empty?
+      end
+      [value, matches]
+    end
+
+    # Validates and processes the value against the [Array] type.
+    # @param [String] The value to be mapped against the type.
+    # @param [String] The possible type of the value.
+    # @param [String] The parameter indicates the group (oneOf|anyOf).
+    # @param [Integer] The parameter indicates the number of matches of value against types.
+    def self.map_array_type(value, type, group_name, matches)
+      if value.instance_of? Array
+        decoded = []
+        value.each do |val|
+          type = type.chomp('[]').to_s
+          val = map_types(val, type, group_name: group_name)
+          decoded.append(val) unless type.empty?
+        rescue ValidationException
+          next
+        end
+        matches += 1 if decoded.length == value.length
+        value = decoded unless decoded.empty?
+      end
+      [value, matches]
+    end
+
+    # Validates and processes the value against the type.
+    # @param [String] The value to be mapped against the type.
+    # @param [String] The possible type of the value.
+    # @param [String] The parameter indicates the group (oneOf|anyOf).
+    # @param [Integer] The parameter indicates the number of matches of value against types.
+    def self.map_type(value, type, _group_name, matches)
+      if Square.constants.select do |c|
+        Square.const_get(c).to_s == "Square::#{type}"
+      end.empty?
+        value, matches = map_data_type(value, type, matches)
+      else
+        value, matches = map_complex_type(value, type, matches)
+      end
+      [value, matches]
+    end
+
+    # Validates and processes the value against the complex types.
+    # @param [String] The value to be mapped against the type.
+    # @param [String] The possible type of the value.
+    # @param [Integer] The parameter indicates the number of matches of value against types.
+    def self.map_complex_type(value, type, matches)
+      obj = Square.const_get(type)
+      value = if obj.respond_to? 'from_hash'
+                obj.send('from_hash', value)
+              else
+                obj.constants.find { |k| obj.const_get(k) == value }
+              end
+      matches += 1 unless value.nil?
+      [value, matches]
+    end
+
+    # Validates and processes the value against the data types.
+    # @param [String] The value to be mapped against the type.
+    # @param [String] The possible type of the value.
+    # @param [Integer] The parameter indicates the number of matches of value against types.
+    def self.map_data_type(value, element, matches)
+      element = element.split('|').map { |x| Object.const_get x }
+      matches += 1 if element.all? { |x| APIHelper.data_types.include?(x) } &&
+                      element.any? { |x| (value.instance_of? x) || (value.class.ancestors.include? x) }
+      [value, matches]
+    end
+
+    # Validates the value against the template(group of types).
+    # @param [String] The value to be mapped against the type.
+    # @param [String] The parameter indicates the group of types (oneOf(Integer, String)).
+    def self.validate_types(value, template)
+      map_types(APIHelper.json_deserialize(value.to_json), template)
+    end
+
+    # Get content-type depending on the value
+    def self.get_content_type(value)
+      if serializable_types.map { |x| value.is_a? x }.any?
+        'text/plain; charset=utf-8'
+      else
+        'application/json; charset=utf-8'
+      end
+    end
+
+    # Array of serializable types
+    def self.serializable_types
+      [String, Numeric, TrueClass,
+       FalseClass, Date, DateTime]
+    end
+
+    # Array of supported data types
+    def self.data_types
+      [String, Float, Integer,
+       TrueClass, FalseClass, Date,
+       DateTime, Array, Hash, Object]
+    end
   end
 end

data/lib/square/client.rb

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

data/lib/square/configuration.rb

@@ -15,13 +15,12 @@ module Square
       attr_reader :environments
     end
 
-    def initialize(connection: nil, adapter: Faraday.default_adapter,
-                   timeout: 60, max_retries: 0, retry_interval: 1,
-                   backoff_factor: 2,
+    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], environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2022-06-16', access_token: '',
+                   square_version: '2022-07-20', access_token: '',
                    user_agent_detail: '', additional_headers: {})
       # The Faraday connection object passed by the SDK user for making requests
       @connection = connection

data/lib/square/exceptions/validation_exception.rb

@@ -0,0 +1,13 @@
+module Square
+  # Class for exceptions when there is a schema validation error.
+  class ValidationException < StandardError
+    attr_reader :reason
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    def initialize(value, template)
+      @reason = "The value #{value} provided doesn't validate against the schema #{template}"
+      super(reason)
+    end
+  end
+end

data/lib/square/http/faraday_client.rb

@@ -3,6 +3,7 @@ require 'faraday/retry'
 require 'faraday/multipart'
 require 'faraday/follow_redirects'
 require 'faraday/gzip'
+require 'faraday/net_http_persistent'
 
 module Square
   # An implementation of HttpClient.

data/lib/square.rb

@@ -25,6 +25,7 @@ require_relative 'square/http/auth/o_auth2'
 
 # Exceptions
 require_relative 'square/exceptions/api_exception'
+require_relative 'square/exceptions/validation_exception'
 
 require_relative 'square/configuration'
 

data/test/test_helper.rb

@@ -49,7 +49,7 @@ class TestHelper
         end
       end
     elsif expected_body.instance_of? Array
-      return False unless received_body.instance_of? Array
+      return false unless received_body.instance_of? Array
       if check_count == true && (expected_body.length != received_body.length)
         return false
       else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 20.1.0.20220616
+  version: 21.0.0.20220720
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-16 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -100,6 +100,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http_persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: certifi
   requirement: !ruby/object:Gem::Requirement
@@ -219,6 +233,7 @@ files:
 - lib/square/client.rb
 - lib/square/configuration.rb
 - lib/square/exceptions/api_exception.rb
+- lib/square/exceptions/validation_exception.rb
 - lib/square/http/api_response.rb
 - lib/square/http/auth/o_auth2.rb
 - lib/square/http/faraday_client.rb