class Plaid::LinkTokenCreateRequestUser

An object specifying information about the end user who will be linking their account.

Attributes

address[RW]
client_user_id[RW]

A unique ID representing the end user. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the ‘client_user_id`. It is currently used as a means of searching logs for the given user in the Plaid Dashboard.

date_of_birth[RW]

To be provided in the format "yyyy-mm-dd". Can be used to prefill Link fields when used with Identity Verification.

email_address[RW]

The user’s email address. Can be used to prefill Link fields when used with [Identity Verification](www.plaid.com/docs/identity-verification).

email_address_verified_time[RW]

The date and time the email address was verified in [ISO 8601](wikipedia.org/wiki/ISO_8601) format (‘YYYY-MM-DDThh:mm:ssZ`). This was previously an optional field used in the [returning user experience](plaid.com/docs/link/returning-user). This field is no longer required to enable the returning user experience. Only pass a verification time for an email address that you have verified. If you have performed verification but don’t have the time, you may supply a signal value of the start of the UNIX epoch. Example: `2020-01-01T00:00:00Z`

id_number[RW]
name[RW]
phone_number[RW]

The user’s phone number in [E.164](en.wikipedia.org/wiki/E.164) format. If supplied, will be used when applicable to prefill phone number fields in Link for the [returning user flow](www.plaid.com/docs/link/returning-user) and the [Identity Verification flow](www.plaid.com/docs/identity-verification).

phone_number_verified_time[RW]

The date and time the phone number was verified in [ISO 8601](wikipedia.org/wiki/ISO_8601) format (‘YYYY-MM-DDThh:mm:ssZ`). This was previously an optional field used in the [returning user experience](plaid.com/docs/link/returning-user). This field is no longer required to enable the returning user experience. Only pass a verification time for a phone number that you have verified. If you have performed verification but don’t have the time, you may supply a signal value of the start of the UNIX epoch. Example: `2020-01-01T00:00:00Z`

ssn[RW]

Deprecated and not currently used, use the ‘id_number` field instead.

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/plaid/models/link_token_create_request_user.rb, line 67
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/link_token_create_request_user.rb, line 50
def self.attribute_map
  {
    :'client_user_id' => :'client_user_id',
    :'legal_name' => :'legal_name',
    :'name' => :'name',
    :'phone_number' => :'phone_number',
    :'phone_number_verified_time' => :'phone_number_verified_time',
    :'email_address' => :'email_address',
    :'email_address_verified_time' => :'email_address_verified_time',
    :'ssn' => :'ssn',
    :'date_of_birth' => :'date_of_birth',
    :'address' => :'address',
    :'id_number' => :'id_number'
  }
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/link_token_create_request_user.rb, line 229
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/link_token_create_request_user.rb, line 99
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::LinkTokenCreateRequestUser` 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::LinkTokenCreateRequestUser`. 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?(:'client_user_id')
    self.client_user_id = attributes[:'client_user_id']
  end

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/plaid/models/link_token_create_request_user.rb, line 89
def self.openapi_nullable
  Set.new([
    :'phone_number_verified_time',
    :'email_address_verified_time',
    :'date_of_birth',
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/plaid/models/link_token_create_request_user.rb, line 72
def self.openapi_types
  {
    :'client_user_id' => :'String',
    :'legal_name' => :'String',
    :'name' => :'LinkTokenCreateRequestUserName',
    :'phone_number' => :'String',
    :'phone_number_verified_time' => :'Time',
    :'email_address' => :'String',
    :'email_address_verified_time' => :'Time',
    :'ssn' => :'String',
    :'date_of_birth' => :'Date',
    :'address' => :'LinkTokenCreateRequestUserAddress',
    :'id_number' => :'LinkTokenCreateRequestUserIdNumber'
  }
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/link_token_create_request_user.rb, line 198
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_user_id == o.client_user_id &&
      legal_name == o.legal_name &&
      name == o.name &&
      phone_number == o.phone_number &&
      phone_number_verified_time == o.phone_number_verified_time &&
      email_address == o.email_address &&
      email_address_verified_time == o.email_address_verified_time &&
      ssn == o.ssn &&
      date_of_birth == o.date_of_birth &&
      address == o.address &&
      id_number == o.id_number
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/link_token_create_request_user.rb, line 260
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/link_token_create_request_user.rb, line 331
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/link_token_create_request_user.rb, line 236
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
client_user_id=(client_user_id) click to toggle source

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

# File lib/plaid/models/link_token_create_request_user.rb, line 183
def client_user_id=(client_user_id)
  if client_user_id.nil?
    fail ArgumentError, 'client_user_id cannot be nil'
  end

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


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

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

# File lib/plaid/models/link_token_create_request_user.rb, line 216
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/link_token_create_request_user.rb, line 222
def hash
  [client_user_id, legal_name, name, phone_number, phone_number_verified_time, email_address, email_address_verified_time, ssn, date_of_birth, address, id_number].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/link_token_create_request_user.rb, line 159
def list_invalid_properties
  invalid_properties = Array.new
  if @client_user_id.nil?
    invalid_properties.push('invalid value for "client_user_id", client_user_id cannot be nil.')
  end

  if @client_user_id.to_s.length < 1
    invalid_properties.push('invalid value for "client_user_id", the character length must be great than or equal to 1.')
  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/plaid/models/link_token_create_request_user.rb, line 307
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/link_token_create_request_user.rb, line 313
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/link_token_create_request_user.rb, line 301
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/link_token_create_request_user.rb, line 175
def valid?
  return false if @client_user_id.nil?
  return false if @client_user_id.to_s.length < 1
  true
end