class SquareConnect::MeasurementUnit

Represents a unit of measurement to use with a quantity, such as ounces or inches. Exactly one of the following fields are required: `custom_unit`, `area_unit`, `length_unit`, `volume_unit`, and `weight_unit`. The `family` field describes the type of measurement. For example, ounces are in the weight family.

Attributes

area_unit[RW]

Represents a standard area unit. See [MeasurementUnitArea](type-measurementunitarea) for possible values

custom_unit[RW]

A custom unit of measurement defined by the seller using the Point of Sale app or ad-hoc as an order line item.

generic_unit[RW]

Reserved for API integrations that lack the ability to specify a real measurement unit See [MeasurementUnitGeneric](type-measurementunitgeneric) for possible values

length_unit[RW]

Represents a standard length unit. See [MeasurementUnitLength](type-measurementunitlength) for possible values

volume_unit[RW]

Represents a standard volume unit. See [MeasurementUnitVolume](type-measurementunitvolume) for possible values

weight_unit[RW]

Represents a standard unit of weight or mass. See [MeasurementUnitWeight](type-measurementunitweight) for possible values

Public Class Methods

attribute_map() click to toggle source

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

# File lib/square_connect/models/measurement_unit.rb, line 35
def self.attribute_map
  {
    :'custom_unit' => :'custom_unit',
    :'area_unit' => :'area_unit',
    :'length_unit' => :'length_unit',
    :'volume_unit' => :'volume_unit',
    :'weight_unit' => :'weight_unit',
    :'generic_unit' => :'generic_unit'
  }
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/measurement_unit.rb, line 60
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?(:'custom_unit')
    self.custom_unit = attributes[:'custom_unit']
  end

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/measurement_unit.rb, line 47
def self.swagger_types
  {
    :'custom_unit' => :'MeasurementUnitCustom',
    :'area_unit' => :'String',
    :'length_unit' => :'String',
    :'volume_unit' => :'String',
    :'weight_unit' => :'String',
    :'generic_unit' => :'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/measurement_unit.rb, line 107
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      custom_unit == o.custom_unit &&
      area_unit == o.area_unit &&
      length_unit == o.length_unit &&
      volume_unit == o.volume_unit &&
      weight_unit == o.weight_unit &&
      generic_unit == o.generic_unit
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/measurement_unit.rb, line 154
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/measurement_unit.rb, line 220
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/measurement_unit.rb, line 133
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/measurement_unit.rb, line 120
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/measurement_unit.rb, line 126
def hash
  [custom_unit, area_unit, length_unit, volume_unit, weight_unit, generic_unit].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/measurement_unit.rb, line 94
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/measurement_unit.rb, line 200
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/measurement_unit.rb, line 206
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/measurement_unit.rb, line 194
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/measurement_unit.rb, line 101
def valid?
  return true
end