class Yapstone::GovIdentificationUpdateResource

The goverment identification information.

Attributes

country[RW]

The 3-letter ISO country code of the identification issuer.

display_text[RW]

The display info for the identification.

expiration[RW]

The expiration date of the identication.

gov_id_data_token[RW]

The key to vault that contains the data associated with the government id. This key will be generated when the identification is created at YapStone.

number[RW]

The number associated with the identification.

state[RW]

The state or province of the identification issuer.

type[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/yapstone-so/models/gov_identification_update_resource.rb, line 39
def self.attribute_map
  {
    :'type' => :'type',
    :'display_text' => :'displayText',
    :'gov_id_data_token' => :'govIdDataToken',
    :'number' => :'number',
    :'expiration' => :'expiration',
    :'country' => :'country',
    :'state' => :'state'
  }
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/yapstone-so/models/gov_identification_update_resource.rb, line 215
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/yapstone-so/models/gov_identification_update_resource.rb, line 66
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Yapstone::GovIdentificationUpdateResource` 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 `Yapstone::GovIdentificationUpdateResource`. 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?(:'type')
    self.type = attributes[:'type']
  end

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

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

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

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

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

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

Attribute type mapping.

# File lib/yapstone-so/models/gov_identification_update_resource.rb, line 52
def self.openapi_types
  {
    :'type' => :'GovernmentIdType',
    :'display_text' => :'String',
    :'gov_id_data_token' => :'String',
    :'number' => :'String',
    :'expiration' => :'Date',
    :'country' => :'String',
    :'state' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/yapstone-so/models/gov_identification_update_resource.rb, line 188
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      display_text == o.display_text &&
      gov_id_data_token == o.gov_id_data_token &&
      number == o.number &&
      expiration == o.expiration &&
      country == o.country &&
      state == o.state
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/yapstone-so/models/gov_identification_update_resource.rb, line 243
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
    Yapstone.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/yapstone-so/models/gov_identification_update_resource.rb, line 308
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/yapstone-so/models/gov_identification_update_resource.rb, line 222
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
country=(country) click to toggle source

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

# File lib/yapstone-so/models/gov_identification_update_resource.rb, line 160
def country=(country)
  if !country.nil? && country.to_s.length > 3
    fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 3.'
  end

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

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

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

# File lib/yapstone-so/models/gov_identification_update_resource.rb, line 202
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/yapstone-so/models/gov_identification_update_resource.rb, line 208
def hash
  [type, display_text, gov_id_data_token, number, expiration, country, state].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/yapstone-so/models/gov_identification_update_resource.rb, line 110
def list_invalid_properties
  invalid_properties = Array.new
  pattern = Regexp.new(/.*[^\s].*/)
  if !@number.nil? && @number !~ pattern
    invalid_properties.push("invalid value for \"number\", must conform to the pattern #{pattern}.")
  end

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

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

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

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

  invalid_properties
end
number=(number) click to toggle source

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

# File lib/yapstone-so/models/gov_identification_update_resource.rb, line 149
def number=(number)
  pattern = Regexp.new(/.*[^\s].*/)
  if !number.nil? && number !~ pattern
    fail ArgumentError, "invalid value for \"number\", must conform to the pattern #{pattern}."
  end

  @number = number
end
state=(state) click to toggle source

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

# File lib/yapstone-so/models/gov_identification_update_resource.rb, line 174
def state=(state)
  if !state.nil? && state.to_s.length > 255
    fail ArgumentError, 'invalid value for "state", the character length must be smaller than or equal to 255.'
  end

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

  @state = state
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/yapstone-so/models/gov_identification_update_resource.rb, line 288
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/yapstone-so/models/gov_identification_update_resource.rb, line 294
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/yapstone-so/models/gov_identification_update_resource.rb, line 282
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/yapstone-so/models/gov_identification_update_resource.rb, line 138
def valid?
  return false if !@number.nil? && @number !~ Regexp.new(/.*[^\s].*/)
  return false if !@country.nil? && @country.to_s.length > 3
  return false if !@country.nil? && @country.to_s.length < 3
  return false if !@state.nil? && @state.to_s.length > 255
  return false if !@state.nil? && @state.to_s.length < 2
  true
end