class Yapstone::NameResource

The name of the person. It will consist of first, middle, last, additionalLast, honorificPrefix, and honorificSuffix.

Attributes

additional_last[RW]

The 2nd last name of the person.

first[RW]

The persons first name.

honorific_prefix[RW]

The persons title.

honorific_suffix[RW]

The persons title.

last[RW]

The persons last name.

middle[RW]

The persons middle name or initial.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/yapstone-so/models/name_resource.rb, line 59
def self.attribute_map
  {
    :'honorific_prefix' => :'honorificPrefix',
    :'first' => :'first',
    :'middle' => :'middle',
    :'last' => :'last',
    :'additional_last' => :'additionalLast',
    :'honorific_suffix' => :'honorificSuffix'
  }
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/name_resource.rb, line 337
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/name_resource.rb, line 84
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Yapstone::NameResource` 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::NameResource`. 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?(:'honorific_prefix')
    self.honorific_prefix = attributes[:'honorific_prefix']
  end

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

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

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

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

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

Attribute type mapping.

# File lib/yapstone-so/models/name_resource.rb, line 71
def self.openapi_types
  {
    :'honorific_prefix' => :'String',
    :'first' => :'String',
    :'middle' => :'String',
    :'last' => :'String',
    :'additional_last' => :'String',
    :'honorific_suffix' => :'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/name_resource.rb, line 311
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      honorific_prefix == o.honorific_prefix &&
      first == o.first &&
      middle == o.middle &&
      last == o.last &&
      additional_last == o.additional_last &&
      honorific_suffix == o.honorific_suffix
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/name_resource.rb, line 365
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/name_resource.rb, line 430
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
additional_last=(additional_last) click to toggle source

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

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

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

  pattern = Regexp.new(/.*[^\s].*/)
  if !additional_last.nil? && additional_last !~ pattern
    fail ArgumentError, "invalid value for \"additional_last\", must conform to the pattern #{pattern}."
  end

  @additional_last = additional_last
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/name_resource.rb, line 344
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
eql?(o) click to toggle source

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

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

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

# File lib/yapstone-so/models/name_resource.rb, line 222
def first=(first)
  if first.nil?
    fail ArgumentError, 'first cannot be nil'
  end

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

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

  pattern = Regexp.new(/.*[^\s].*/)
  if first !~ pattern
    fail ArgumentError, "invalid value for \"first\", must conform to the pattern #{pattern}."
  end

  @first = first
end
hash() click to toggle source

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

# File lib/yapstone-so/models/name_resource.rb, line 330
def hash
  [honorific_prefix, first, middle, last, additional_last, honorific_suffix].hash
end
honorific_prefix=(honorific_prefix) click to toggle source

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

# File lib/yapstone-so/models/name_resource.rb, line 212
def honorific_prefix=(honorific_prefix)
  validator = EnumAttributeValidator.new('String', ["MR", "MRS", "MS", "MISS", "DR"])
  unless validator.valid?(honorific_prefix)
    fail ArgumentError, "invalid value for \"honorific_prefix\", must be one of #{validator.allowable_values}."
  end
  @honorific_prefix = honorific_prefix
end
honorific_suffix=(honorific_suffix) click to toggle source

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

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

  @honorific_suffix = honorific_suffix
end
last=(last) click to toggle source

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

# File lib/yapstone-so/models/name_resource.rb, line 259
def last=(last)
  if last.nil?
    fail ArgumentError, 'last cannot be nil'
  end

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

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

  pattern = Regexp.new(/.*[^\s].*/)
  if last !~ pattern
    fail ArgumentError, "invalid value for \"last\", must conform to the pattern #{pattern}."
  end

  @last = last
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/name_resource.rb, line 124
def list_invalid_properties
  invalid_properties = Array.new
  if @first.nil?
    invalid_properties.push('invalid value for "first", first cannot be nil.')
  end

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

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

  pattern = Regexp.new(/.*[^\s].*/)
  if @first !~ pattern
    invalid_properties.push("invalid value for \"first\", must conform to the pattern #{pattern}.")
  end

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

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

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

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

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

  pattern = Regexp.new(/.*[^\s].*/)
  if @last !~ pattern
    invalid_properties.push("invalid value for \"last\", must conform to the pattern #{pattern}.")
  end

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

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

  pattern = Regexp.new(/.*[^\s].*/)
  if !@additional_last.nil? && @additional_last !~ pattern
    invalid_properties.push("invalid value for \"additional_last\", must conform to the pattern #{pattern}.")
  end

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

  invalid_properties
end
middle=(middle) click to toggle source

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

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

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

  @middle = middle
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/name_resource.rb, line 410
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/name_resource.rb, line 416
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/name_resource.rb, line 404
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/name_resource.rb, line 190
def valid?
  honorific_prefix_validator = EnumAttributeValidator.new('String', ["MR", "MRS", "MS", "MISS", "DR"])
  return false unless honorific_prefix_validator.valid?(@honorific_prefix)
  return false if @first.nil?
  return false if @first.to_s.length > 100
  return false if @first.to_s.length < 1
  return false if @first !~ Regexp.new(/.*[^\s].*/)
  return false if !@middle.nil? && @middle.to_s.length > 25
  return false if !@middle.nil? && @middle.to_s.length < 1
  return false if @last.nil?
  return false if @last.to_s.length > 100
  return false if @last.to_s.length < 1
  return false if @last !~ Regexp.new(/.*[^\s].*/)
  return false if !@additional_last.nil? && @additional_last.to_s.length > 100
  return false if !@additional_last.nil? && @additional_last.to_s.length < 2
  return false if !@additional_last.nil? && @additional_last !~ Regexp.new(/.*[^\s].*/)
  return false if !@honorific_suffix.nil? && @honorific_suffix.to_s.length > 25
  true
end