square_connect 2.7.0.202 → 2.8.0.208

data/lib/square_connect/models/order_line_item.rb

@@ -178,8 +178,8 @@ module SquareConnect
         invalid_properties.push("invalid value for 'quantity', the character length must be great than or equal to 1.")
       end
 
-      if !@note.nil? && @note.to_s.length > 50
-        invalid_properties.push("invalid value for 'note', the character length must be smaller than or equal to 50.")
+      if !@note.nil? && @note.to_s.length > 500
+        invalid_properties.push("invalid value for 'note', the character length must be smaller than or equal to 500.")
       end
 
       if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192
@@ -200,7 +200,7 @@ module SquareConnect
       return false if @quantity.nil?
       return false if @quantity.to_s.length > 5
       return false if @quantity.to_s.length < 1
-      return false if !@note.nil? && @note.to_s.length > 50
+      return false if !@note.nil? && @note.to_s.length > 500
       return false if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192
       return false if !@variation_name.nil? && @variation_name.to_s.length > 255
       return true
@@ -239,8 +239,8 @@ module SquareConnect
     # @param [Object] note Value to be assigned
     def note=(note)
 
-      if !note.nil? && note.to_s.length > 50
-        fail ArgumentError, "invalid value for 'note', the character length must be smaller than or equal to 50."
+      if !note.nil? && note.to_s.length > 500
+        fail ArgumentError, "invalid value for 'note', the character length must be smaller than or equal to 500."
       end
 
       @note = note

data/lib/square_connect/models/order_line_item_modifier.rb

@@ -18,7 +18,7 @@ module SquareConnect
     # The name of the item modifier.
     attr_accessor :name
 
-    # The base price of the item modifier.
+    # The base price for the modifier.  `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined [CatalogModifier](#type-catalogmodifier) price.
     attr_accessor :base_price_money
 
     # The total price of the item modifier for its line item. This is the modifier's base_price_money multiplied by the line item's quantity.

data/lib/square_connect/models/v1_item.rb

@@ -54,6 +54,12 @@ module SquareConnect
     # Deprecated. This field is not used.
     attr_accessor :taxable
 
+    # The ID of the item's category, if any.
+    attr_accessor :category_id
+
+    # If true, the item can be added to pickup orders from the merchant's online store. Default value: false
+    attr_accessor :available_for_pickup
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -92,7 +98,9 @@ module SquareConnect
         :'variations' => :'variations',
         :'modifier_lists' => :'modifier_lists',
         :'fees' => :'fees',
-        :'taxable' => :'taxable'
+        :'taxable' => :'taxable',
+        :'category_id' => :'category_id',
+        :'available_for_pickup' => :'available_for_pickup'
       }
     end
 
@@ -112,7 +120,9 @@ module SquareConnect
         :'variations' => :'Array<V1Variation>',
         :'modifier_lists' => :'Array<V1Variation>',
         :'fees' => :'Array<V1Fee>',
-        :'taxable' => :'BOOLEAN'
+        :'taxable' => :'BOOLEAN',
+        :'category_id' => :'String',
+        :'available_for_pickup' => :'BOOLEAN'
       }
     end
 
@@ -186,6 +196,14 @@ module SquareConnect
         self.taxable = attributes[:'taxable']
       end
 
+      if attributes.has_key?(:'category_id')
+        self.category_id = attributes[:'category_id']
+      end
+
+      if attributes.has_key?(:'available_for_pickup')
+        self.available_for_pickup = attributes[:'available_for_pickup']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -255,7 +273,9 @@ module SquareConnect
           variations == o.variations &&
           modifier_lists == o.modifier_lists &&
           fees == o.fees &&
-          taxable == o.taxable
+          taxable == o.taxable &&
+          category_id == o.category_id &&
+          available_for_pickup == o.available_for_pickup
     end
 
     # @see the `==` method
@@ -267,7 +287,7 @@ module SquareConnect
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, description, type, color, abbreviation, visibility, available_online, master_image, category, variations, modifier_lists, fees, taxable].hash
+      [id, name, description, type, color, abbreviation, visibility, available_online, master_image, category, variations, modifier_lists, fees, taxable, category_id, available_for_pickup].hash
     end
 
     # Builds the object from hash

data/lib/square_connect/models/v1_page.rb

@@ -18,7 +18,7 @@ module SquareConnect
     # The page's name, if any.
     attr_accessor :name
 
-    # The page's position in the merchant's list of pages. Always an integer between 0 and 4, inclusive.
+    # The page's position in the merchant's list of pages. Always an integer between 0 and 6, inclusive.
     attr_accessor :page_index
 
     # The cells included on the page.
@@ -77,15 +77,40 @@ module SquareConnect
     # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@page_index.nil? && @page_index > 6
+        invalid_properties.push("invalid value for 'page_index', must be smaller than or equal to 6.")
+      end
+
+      if !@page_index.nil? && @page_index < 0
+        invalid_properties.push("invalid value for 'page_index', must be greater than or equal to 0.")
+      end
+
       return invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if !@page_index.nil? && @page_index > 6
+      return false if !@page_index.nil? && @page_index < 0
       return true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] page_index Value to be assigned
+    def page_index=(page_index)
+
+      if !page_index.nil? && page_index > 6
+        fail ArgumentError, "invalid value for 'page_index', must be smaller than or equal to 6."
+      end
+
+      if !page_index.nil? && page_index < 0
+        fail ArgumentError, "invalid value for 'page_index', must be greater than or equal to 0."
+      end
+
+      @page_index = page_index
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/square_connect/models/v1_payment.rb

@@ -84,6 +84,12 @@ module SquareConnect
     # The items purchased in the payment.
     attr_accessor :itemizations
 
+    # The total of all surcharges applied to the payment.
+    attr_accessor :surcharge_money
+
+    # A list of all surcharges associated with the payment.
+    attr_accessor :surcharges
+
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -111,7 +117,9 @@ module SquareConnect
         :'additive_tax' => :'additive_tax',
         :'tender' => :'tender',
         :'refunds' => :'refunds',
-        :'itemizations' => :'itemizations'
+        :'itemizations' => :'itemizations',
+        :'surcharge_money' => :'surcharge_money',
+        :'surcharges' => :'surcharges'
       }
     end
 
@@ -141,7 +149,9 @@ module SquareConnect
         :'additive_tax' => :'Array<V1PaymentTax>',
         :'tender' => :'Array<V1Tender>',
         :'refunds' => :'Array<V1Refund>',
-        :'itemizations' => :'Array<V1PaymentItemization>'
+        :'itemizations' => :'Array<V1PaymentItemization>',
+        :'surcharge_money' => :'V1Money',
+        :'surcharges' => :'Array<V1PaymentSurcharge>'
       }
     end
 
@@ -259,6 +269,16 @@ module SquareConnect
         end
       end
 
+      if attributes.has_key?(:'surcharge_money')
+        self.surcharge_money = attributes[:'surcharge_money']
+      end
+
+      if attributes.has_key?(:'surcharges')
+        if (value = attributes[:'surcharges']).is_a?(Array)
+          self.surcharges = value
+        end
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -302,7 +322,9 @@ module SquareConnect
           additive_tax == o.additive_tax &&
           tender == o.tender &&
           refunds == o.refunds &&
-          itemizations == o.itemizations
+          itemizations == o.itemizations &&
+          surcharge_money == o.surcharge_money &&
+          surcharges == o.surcharges
     end
 
     # @see the `==` method
@@ -314,7 +336,7 @@ module SquareConnect
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, merchant_id, created_at, creator_id, device, payment_url, receipt_url, inclusive_tax_money, additive_tax_money, tax_money, tip_money, discount_money, total_collected_money, processing_fee_money, net_total_money, refunded_money, swedish_rounding_money, gross_sales_money, net_sales_money, inclusive_tax, additive_tax, tender, refunds, itemizations].hash
+      [id, merchant_id, created_at, creator_id, device, payment_url, receipt_url, inclusive_tax_money, additive_tax_money, tax_money, tip_money, discount_money, total_collected_money, processing_fee_money, net_total_money, refunded_money, swedish_rounding_money, gross_sales_money, net_sales_money, inclusive_tax, additive_tax, tender, refunds, itemizations, surcharge_money, surcharges].hash
     end
 
     # Builds the object from hash

data/lib/square_connect/models/v1_payment_surcharge.rb

@@ -0,0 +1,290 @@
+=begin
+#Square Connect API
+
+OpenAPI spec version: 2.0
+Contact: developers@squareup.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module SquareConnect
+
+  class V1PaymentSurcharge
+    # The name of the surcharge.
+    attr_accessor :name
+
+    # The amount of money applied to the order as a result of the surcharge.
+    attr_accessor :applied_money
+
+    # The amount of the surcharge as a percentage. The percentage is provided as a string representing the decimal equivalent of the percentage. For example, \"0.7\" corresponds to a 7% surcharge. Exactly one of rate or amount_money should be set.
+    attr_accessor :rate
+
+    # The amount of the surcharge as a Money object. Exactly one of rate or amount_money should be set.
+    attr_accessor :amount_money
+
+    # Indicates the source of the surcharge. For example, if it was applied as an automatic gratuity for a large group.
+    attr_accessor :type
+
+    # Indicates whether the surcharge is taxable.
+    attr_accessor :taxable
+
+    # The list of taxes that should be applied to the surcharge.
+    attr_accessor :taxes
+
+    attr_accessor :surcharge_id
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'applied_money' => :'applied_money',
+        :'rate' => :'rate',
+        :'amount_money' => :'amount_money',
+        :'type' => :'type',
+        :'taxable' => :'taxable',
+        :'taxes' => :'taxes',
+        :'surcharge_id' => :'surcharge_id'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'name' => :'String',
+        :'applied_money' => :'V1Money',
+        :'rate' => :'String',
+        :'amount_money' => :'V1Money',
+        :'type' => :'String',
+        :'taxable' => :'BOOLEAN',
+        :'taxes' => :'Array<V1PaymentTax>',
+        :'surcharge_id' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'applied_money')
+        self.applied_money = attributes[:'applied_money']
+      end
+
+      if attributes.has_key?(:'rate')
+        self.rate = attributes[:'rate']
+      end
+
+      if attributes.has_key?(:'amount_money')
+        self.amount_money = attributes[:'amount_money']
+      end
+
+      if attributes.has_key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.has_key?(:'taxable')
+        self.taxable = attributes[:'taxable']
+      end
+
+      if attributes.has_key?(:'taxes')
+        if (value = attributes[:'taxes']).is_a?(Array)
+          self.taxes = value
+        end
+      end
+
+      if attributes.has_key?(:'surcharge_id')
+        self.surcharge_id = attributes[:'surcharge_id']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      type_validator = EnumAttributeValidator.new('String', ["UNKNOWN", "AUTO_GRATUITY", "CUSTOM"])
+      return false unless type_validator.valid?(@type)
+      return true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["UNKNOWN", "AUTO_GRATUITY", "CUSTOM"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          name == o.name &&
+          applied_money == o.applied_money &&
+          rate == o.rate &&
+          amount_money == o.amount_money &&
+          type == o.type &&
+          taxable == o.taxable &&
+          taxes == o.taxes &&
+          surcharge_id == o.surcharge_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [name, applied_money, rate, amount_money, type, taxable, taxes, surcharge_id].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = SquareConnect.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end