class ShipEngine::PartialAddress

A complete or partial mailing address.

Attributes

address_line1[RW]

The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.

address_line2[RW]

The second line of the street address. For some addresses, this line may not be needed.

address_line3[RW]

The third line of the street address. For some addresses, this line may not be needed.

address_residential_indicator[RW]

Indicates whether this is a residential address.

city_locality[RW]

The name of the city or locality

company_name[RW]

If this is a business address, then the company name should be specified here.

country_code[RW]

The two-letter [ISO 3166-1 country code](en.wikipedia.org/wiki/ISO_3166-1)

name[RW]

The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.

phone[RW]

The phone number of a contact person at this address. The format of this phone number varies depending on the country.

postal_code[RW]
state_province[RW]

The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ship_engine/models/partial_address.rb, line 51
def self.attribute_map
  {
    :'name' => :'name',
    :'phone' => :'phone',
    :'company_name' => :'company_name',
    :'address_line1' => :'address_line1',
    :'address_line2' => :'address_line2',
    :'address_line3' => :'address_line3',
    :'city_locality' => :'city_locality',
    :'state_province' => :'state_province',
    :'postal_code' => :'postal_code',
    :'country_code' => :'country_code',
    :'address_residential_indicator' => :'address_residential_indicator'
  }
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/ship_engine/models/partial_address.rb, line 319
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/ship_engine/models/partial_address.rb, line 97
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::PartialAddress` 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|

    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/ship_engine/models/partial_address.rb, line 85
def self.openapi_nullable
  Set.new([
    :'name',
    :'phone',
    :'company_name',
    :'address_line2',
    :'address_line3',
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/ship_engine/models/partial_address.rb, line 68
def self.openapi_types
  {
    :'name' => :'String',
    :'phone' => :'String',
    :'company_name' => :'String',
    :'address_line1' => :'String',
    :'address_line2' => :'String',
    :'address_line3' => :'String',
    :'city_locality' => :'String',
    :'state_province' => :'String',
    :'postal_code' => :'String',
    :'country_code' => :'String',
    :'address_residential_indicator' => :'AddressResidentialIndicator'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/ship_engine/models/partial_address.rb, line 288
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      phone == o.phone &&
      company_name == o.company_name &&
      address_line1 == o.address_line1 &&
      address_line2 == o.address_line2 &&
      address_line3 == o.address_line3 &&
      city_locality == o.city_locality &&
      state_province == o.state_province &&
      postal_code == o.postal_code &&
      country_code == o.country_code &&
      address_residential_indicator == o.address_residential_indicator
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/ship_engine/models/partial_address.rb, line 347
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
    ShipEngine.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/ship_engine/models/partial_address.rb, line 416
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
address_line1=(address_line1) click to toggle source

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

# File lib/ship_engine/models/partial_address.rb, line 238
def address_line1=(address_line1)
  if !address_line1.nil? && address_line1.to_s.length < 1
    fail ArgumentError, 'invalid value for "address_line1", the character length must be great than or equal to 1.'
  end

  @address_line1 = address_line1
end
address_line2=(address_line2) click to toggle source

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

# File lib/ship_engine/models/partial_address.rb, line 248
def address_line2=(address_line2)
  if !address_line2.nil? && address_line2.to_s.length < 1
    fail ArgumentError, 'invalid value for "address_line2", the character length must be great than or equal to 1.'
  end

  @address_line2 = address_line2
end
address_line3=(address_line3) click to toggle source

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

# File lib/ship_engine/models/partial_address.rb, line 258
def address_line3=(address_line3)
  if !address_line3.nil? && address_line3.to_s.length < 1
    fail ArgumentError, 'invalid value for "address_line3", the character length must be great than or equal to 1.'
  end

  @address_line3 = address_line3
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/ship_engine/models/partial_address.rb, line 326
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_locality=(city_locality) click to toggle source

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

# File lib/ship_engine/models/partial_address.rb, line 268
def city_locality=(city_locality)
  if !city_locality.nil? && city_locality.to_s.length < 1
    fail ArgumentError, 'invalid value for "city_locality", the character length must be great than or equal to 1.'
  end

  @city_locality = city_locality
end
company_name=(company_name) click to toggle source

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

# File lib/ship_engine/models/partial_address.rb, line 228
def company_name=(company_name)
  if !company_name.nil? && company_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_name", the character length must be great than or equal to 1.'
  end

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

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

# File lib/ship_engine/models/partial_address.rb, line 306
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/ship_engine/models/partial_address.rb, line 312
def hash
  [name, phone, company_name, address_line1, address_line2, address_line3, city_locality, state_province, postal_code, country_code, address_residential_indicator].hash
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/ship_engine/models/partial_address.rb, line 155
def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  end

  if !@phone.nil? && @phone.to_s.length < 1
    invalid_properties.push('invalid value for "phone", the character length must be great than or equal to 1.')
  end

  if !@company_name.nil? && @company_name.to_s.length < 1
    invalid_properties.push('invalid value for "company_name", the character length must be great than or equal to 1.')
  end

  if !@address_line1.nil? && @address_line1.to_s.length < 1
    invalid_properties.push('invalid value for "address_line1", the character length must be great than or equal to 1.')
  end

  if !@address_line2.nil? && @address_line2.to_s.length < 1
    invalid_properties.push('invalid value for "address_line2", the character length must be great than or equal to 1.')
  end

  if !@address_line3.nil? && @address_line3.to_s.length < 1
    invalid_properties.push('invalid value for "address_line3", the character length must be great than or equal to 1.')
  end

  if !@city_locality.nil? && @city_locality.to_s.length < 1
    invalid_properties.push('invalid value for "city_locality", the character length must be great than or equal to 1.')
  end

  if !@state_province.nil? && @state_province.to_s.length < 1
    invalid_properties.push('invalid value for "state_province", the character length must be great than or equal to 1.')
  end

  invalid_properties
end
name=(name) click to toggle source

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

# File lib/ship_engine/models/partial_address.rb, line 208
def name=(name)
  if !name.nil? && name.to_s.length < 1
    fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
  end

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

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

# File lib/ship_engine/models/partial_address.rb, line 218
def phone=(phone)
  if !phone.nil? && phone.to_s.length < 1
    fail ArgumentError, 'invalid value for "phone", the character length must be great than or equal to 1.'
  end

  @phone = phone
end
state_province=(state_province) click to toggle source

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

# File lib/ship_engine/models/partial_address.rb, line 278
def state_province=(state_province)
  if !state_province.nil? && state_province.to_s.length < 1
    fail ArgumentError, 'invalid value for "state_province", the character length must be great than or equal to 1.'
  end

  @state_province = state_province
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/ship_engine/models/partial_address.rb, line 392
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/ship_engine/models/partial_address.rb, line 398
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/ship_engine/models/partial_address.rb, line 386
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/ship_engine/models/partial_address.rb, line 194
def valid?
  return false if !@name.nil? && @name.to_s.length < 1
  return false if !@phone.nil? && @phone.to_s.length < 1
  return false if !@company_name.nil? && @company_name.to_s.length < 1
  return false if !@address_line1.nil? && @address_line1.to_s.length < 1
  return false if !@address_line2.nil? && @address_line2.to_s.length < 1
  return false if !@address_line3.nil? && @address_line3.to_s.length < 1
  return false if !@city_locality.nil? && @city_locality.to_s.length < 1
  return false if !@state_province.nil? && @state_province.to_s.length < 1
  true
end