class DearInventoryRuby::Address

Attributes

city[RW]

City / Suburb

country[RW]

Country name

default_for_type[RW]

Points that Address is used as default for chosen Type. `false` as default.

id[RW]

If passed in PUT method, entry will be searched by id, found entry will be updated, otherwise created

line1[RW]

Address Line 1

line2[RW]

Address Line 2

post_code[RW]

Zip / PostCode

state[RW]

State / Province

type[RW]

Address Type. Should be one of the following values: `Billing`, `Business` or `Shipping`.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/dear-inventory-ruby/models/address.rb, line 45
def self.attribute_map
  {
    :'id' => :'ID',
    :'line1' => :'Line1',
    :'line2' => :'Line2',
    :'city' => :'City',
    :'state' => :'State',
    :'post_code' => :'PostCode',
    :'country' => :'Country',
    :'type' => :'Type',
    :'default_for_type' => :'DefaultForType'
  }
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/dear-inventory-ruby/models/address.rb, line 263
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/dear-inventory-ruby/models/address.rb, line 82
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DearInventoryRuby::Address` 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 `DearInventoryRuby::Address`. 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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/dear-inventory-ruby/models/address.rb, line 75
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/dear-inventory-ruby/models/address.rb, line 60
def self.openapi_types
  {
    :'id' => :'String',
    :'line1' => :'String',
    :'line2' => :'String',
    :'city' => :'String',
    :'state' => :'String',
    :'post_code' => :'String',
    :'country' => :'String',
    :'type' => :'String',
    :'default_for_type' => :'Boolean'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/dear-inventory-ruby/models/address.rb, line 234
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      line1 == o.line1 &&
      line2 == o.line2 &&
      city == o.city &&
      state == o.state &&
      post_code == o.post_code &&
      country == o.country &&
      type == o.type &&
      default_for_type == o.default_for_type
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/dear-inventory-ruby/models/address.rb, line 291
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
    DearInventoryRuby.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/dear-inventory-ruby/models/address.rb, line 360
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/dear-inventory-ruby/models/address.rb, line 270
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
city=(city) click to toggle source

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

# File lib/dear-inventory-ruby/models/address.rb, line 204
def city=(city)
  if !city.nil? && city.to_s.length > 256
    fail ArgumentError, 'invalid value for "city", the character length must be smaller than or equal to 256.'
  end

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

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

# File lib/dear-inventory-ruby/models/address.rb, line 250
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/dear-inventory-ruby/models/address.rb, line 256
def hash
  [id, line1, line2, city, state, post_code, country, type, default_for_type].hash
end
line1=(line1) click to toggle source

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

# File lib/dear-inventory-ruby/models/address.rb, line 184
def line1=(line1)
  if !line1.nil? && line1.to_s.length > 256
    fail ArgumentError, 'invalid value for "line1", the character length must be smaller than or equal to 256.'
  end

  @line1 = line1
end
line2=(line2) click to toggle source

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

# File lib/dear-inventory-ruby/models/address.rb, line 194
def line2=(line2)
  if !line2.nil? && line2.to_s.length > 256
    fail ArgumentError, 'invalid value for "line2", the character length must be smaller than or equal to 256.'
  end

  @line2 = line2
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/dear-inventory-ruby/models/address.rb, line 136
def list_invalid_properties
  invalid_properties = Array.new
  if !@line1.nil? && @line1.to_s.length > 256
    invalid_properties.push('invalid value for "line1", the character length must be smaller than or equal to 256.')
  end

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

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

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

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

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

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

  invalid_properties
end
post_code=(post_code) click to toggle source

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

# File lib/dear-inventory-ruby/models/address.rb, line 224
def post_code=(post_code)
  if !post_code.nil? && post_code.to_s.length > 20
    fail ArgumentError, 'invalid value for "post_code", the character length must be smaller than or equal to 20.'
  end

  @post_code = post_code
end
state=(state) click to toggle source

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

# File lib/dear-inventory-ruby/models/address.rb, line 214
def state=(state)
  if !state.nil? && state.to_s.length > 256
    fail ArgumentError, 'invalid value for "state", the character length must be smaller than or equal to 256.'
  end

  @state = state
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/dear-inventory-ruby/models/address.rb, line 336
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/dear-inventory-ruby/models/address.rb, line 342
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/dear-inventory-ruby/models/address.rb, line 330
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/dear-inventory-ruby/models/address.rb, line 171
def valid?
  return false if !@line1.nil? && @line1.to_s.length > 256
  return false if !@line2.nil? && @line2.to_s.length > 256
  return false if !@city.nil? && @city.to_s.length > 256
  return false if !@state.nil? && @state.to_s.length > 256
  return false if !@post_code.nil? && @post_code.to_s.length > 20
  return false if @country.nil?
  return false if @type.nil?
  true
end