class AmzSpApi::OrdersApiModel::Address

The shipping address for the order.

Attributes

address_line1[RW]

The street address.

address_line2[RW]

Additional street address information, if required.

address_line3[RW]

Additional street address information, if required.

address_type[RW]

The address type of the shipping address.

city[RW]

The city

country_code[RW]

The country code. A two-character country code, in ISO 3166-1 alpha-2 format.

county[RW]

The county.

district[RW]

The district.

municipality[RW]

The municipality.

name[RW]

The name.

phone[RW]

The phone number. Not returned for Fulfillment by Amazon (FBA) orders.

postal_code[RW]

The postal code.

state_or_region[RW]

The state or region.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/orders-api-model/models/address.rb, line 79
def self.attribute_map
  {
    :'name' => :'Name',
    :'address_line1' => :'AddressLine1',
    :'address_line2' => :'AddressLine2',
    :'address_line3' => :'AddressLine3',
    :'city' => :'City',
    :'county' => :'County',
    :'district' => :'District',
    :'state_or_region' => :'StateOrRegion',
    :'municipality' => :'Municipality',
    :'postal_code' => :'PostalCode',
    :'country_code' => :'CountryCode',
    :'phone' => :'Phone',
    :'address_type' => :'AddressType'
  }
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/orders-api-model/models/address.rb, line 255
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/orders-api-model/models/address.rb, line 124
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::OrdersApiModel::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 `AmzSpApi::OrdersApiModel::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?(:'name')
    self.name = attributes[:'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')
    self.city = attributes[:'city']
  end

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

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

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

  if attributes.key?(:'municipality')
    self.municipality = attributes[:'municipality']
  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?(:'phone')
    self.phone = attributes[:'phone']
  end

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

List of attributes with nullable: true

# File lib/orders-api-model/models/address.rb, line 117
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/orders-api-model/models/address.rb, line 98
def self.openapi_types
  {
    :'name' => :'Object',
    :'address_line1' => :'Object',
    :'address_line2' => :'Object',
    :'address_line3' => :'Object',
    :'city' => :'Object',
    :'county' => :'Object',
    :'district' => :'Object',
    :'state_or_region' => :'Object',
    :'municipality' => :'Object',
    :'postal_code' => :'Object',
    :'country_code' => :'Object',
    :'phone' => :'Object',
    :'address_type' => :'Object'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/orders-api-model/models/address.rb, line 222
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      address_line1 == o.address_line1 &&
      address_line2 == o.address_line2 &&
      address_line3 == o.address_line3 &&
      city == o.city &&
      county == o.county &&
      district == o.district &&
      state_or_region == o.state_or_region &&
      municipality == o.municipality &&
      postal_code == o.postal_code &&
      country_code == o.country_code &&
      phone == o.phone &&
      address_type == o.address_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/orders-api-model/models/address.rb, line 285
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
    AmzSpApi::OrdersApiModel.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/orders-api-model/models/address.rb, line 354
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_type=(address_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] address_type Object to be assigned

# File lib/orders-api-model/models/address.rb, line 212
def address_type=(address_type)
  validator = EnumAttributeValidator.new('Object', ['Residential', 'Commercial'])
  unless validator.valid?(address_type)
    fail ArgumentError, "invalid value for \"address_type\", must be one of #{validator.allowable_values}."
  end
  @address_type = address_type
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/orders-api-model/models/address.rb, line 262
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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end
eql?(o) click to toggle source

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

# File lib/orders-api-model/models/address.rb, line 242
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/orders-api-model/models/address.rb, line 248
def hash
  [name, address_line1, address_line2, address_line3, city, county, district, state_or_region, municipality, postal_code, country_code, phone, address_type].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/orders-api-model/models/address.rb, line 192
def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  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/orders-api-model/models/address.rb, line 330
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/orders-api-model/models/address.rb, line 336
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/orders-api-model/models/address.rb, line 324
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/orders-api-model/models/address.rb, line 203
def valid?
  return false if @name.nil?
  address_type_validator = EnumAttributeValidator.new('Object', ['Residential', 'Commercial'])
  return false unless address_type_validator.valid?(@address_type)
  true
end