class Plaid::PaymentInitiationAddress

The optional address of the payment recipient’s bank account. Required by most institutions outside of the UK.

Attributes

city[RW]

The city where the recipient is located. Maximum of 35 characters.

country[RW]

The ISO 3166-1 alpha-2 country code where the recipient is located.

postal_code[RW]

The postal code where the recipient is located. Maximum of 16 characters.

street[RW]

An array of length 1-2 representing the street address where the recipient is located. Maximum of 70 characters.

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/plaid/models/payment_initiation_address.rb, line 42
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/plaid/models/payment_initiation_address.rb, line 32
def self.attribute_map
  {
    :'street' => :'street',
    :'city' => :'city',
    :'postal_code' => :'postal_code',
    :'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/plaid/models/payment_initiation_address.rb, line 266
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/plaid/models/payment_initiation_address.rb, line 64
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::PaymentInitiationAddress` 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 `Plaid::PaymentInitiationAddress`. 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?(:'street')
    if (value = attributes[:'street']).is_a?(Array)
      self.street = value
    end
  end

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

  if attributes.key?(:'postal_code')
    self.postal_code = attributes[:'postal_code']
  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/plaid/models/payment_initiation_address.rb, line 57
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/plaid/models/payment_initiation_address.rb, line 47
def self.openapi_types
  {
    :'street' => :'Array<String>',
    :'city' => :'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/plaid/models/payment_initiation_address.rb, line 242
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      street == o.street &&
      city == o.city &&
      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/plaid/models/payment_initiation_address.rb, line 297
def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : 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/plaid/models/payment_initiation_address.rb, line 368
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/plaid/models/payment_initiation_address.rb, line 273
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end
city=(city) click to toggle source

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

# File lib/plaid/models/payment_initiation_address.rb, line 185
def city=(city)
  if city.nil?
    fail ArgumentError, 'city cannot be nil'
  end

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

  if city.to_s.length < 1
    fail ArgumentError, 'invalid value for "city", the character length must be great than or equal to 1.'
  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/plaid/models/payment_initiation_address.rb, line 223
def country=(country)
  if country.nil?
    fail ArgumentError, 'country cannot be nil'
  end

  if country.to_s.length > 2
    fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 2.'
  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
eql?(o) click to toggle source

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

# File lib/plaid/models/payment_initiation_address.rb, line 253
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/plaid/models/payment_initiation_address.rb, line 259
def hash
  [street, city, 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/plaid/models/payment_initiation_address.rb, line 98
def list_invalid_properties
  invalid_properties = Array.new
  if @street.nil?
    invalid_properties.push('invalid value for "street", street cannot be nil.')
  end


  if @street.length < 1
    invalid_properties.push('invalid value for "street", number of items must be greater than or equal to 1.')
  end

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

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

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


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

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

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


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

  if @country.to_s.length > 2
    invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 2.')
  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
postal_code=(postal_code) click to toggle source

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

# File lib/plaid/models/payment_initiation_address.rb, line 204
def postal_code=(postal_code)
  if postal_code.nil?
    fail ArgumentError, 'postal_code cannot be nil'
  end

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

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


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

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

# File lib/plaid/models/payment_initiation_address.rb, line 170
def street=(street)
  if street.nil?
    fail ArgumentError, 'street cannot be nil'
  end


  if street.length < 1
    fail ArgumentError, 'invalid value for "street", number of items must be greater than or equal to 1.'
  end

  @street = street
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/plaid/models/payment_initiation_address.rb, line 344
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/plaid/models/payment_initiation_address.rb, line 350
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/plaid/models/payment_initiation_address.rb, line 338
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/plaid/models/payment_initiation_address.rb, line 153
def valid?
  return false if @street.nil?
  return false if @street.length < 1
  return false if @city.nil?
  return false if @city.to_s.length > 35
  return false if @city.to_s.length < 1
  return false if @postal_code.nil?
  return false if @postal_code.to_s.length > 16
  return false if @postal_code.to_s.length < 1
  return false if @country.nil?
  return false if @country.to_s.length > 2
  return false if @country.to_s.length < 2
  true
end