class SquareConnect::OrderLineItemModifier

A [CatalogModifier](type-catalogmodifier).

Attributes

base_price_money[RW]

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.

catalog_object_id[RW]

The catalog object id referencing [CatalogModifier](type-catalogmodifier).

name[RW]

The name of the item modifier.

total_price_money[RW]

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.

uid[RW]

Unique ID that identifies the modifier only within this order. This field is read-only.

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/square_connect/models/order_line_item_modifier.rb, line 32
def self.attribute_map
  {
    :'uid' => :'uid',
    :'catalog_object_id' => :'catalog_object_id',
    :'name' => :'name',
    :'base_price_money' => :'base_price_money',
    :'total_price_money' => :'total_price_money'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/square_connect/models/order_line_item_modifier.rb, line 55
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?(:'uid')
    self.uid = attributes[:'uid']
  end

  if attributes.has_key?(:'catalog_object_id')
    self.catalog_object_id = attributes[:'catalog_object_id']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'base_price_money')
    self.base_price_money = attributes[:'base_price_money']
  end

  if attributes.has_key?(:'total_price_money')
    self.total_price_money = attributes[:'total_price_money']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/order_line_item_modifier.rb, line 43
def self.swagger_types
  {
    :'uid' => :'String',
    :'catalog_object_id' => :'String',
    :'name' => :'String',
    :'base_price_money' => :'Money',
    :'total_price_money' => :'Money'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/square_connect/models/order_line_item_modifier.rb, line 146
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      uid == o.uid &&
      catalog_object_id == o.catalog_object_id &&
      name == o.name &&
      base_price_money == o.base_price_money &&
      total_price_money == o.total_price_money
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/square_connect/models/order_line_item_modifier.rb, line 192
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
_to_hash(value) click to toggle source

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

# File lib/square_connect/models/order_line_item_modifier.rb, line 258
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
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/square_connect/models/order_line_item_modifier.rb, line 171
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
catalog_object_id=(catalog_object_id) click to toggle source

Custom attribute writer method with validation @param [Object] catalog_object_id Value to be assigned

# File lib/square_connect/models/order_line_item_modifier.rb, line 124
def catalog_object_id=(catalog_object_id)

  if !catalog_object_id.nil? && catalog_object_id.to_s.length > 192
    fail ArgumentError, "invalid value for 'catalog_object_id', the character length must be smaller than or equal to 192."
  end

  @catalog_object_id = catalog_object_id
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/square_connect/models/order_line_item_modifier.rb, line 158
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/square_connect/models/order_line_item_modifier.rb, line 164
def hash
  [uid, catalog_object_id, name, base_price_money, total_price_money].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/square_connect/models/order_line_item_modifier.rb, line 85
def list_invalid_properties
  invalid_properties = Array.new
  if !@uid.nil? && @uid.to_s.length > 60
    invalid_properties.push("invalid value for 'uid', the character length must be smaller than or equal to 60.")
  end

  if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192
    invalid_properties.push("invalid value for 'catalog_object_id', the character length must be smaller than or equal to 192.")
  end

  if !@name.nil? && @name.to_s.length > 255
    invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 255.")
  end

  return invalid_properties
end
name=(name) click to toggle source

Custom attribute writer method with validation @param [Object] name Value to be assigned

# File lib/square_connect/models/order_line_item_modifier.rb, line 135
def name=(name)

  if !name.nil? && name.to_s.length > 255
    fail ArgumentError, "invalid value for 'name', the character length must be smaller than or equal to 255."
  end

  @name = name
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/square_connect/models/order_line_item_modifier.rb, line 238
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/square_connect/models/order_line_item_modifier.rb, line 244
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/square_connect/models/order_line_item_modifier.rb, line 232
def to_s
  to_hash.to_s
end
uid=(uid) click to toggle source

Custom attribute writer method with validation @param [Object] uid Value to be assigned

# File lib/square_connect/models/order_line_item_modifier.rb, line 113
def uid=(uid)

  if !uid.nil? && uid.to_s.length > 60
    fail ArgumentError, "invalid value for 'uid', the character length must be smaller than or equal to 60."
  end

  @uid = uid
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/square_connect/models/order_line_item_modifier.rb, line 104
def valid?
  return false if !@uid.nil? && @uid.to_s.length > 60
  return false if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192
  return false if !@name.nil? && @name.to_s.length > 255
  return true
end