Class: Plaid::LinkTokenCreateRequestUser

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/link_token_create_request_user.rb

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LinkTokenCreateRequestUser

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# 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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



45
46
47
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 45

def address
  @address
end

#client_user_id ⇒ Object

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.



20
21
22
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 20

def client_user_id
  @client_user_id
end

#date_of_birth ⇒ Object

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



43
44
45
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 43

def date_of_birth
  @date_of_birth
end

#email_address ⇒ Object

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



34
35
36
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 34

def email_address
  @email_address
end

#email_address_verified_time ⇒ Object

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`



37
38
39
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 37

def email_address_verified_time
  @email_address_verified_time
end

#id_number ⇒ Object

Returns the value of attribute id_number.



47
48
49
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 47

def id_number
  @id_number
end

#legal_name ⇒ Object

The user’s full legal name, used for [micro-deposit based verification flows](plaid.com/docs/auth/coverage/). For a small number of customers on legacy flows, providing this field is required to enable micro-deposit-based flows. For all other customers, this field is optional. Providing the user’s name in this field when using micro-deposit-based verification will streamline the end user experience, as the user will not be prompted to enter their name during the Link flow; Plaid will use the provided legal name instead.



23
24
25
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 23

def legal_name
  @legal_name
end

#name ⇒ Object

Returns the value of attribute name.



25
26
27
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 25

def name
  @name
end

#phone_number ⇒ Object

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).



28
29
30
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 28

def phone_number
  @phone_number
end

#phone_number_verified_time ⇒ Object

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`



31
32
33
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 31

def phone_number_verified_time
  @phone_number_verified_time
end

#ssn ⇒ Object

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



40
41
42
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 40

def ssn
  @ssn
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 67

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



229
230
231
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 229

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



89
90
91
92
93
94
95
 
# 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 ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# 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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# 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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# 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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


216
217
218
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 216

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



222
223
224
 
# 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 ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# 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 ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



307
308
309
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 307

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



301
302
303
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 301

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



175
176
177
178
179
 
# 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