class AsposeEmailCloud::PostalAddress

A postal address

Attributes

address[RW]

Address.

@return [String]

category[RW]

Address category.

@return [EnumWithCustomOfPostalAddressCategory]

city[RW]

Address's city.

@return [String]

country[RW]

Address's country.

@return [String]

country_code[RW]

Country code.

@return [String]

is_mailing_address[RW]

Defines whether address may be used for mailing.

@return [BOOLEAN]

post_office_box[RW]

Post Office box.

@return [String]

postal_code[RW]

Postal code.

@return [String]

preferred[RW]

Defines whether postal address is preferred.

@return [BOOLEAN]

state_or_province[RW]

Address's region.

@return [String]

street[RW]

Address's street.

@return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/aspose-email-cloud/models/postal_address.rb, line 65
def self.attribute_map
  {
    :'address' => :'address',
    :'category' => :'category',
    :'city' => :'city',
    :'country' => :'country',
    :'country_code' => :'countryCode',
    :'is_mailing_address' => :'isMailingAddress',
    :'postal_code' => :'postalCode',
    :'post_office_box' => :'postOfficeBox',
    :'preferred' => :'preferred',
    :'state_or_province' => :'stateOrProvince',
    :'street' => :'street'
  }
end
new( address: nil, category: nil, city: nil, country: nil, country_code: nil, is_mailing_address: nil, postal_code: nil, post_office_box: nil, preferred: nil, state_or_province: nil, street: nil) click to toggle source

Initializes the object @param [String] address Address.

@param [EnumWithCustomOfPostalAddressCategory] category Address category.

@param [String] city Address's city.

@param [String] country Address's country.

@param [String] country_code Country code.

@param [BOOLEAN] is_mailing_address Defines whether address may be used for mailing.

@param [String] postal_code Postal code.

@param [String] post_office_box Post Office box.

@param [BOOLEAN] preferred Defines whether postal address is preferred.

@param [String] state_or_province Address's region.

@param [String] street Address's street.

# File lib/aspose-email-cloud/models/postal_address.rb, line 110
def initialize(
  address: nil,
  category: nil,
  city: nil,
  country: nil,
  country_code: nil,
  is_mailing_address: nil,
  postal_code: nil,
  post_office_box: nil,
  preferred: nil,
  state_or_province: nil,
  street: nil)
  self.address = address if address
  self.category = category if category
  self.city = city if city
  self.country = country if country
  self.country_code = country_code if country_code
  self.is_mailing_address = is_mailing_address if is_mailing_address
  self.postal_code = postal_code if postal_code
  self.post_office_box = post_office_box if post_office_box
  self.preferred = preferred if preferred
  self.state_or_province = state_or_province if state_or_province
  self.street = street if street
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose-email-cloud/models/postal_address.rb, line 82
def self.swagger_types
  {
    :'address' => :'String',
    :'category' => :'EnumWithCustomOfPostalAddressCategory',
    :'city' => :'String',
    :'country' => :'String',
    :'country_code' => :'String',
    :'is_mailing_address' => :'BOOLEAN',
    :'postal_code' => :'String',
    :'post_office_box' => :'String',
    :'preferred' => :'BOOLEAN',
    :'state_or_province' => :'String',
    :'street' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/aspose-email-cloud/models/postal_address.rb, line 160
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address == o.address &&
      category == o.category &&
      city == o.city &&
      country == o.country &&
      country_code == o.country_code &&
      is_mailing_address == o.is_mailing_address &&
      postal_code == o.postal_code &&
      post_office_box == o.post_office_box &&
      preferred == o.preferred &&
      state_or_province == o.state_or_province &&
      street == o.street
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/aspose-email-cloud/models/postal_address.rb, line 214
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
    sub_type = value[:type] || value[:discriminator] || type
    if AsposeEmailCloud.const_defined?(sub_type)
      type = sub_type
    end
    temp_model = AsposeEmailCloud.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/aspose-email-cloud/models/postal_address.rb, line 284
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/aspose-email-cloud/models/postal_address.rb, line 191
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    attribute_key = self.class.attribute_map[key]
    attribute_key = (attribute_key[0, 1].downcase + attribute_key[1..-1]).to_sym
    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[attribute_key].is_a?(Array)
        self.send("#{key}=", attributes[attribute_key].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_key].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_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/aspose-email-cloud/models/postal_address.rb, line 178
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/aspose-email-cloud/models/postal_address.rb, line 184
def hash
  [address, category, city, country, country_code, is_mailing_address, postal_code, post_office_box, preferred, state_or_province, street].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/aspose-email-cloud/models/postal_address.rb, line 137
def list_invalid_properties
  invalid_properties = Array.new
  if @is_mailing_address.nil?
    invalid_properties.push('invalid value for "is_mailing_address", is_mailing_address cannot be nil.')
  end

  if @preferred.nil?
    invalid_properties.push('invalid value for "preferred", preferred 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/aspose-email-cloud/models/postal_address.rb, line 264
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/aspose-email-cloud/models/postal_address.rb, line 270
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/aspose-email-cloud/models/postal_address.rb, line 258
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/aspose-email-cloud/models/postal_address.rb, line 152
def valid?
  return false if @is_mailing_address.nil?
  return false if @preferred.nil?
  true
end