class SquareConnect::V1ModifierOption

V1ModifierOption

Attributes

id[RW]

The modifier option's unique ID.

modifier_list_id[RW]

The ID of the modifier list the option belongs to.

name[RW]

The modifier option's name.

on_by_default[RW]

If true, the modifier option is the default option in a modifier list for which selection_type is SINGLE.

ordinal[RW]

Indicates the modifier option's list position when displayed in Square Register and the merchant dashboard. If more than one modifier option in the same modifier list has the same ordinal value, those options are displayed in alphabetical order.

price_money[RW]

The modifier option's price.

v2_id[RW]

The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/square_connect/models/v1_modifier_option.rb, line 38
def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'price_money' => :'price_money',
    :'on_by_default' => :'on_by_default',
    :'ordinal' => :'ordinal',
    :'modifier_list_id' => :'modifier_list_id',
    :'v2_id' => :'v2_id'
  }
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/v1_modifier_option.rb, line 65
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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/v1_modifier_option.rb, line 51
def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'price_money' => :'V1Money',
    :'on_by_default' => :'BOOLEAN',
    :'ordinal' => :'Integer',
    :'modifier_list_id' => :'String',
    :'v2_id' => :'String'
  }
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/v1_modifier_option.rb, line 116
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      price_money == o.price_money &&
      on_by_default == o.on_by_default &&
      ordinal == o.ordinal &&
      modifier_list_id == o.modifier_list_id &&
      v2_id == o.v2_id
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/v1_modifier_option.rb, line 164
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/v1_modifier_option.rb, line 230
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/v1_modifier_option.rb, line 143
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
eql?(o) click to toggle source

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

# File lib/square_connect/models/v1_modifier_option.rb, line 130
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/v1_modifier_option.rb, line 136
def hash
  [id, name, price_money, on_by_default, ordinal, modifier_list_id, v2_id].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/v1_modifier_option.rb, line 103
def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
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/v1_modifier_option.rb, line 210
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/v1_modifier_option.rb, line 216
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/v1_modifier_option.rb, line 204
def to_s
  to_hash.to_s
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/v1_modifier_option.rb, line 110
def valid?
  return true
end