class VeloPayments::CreatePayeeAddress

Attributes

city[RW]
country[RW]

Ideally a 2 letter ISO 3166-1 country code. But a limited set of additional values will be corrected. See Java Locale.getISOCountries() and Locale.getDisplayCountry()

county_or_province[RW]
line1[RW]
line2[RW]
line3[RW]
line4[RW]
zip_or_postcode[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/velopayments/models/create_payee_address.rb, line 35
def self.attribute_map
  {
    :'line1' => :'line1',
    :'line2' => :'line2',
    :'line3' => :'line3',
    :'line4' => :'line4',
    :'city' => :'city',
    :'county_or_province' => :'countyOrProvince',
    :'zip_or_postcode' => :'zipOrPostcode',
    :'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/velopayments/models/create_payee_address.rb, line 383
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/velopayments/models/create_payee_address.rb, line 75
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::CreatePayeeAddress` 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 `VeloPayments::CreatePayeeAddress`. 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?(:'line1')
    self.line1 = attributes[:'line1']
  end

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/velopayments/models/create_payee_address.rb, line 63
def self.openapi_nullable
  Set.new([
    :'line2',
    :'line3',
    :'line4',
    :'county_or_province',
    :'zip_or_postcode',
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/velopayments/models/create_payee_address.rb, line 49
def self.openapi_types
  {
    :'line1' => :'String',
    :'line2' => :'String',
    :'line3' => :'String',
    :'line4' => :'String',
    :'city' => :'String',
    :'county_or_province' => :'String',
    :'zip_or_postcode' => :'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/velopayments/models/create_payee_address.rb, line 355
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      line1 == o.line1 &&
      line2 == o.line2 &&
      line3 == o.line3 &&
      line4 == o.line4 &&
      city == o.city &&
      county_or_province == o.county_or_province &&
      zip_or_postcode == o.zip_or_postcode &&
      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/velopayments/models/create_payee_address.rb, line 411
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
    VeloPayments.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/velopayments/models/create_payee_address.rb, line 480
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/velopayments/models/create_payee_address.rb, line 390
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/velopayments/models/create_payee_address.rb, line 291
def city=(city)
  if city.nil?
    fail ArgumentError, 'city cannot be nil'
  end

  if city.to_s.length > 50
    fail ArgumentError, 'invalid value for "city", the character length must be smaller than or equal to 50.'
  end

  if city.to_s.length < 2
    fail ArgumentError, 'invalid value for "city", the character length must be great than or equal to 2.'
  end

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

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

# File lib/velopayments/models/create_payee_address.rb, line 337
def country=(country)
  if country.nil?
    fail ArgumentError, 'country cannot be nil'
  end

  if country.to_s.length > 50
    fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 50.'
  end

  if country.to_s.length < 2
    fail ArgumentError, 'invalid value for "country", the character length must be great than or equal to 2.'
  end

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

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

# File lib/velopayments/models/create_payee_address.rb, line 309
def county_or_province=(county_or_province)
  if !county_or_province.nil? && county_or_province.to_s.length > 50
    fail ArgumentError, 'invalid value for "county_or_province", the character length must be smaller than or equal to 50.'
  end

  if !county_or_province.nil? && county_or_province.to_s.length < 2
    fail ArgumentError, 'invalid value for "county_or_province", the character length must be great than or equal to 2.'
  end

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

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

# File lib/velopayments/models/create_payee_address.rb, line 370
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/velopayments/models/create_payee_address.rb, line 376
def hash
  [line1, line2, line3, line4, city, county_or_province, zip_or_postcode, country].hash
end
line1=(line1) click to toggle source

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

# File lib/velopayments/models/create_payee_address.rb, line 231
def line1=(line1)
  if line1.nil?
    fail ArgumentError, 'line1 cannot be nil'
  end

  if line1.to_s.length > 100
    fail ArgumentError, 'invalid value for "line1", the character length must be smaller than or equal to 100.'
  end

  if line1.to_s.length < 1
    fail ArgumentError, 'invalid value for "line1", the character length must be great than or equal to 1.'
  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/velopayments/models/create_payee_address.rb, line 249
def line2=(line2)
  if !line2.nil? && line2.to_s.length > 100
    fail ArgumentError, 'invalid value for "line2", the character length must be smaller than or equal to 100.'
  end

  if !line2.nil? && line2.to_s.length < 0
    fail ArgumentError, 'invalid value for "line2", the character length must be great than or equal to 0.'
  end

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

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

# File lib/velopayments/models/create_payee_address.rb, line 263
def line3=(line3)
  if !line3.nil? && line3.to_s.length > 100
    fail ArgumentError, 'invalid value for "line3", the character length must be smaller than or equal to 100.'
  end

  if !line3.nil? && line3.to_s.length < 0
    fail ArgumentError, 'invalid value for "line3", the character length must be great than or equal to 0.'
  end

  @line3 = line3
end
line4=(line4) click to toggle source

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

# File lib/velopayments/models/create_payee_address.rb, line 277
def line4=(line4)
  if !line4.nil? && line4.to_s.length > 100
    fail ArgumentError, 'invalid value for "line4", the character length must be smaller than or equal to 100.'
  end

  if !line4.nil? && line4.to_s.length < 0
    fail ArgumentError, 'invalid value for "line4", the character length must be great than or equal to 0.'
  end

  @line4 = line4
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/velopayments/models/create_payee_address.rb, line 123
def list_invalid_properties
  invalid_properties = Array.new
  if @line1.nil?
    invalid_properties.push('invalid value for "line1", line1 cannot be nil.')
  end

  if @line1.to_s.length > 100
    invalid_properties.push('invalid value for "line1", the character length must be smaller than or equal to 100.')
  end

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

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

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

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

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

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

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

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

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

  if @city.to_s.length < 2
    invalid_properties.push('invalid value for "city", the character length must be great than or equal to 2.')
  end

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

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

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

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

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

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

  if @country.to_s.length < 2
    invalid_properties.push('invalid value for "country", the character length must be great than or equal to 2.')
  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/velopayments/models/create_payee_address.rb, line 456
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/velopayments/models/create_payee_address.rb, line 462
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/velopayments/models/create_payee_address.rb, line 450
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/velopayments/models/create_payee_address.rb, line 206
def valid?
  return false if @line1.nil?
  return false if @line1.to_s.length > 100
  return false if @line1.to_s.length < 1
  return false if !@line2.nil? && @line2.to_s.length > 100
  return false if !@line2.nil? && @line2.to_s.length < 0
  return false if !@line3.nil? && @line3.to_s.length > 100
  return false if !@line3.nil? && @line3.to_s.length < 0
  return false if !@line4.nil? && @line4.to_s.length > 100
  return false if !@line4.nil? && @line4.to_s.length < 0
  return false if @city.nil?
  return false if @city.to_s.length > 50
  return false if @city.to_s.length < 2
  return false if !@county_or_province.nil? && @county_or_province.to_s.length > 50
  return false if !@county_or_province.nil? && @county_or_province.to_s.length < 2
  return false if !@zip_or_postcode.nil? && @zip_or_postcode.to_s.length > 60
  return false if !@zip_or_postcode.nil? && @zip_or_postcode.to_s.length < 2
  return false if @country.nil?
  return false if @country.to_s.length > 50
  return false if @country.to_s.length < 2
  true
end
zip_or_postcode=(zip_or_postcode) click to toggle source

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

# File lib/velopayments/models/create_payee_address.rb, line 323
def zip_or_postcode=(zip_or_postcode)
  if !zip_or_postcode.nil? && zip_or_postcode.to_s.length > 60
    fail ArgumentError, 'invalid value for "zip_or_postcode", the character length must be smaller than or equal to 60.'
  end

  if !zip_or_postcode.nil? && zip_or_postcode.to_s.length < 2
    fail ArgumentError, 'invalid value for "zip_or_postcode", the character length must be great than or equal to 2.'
  end

  @zip_or_postcode = zip_or_postcode
end