class OpenapiClient::Address

Model for address information.

Attributes

address1[RW]

First line of the street address.

address2[RW]

Second line of the street address.

city[RW]

City or locality.

company[RW]

Company name associated with the address.

country[RW]

ISO-3166-1 ALPHA-2, ALPHA-3, numeric or full country name. In the case of PaySecure endpoints, pass the country code in an ISO format.

postal_code[RW]

ZIP code or postal code.

region[RW]

State or province.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/openapi_client/models/address.rb, line 40
def self.attribute_map
  {
    :'company' => :'company',
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'city' => :'city',
    :'region' => :'region',
    :'postal_code' => :'postalCode',
    :'country' => :'country'
  }
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/address.rb, line 256
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/address.rb, line 67
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::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 `OpenapiClient::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?(:'company')
    self.company = attributes[:'company']
  end

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

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

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

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

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

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

Attribute type mapping.

# File lib/openapi_client/models/address.rb, line 53
def self.openapi_types
  {
    :'company' => :'String',
    :'address1' => :'String',
    :'address2' => :'String',
    :'city' => :'String',
    :'region' => :'String',
    :'postal_code' => :'String',
    :'country' => :'String'
  }
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/address.rb, line 229
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      company == o.company &&
      address1 == o.address1 &&
      address2 == o.address2 &&
      city == o.city &&
      region == o.region &&
      postal_code == o.postal_code &&
      country == o.country
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/address.rb, line 284
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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    klass.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/address.rb, line 358
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
address1=(address1) click to toggle source

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

# File lib/openapi_client/models/address.rb, line 169
def address1=(address1)
  if !address1.nil? && address1.to_s.length > 96
    fail ArgumentError, 'invalid value for "address1", the character length must be smaller than or equal to 96.'
  end

  @address1 = address1
end
address2=(address2) click to toggle source

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

# File lib/openapi_client/models/address.rb, line 179
def address2=(address2)
  if !address2.nil? && address2.to_s.length > 96
    fail ArgumentError, 'invalid value for "address2", the character length must be smaller than or equal to 96.'
  end

  @address2 = address2
end
build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) 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/address.rb, line 263
def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[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/openapi_client/models/address.rb, line 189
def city=(city)
  if !city.nil? && city.to_s.length > 96
    fail ArgumentError, 'invalid value for "city", the character length must be smaller than or equal to 96.'
  end

  @city = city
end
company=(company) click to toggle source

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

# File lib/openapi_client/models/address.rb, line 159
def company=(company)
  if !company.nil? && company.to_s.length > 96
    fail ArgumentError, 'invalid value for "company", the character length must be smaller than or equal to 96.'
  end

  @company = company
end
country=(country) click to toggle source

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

# File lib/openapi_client/models/address.rb, line 219
def country=(country)
  if !country.nil? && country.to_s.length > 32
    fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 32.'
  end

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

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

# File lib/openapi_client/models/address.rb, line 243
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/address.rb, line 249
def hash
  [company, address1, address2, city, region, postal_code, country].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/openapi_client/models/address.rb, line 111
def list_invalid_properties
  invalid_properties = Array.new
  if !@company.nil? && @company.to_s.length > 96
    invalid_properties.push('invalid value for "company", the character length must be smaller than or equal to 96.')
  end

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

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

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

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

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

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

  invalid_properties
end
postal_code=(postal_code) click to toggle source

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

# File lib/openapi_client/models/address.rb, line 209
def postal_code=(postal_code)
  if !postal_code.nil? && postal_code.to_s.length > 24
    fail ArgumentError, 'invalid value for "postal_code", the character length must be smaller than or equal to 24.'
  end

  @postal_code = postal_code
end
region=(region) click to toggle source

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

# File lib/openapi_client/models/address.rb, line 199
def region=(region)
  if !region.nil? && region.to_s.length > 96
    fail ArgumentError, 'invalid value for "region", the character length must be smaller than or equal to 96.'
  end

  @region = region
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/address.rb, line 334
def to_body
  to_hash
end
to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) 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/address.rb, line 340
def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
  hash = {}
  attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = 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/address.rb, line 328
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/address.rb, line 146
def valid?
  return false if !@company.nil? && @company.to_s.length > 96
  return false if !@address1.nil? && @address1.to_s.length > 96
  return false if !@address2.nil? && @address2.to_s.length > 96
  return false if !@city.nil? && @city.to_s.length > 96
  return false if !@region.nil? && @region.to_s.length > 96
  return false if !@postal_code.nil? && @postal_code.to_s.length > 24
  return false if !@country.nil? && @country.to_s.length > 32
  true
end