square_connect 2.1.1.106 → 2.2.0.110

data/lib/square_connect/models/order_line_item.rb

@@ -12,18 +12,27 @@ require 'date'
 module SquareConnect
   # Represents a line item in an order. Each line item describes a different product to purchase, with its own quantity and price details.
   class OrderLineItem
-    # The line item's ID, unique only within this order.
-    attr_accessor :id
-
     # The name of the line item.
     attr_accessor :name
 
     # The quantity of the product to purchase. Currently, this string must have an integer value.
     attr_accessor :quantity
 
-    # The base price for a single unit of the line item's associated variation.  If a line item represents a Custom Amount instead of a particular product, this field indicates that amount.
+    # The taxes applied to this line item.
+    attr_accessor :taxes
+
+    # The discounts applied to this line item.
+    attr_accessor :discounts
+
+    # The base price for a single unit of the line item.
     attr_accessor :base_price_money
 
+    # The total tax amount of money to collect for the line item.
+    attr_accessor :total_tax_money
+
+    # The total discount amount of money to collect for the line item.
+    attr_accessor :total_discount_money
+
     # The total amount of money to collect for this line item.
     attr_accessor :total_money
 
@@ -31,10 +40,13 @@ module SquareConnect
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
         :'name' => :'name',
         :'quantity' => :'quantity',
+        :'taxes' => :'taxes',
+        :'discounts' => :'discounts',
         :'base_price_money' => :'base_price_money',
+        :'total_tax_money' => :'total_tax_money',
+        :'total_discount_money' => :'total_discount_money',
         :'total_money' => :'total_money'
       }
     end
@@ -42,10 +54,13 @@ module SquareConnect
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'id' => :'String',
         :'name' => :'String',
         :'quantity' => :'String',
+        :'taxes' => :'Array<OrderLineItemTax>',
+        :'discounts' => :'Array<OrderLineItemDiscount>',
         :'base_price_money' => :'Money',
+        :'total_tax_money' => :'Money',
+        :'total_discount_money' => :'Money',
         :'total_money' => :'Money'
       }
     end
@@ -58,10 +73,6 @@ module SquareConnect
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes.has_key?(:'id')
-        self.id = attributes[:'id']
-      end
-
       if attributes.has_key?(:'name')
         self.name = attributes[:'name']
       end
@@ -70,10 +81,30 @@ module SquareConnect
         self.quantity = attributes[:'quantity']
       end
 
+      if attributes.has_key?(:'taxes')
+        if (value = attributes[:'taxes']).is_a?(Array)
+          self.taxes = value
+        end
+      end
+
+      if attributes.has_key?(:'discounts')
+        if (value = attributes[:'discounts']).is_a?(Array)
+          self.discounts = value
+        end
+      end
+
       if attributes.has_key?(:'base_price_money')
         self.base_price_money = attributes[:'base_price_money']
       end
 
+      if attributes.has_key?(:'total_tax_money')
+        self.total_tax_money = attributes[:'total_tax_money']
+      end
+
+      if attributes.has_key?(:'total_discount_money')
+        self.total_discount_money = attributes[:'total_discount_money']
+      end
+
       if attributes.has_key?(:'total_money')
         self.total_money = attributes[:'total_money']
       end
@@ -98,10 +129,13 @@ module SquareConnect
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
           name == o.name &&
           quantity == o.quantity &&
+          taxes == o.taxes &&
+          discounts == o.discounts &&
           base_price_money == o.base_price_money &&
+          total_tax_money == o.total_tax_money &&
+          total_discount_money == o.total_discount_money &&
           total_money == o.total_money
     end
 
@@ -114,7 +148,7 @@ module SquareConnect
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, quantity, base_price_money, total_money].hash
+      [name, quantity, taxes, discounts, base_price_money, total_tax_money, total_discount_money, total_money].hash
     end
 
     # Builds the object from hash

data/lib/square_connect/models/order_line_item_discount.rb

@@ -0,0 +1,281 @@
+=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
+  # Represents a discount that applies to one or more line items in an order.  Fixed-amount, order-level discounts are distributed across all non-zero line item totals. The amount distributed to each line item is relative to that item’s contribution to the order subtotal.
+  class OrderLineItemDiscount
+    # The discount's name.
+    attr_accessor :name
+
+    # The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`.  VARIABLE_* is not supported in API because the order is created at the time of sale and either percentage or amount has to be specified.  See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values.
+    attr_accessor :type
+
+    # The percentage of the tax, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%.  The percentage won't be set for an amount-based discount.
+    attr_accessor :percentage
+
+    # The total monetary amount of the applicable discount. If it is at order level, it is the value of the order level discount. If it is at line item level, it is the value of the line item level discount.  The amount_money won't be set for a percentage-based discount.
+    attr_accessor :amount_money
+
+    # The amount of discount actually applied to this line item.  Represents the amount of money applied to a line item as a discount When an amount-based discount is at order-level, this value is different from `amount_money` because the discount is distributed across the line items.
+    attr_accessor :applied_money
+
+    # Indicates the level at which the discount applies. See [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for possible values.
+    attr_accessor :scope
+
+    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',
+        :'type' => :'type',
+        :'percentage' => :'percentage',
+        :'amount_money' => :'amount_money',
+        :'applied_money' => :'applied_money',
+        :'scope' => :'scope'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'name' => :'String',
+        :'type' => :'String',
+        :'percentage' => :'String',
+        :'amount_money' => :'Money',
+        :'applied_money' => :'Money',
+        :'scope' => :'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?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.has_key?(:'percentage')
+        self.percentage = attributes[:'percentage']
+      end
+
+      if attributes.has_key?(:'amount_money')
+        self.amount_money = attributes[:'amount_money']
+      end
+
+      if attributes.has_key?(:'applied_money')
+        self.applied_money = attributes[:'applied_money']
+      end
+
+      if attributes.has_key?(:'scope')
+        self.scope = attributes[:'scope']
+      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", "FIXED_PERCENTAGE", "FIXED_AMOUNT", "VARIABLE_PERCENTAGE", "VARIABLE_AMOUNT"])
+      return false unless type_validator.valid?(@type)
+      scope_validator = EnumAttributeValidator.new('String', ["LINE_ITEM", "ORDER"])
+      return false unless scope_validator.valid?(@scope)
+      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", "FIXED_PERCENTAGE", "FIXED_AMOUNT", "VARIABLE_PERCENTAGE", "VARIABLE_AMOUNT"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] scope Object to be assigned
+    def scope=(scope)
+      validator = EnumAttributeValidator.new('String', ["LINE_ITEM", "ORDER"])
+      unless validator.valid?(scope)
+        fail ArgumentError, "invalid value for 'scope', must be one of #{validator.allowable_values}."
+      end
+      @scope = scope
+    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 &&
+          type == o.type &&
+          percentage == o.percentage &&
+          amount_money == o.amount_money &&
+          applied_money == o.applied_money &&
+          scope == o.scope
+    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, type, percentage, amount_money, applied_money, scope].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

data/lib/square_connect/models/order_line_item_discount_scope.rb

@@ -0,0 +1,19 @@
+=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 OrderLineItemDiscountScope
+    
+    LINE_ITEM = "LINE_ITEM".freeze
+    ORDER = "ORDER".freeze
+  end
+
+end

data/lib/square_connect/models/order_line_item_discount_type.rb

@@ -0,0 +1,22 @@
+=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 OrderLineItemDiscountType
+    
+    UNKNOWN = "UNKNOWN".freeze
+    FIXED_PERCENTAGE = "FIXED_PERCENTAGE".freeze
+    FIXED_AMOUNT = "FIXED_AMOUNT".freeze
+    VARIABLE_PERCENTAGE = "VARIABLE_PERCENTAGE".freeze
+    VARIABLE_AMOUNT = "VARIABLE_AMOUNT".freeze
+  end
+
+end