class Onfido::ProofOfAddressProperties

Attributes

address[RW]

This property provides the address on the document.

document_type[RW]

This property provides the document type according to the set of supported documents.

first_names[RW]

This property provides the first names on the document, including any initials and middle names.

issue_date[RW]

This property provides the issue date of the document.

issuer[RW]

This property provides the document issuer (e.g. HSBC, British Gas).

last_names[RW]

This property provided the last names on the document.

summary_period_end[RW]

This property provides the summary period end date.

summary_period_start[RW]

This property provides the summary period start date.

Public Class Methods

_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/onfido/models/proof_of_address_properties.rb, line 232
def self._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 = Onfido.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end
acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/onfido/models/proof_of_address_properties.rb, line 79
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/onfido/models/proof_of_address_properties.rb, line 65
def self.attribute_map
  {
    :'address' => :'address',
    :'document_type' => :'document_type',
    :'first_names' => :'first_names',
    :'last_names' => :'last_names',
    :'issue_date' => :'issue_date',
    :'issuer' => :'issuer',
    :'summary_period_start' => :'summary_period_start',
    :'summary_period_end' => :'summary_period_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/onfido/models/proof_of_address_properties.rb, line 208
def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/onfido/models/proof_of_address_properties.rb, line 105
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::ProofOfAddressProperties` 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 `Onfido::ProofOfAddressProperties`. 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?(:'address')
    self.address = attributes[:'address']
  end

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/onfido/models/proof_of_address_properties.rb, line 98
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/onfido/models/proof_of_address_properties.rb, line 84
def self.openapi_types
  {
    :'address' => :'String',
    :'document_type' => :'String',
    :'first_names' => :'String',
    :'last_names' => :'String',
    :'issue_date' => :'Date',
    :'issuer' => :'String',
    :'summary_period_start' => :'Date',
    :'summary_period_end' => :'Date'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/onfido/models/proof_of_address_properties.rb, line 180
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address == o.address &&
      document_type == o.document_type &&
      first_names == o.first_names &&
      last_names == o.last_names &&
      issue_date == o.issue_date &&
      issuer == o.issuer &&
      summary_period_start == o.summary_period_start &&
      summary_period_end == o.summary_period_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/onfido/models/proof_of_address_properties.rb, line 303
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
document_type=(document_type) click to toggle source

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

# File lib/onfido/models/proof_of_address_properties.rb, line 170
def document_type=(document_type)
  validator = EnumAttributeValidator.new('String', ["bank_building_society_statement", "utility_bill", "council_tax", "benefit_letters", "mortgage_statement", "mobile_phone_bill", "general_letter", "insurance_statement", "pension_property_statement_letter", "identity_document_with_address", "exchange_house_statement", "unknown_default_open_api"])
  unless validator.valid?(document_type)
    fail ArgumentError, "invalid value for \"document_type\", must be one of #{validator.allowable_values}."
  end
  @document_type = document_type
end
eql?(o) click to toggle source

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

# File lib/onfido/models/proof_of_address_properties.rb, line 195
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/onfido/models/proof_of_address_properties.rb, line 201
def hash
  [address, document_type, first_names, last_names, issue_date, issuer, summary_period_start, summary_period_end].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/onfido/models/proof_of_address_properties.rb, line 153
def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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/onfido/models/proof_of_address_properties.rb, line 279
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/onfido/models/proof_of_address_properties.rb, line 285
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/onfido/models/proof_of_address_properties.rb, line 273
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/onfido/models/proof_of_address_properties.rb, line 161
def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  document_type_validator = EnumAttributeValidator.new('String', ["bank_building_society_statement", "utility_bill", "council_tax", "benefit_letters", "mortgage_statement", "mobile_phone_bill", "general_letter", "insurance_statement", "pension_property_statement_letter", "identity_document_with_address", "exchange_house_statement", "unknown_default_open_api"])
  return false unless document_type_validator.valid?(@document_type)
  true
end