class OpenapiClient::Dimensions

The dimensions of a package

Attributes

height[RW]

The length of the package, in the specified unit

length[RW]

The length of the package, in the specified unit

unit[RW]
width[RW]

The width of the package, in the specified unit

Public Class Methods

attribute_map() click to toggle source

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

# File lib/openapi_client/models/dimensions.rb, line 30
def self.attribute_map
  {
    :'unit' => :'unit',
    :'length' => :'length',
    :'width' => :'width',
    :'height' => :'height'
  }
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/openapi_client/models/dimensions.rb, line 209
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

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

# File lib/openapi_client/models/dimensions.rb, line 57
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Dimensions` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Dimensions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'unit')
    self.unit = attributes[:'unit']
  end

  if attributes.key?(:'length')
    self.length = attributes[:'length']
  else
    self.length = 0
  end

  if attributes.key?(:'width')
    self.width = attributes[:'width']
  else
    self.width = 0
  end

  if attributes.key?(:'height')
    self.height = attributes[:'height']
  else
    self.height = 0
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/openapi_client/models/dimensions.rb, line 50
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/openapi_client/models/dimensions.rb, line 40
def self.openapi_types
  {
    :'unit' => :'DimensionUnit',
    :'length' => :'Float',
    :'width' => :'Float',
    :'height' => :'Float'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/openapi_client/models/dimensions.rb, line 185
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      unit == o.unit &&
      length == o.length &&
      width == o.width &&
      height == o.height
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/openapi_client/models/dimensions.rb, line 237
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
    OpenapiClient.const_get(type).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/openapi_client/models/dimensions.rb, line 306
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/openapi_client/models/dimensions.rb, line 216
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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/openapi_client/models/dimensions.rb, line 196
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/openapi_client/models/dimensions.rb, line 202
def hash
  [unit, length, width, height].hash
end
height=(height) click to toggle source

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

# File lib/openapi_client/models/dimensions.rb, line 171
def height=(height)
  if height.nil?
    fail ArgumentError, 'height cannot be nil'
  end

  if height < 0
    fail ArgumentError, 'invalid value for "height", must be greater than or equal to 0.'
  end

  @height = height
end
length=(length) click to toggle source

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

# File lib/openapi_client/models/dimensions.rb, line 143
def length=(length)
  if length.nil?
    fail ArgumentError, 'length cannot be nil'
  end

  if length < 0
    fail ArgumentError, 'invalid value for "length", must be greater than or equal to 0.'
  end

  @length = length
end
list_invalid_properties() click to toggle source

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

# File lib/openapi_client/models/dimensions.rb, line 95
def list_invalid_properties
  invalid_properties = Array.new
  if @unit.nil?
    invalid_properties.push('invalid value for "unit", unit cannot be nil.')
  end

  if @length.nil?
    invalid_properties.push('invalid value for "length", length cannot be nil.')
  end

  if @length < 0
    invalid_properties.push('invalid value for "length", must be greater than or equal to 0.')
  end

  if @width.nil?
    invalid_properties.push('invalid value for "width", width cannot be nil.')
  end

  if @width < 0
    invalid_properties.push('invalid value for "width", must be greater than or equal to 0.')
  end

  if @height.nil?
    invalid_properties.push('invalid value for "height", height cannot be nil.')
  end

  if @height < 0
    invalid_properties.push('invalid value for "height", must be greater than or equal to 0.')
  end

  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/openapi_client/models/dimensions.rb, line 282
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/openapi_client/models/dimensions.rb, line 288
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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/openapi_client/models/dimensions.rb, line 276
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/openapi_client/models/dimensions.rb, line 130
def valid?
  return false if @unit.nil?
  return false if @length.nil?
  return false if @length < 0
  return false if @width.nil?
  return false if @width < 0
  return false if @height.nil?
  return false if @height < 0
  true
end
width=(width) click to toggle source

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

# File lib/openapi_client/models/dimensions.rb, line 157
def width=(width)
  if width.nil?
    fail ArgumentError, 'width cannot be nil'
  end

  if width < 0
    fail ArgumentError, 'invalid value for "width", must be greater than or equal to 0.'
  end

  @width = width
end