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:

  • (defaults to: {})

    Model attributes in the form of hash



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
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
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 84

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?(:'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
end

Instance Attribute Details

#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". This field is optional and will support not-yet-implemented functionality for new products.



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

def date_of_birth
  @date_of_birth
end

#email_address ⇒ Object

The user’s email address. This field is optional, but required to enable the [pre-authenticated returning user flow](plaid.com/docs/link/returning-user/#enabling-the-returning-user-experience).



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

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 is an optional field used in the [returning user experience](plaid.com/docs/link/returning-user). 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`



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

def email_address_verified_time
  @email_address_verified_time
end

#legal_name ⇒ Object

The user’s full legal name. This is an optional field used in the [returning user experience](plaid.com/docs/link/returning-user) to associate Items to the user.



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

def legal_name
  @legal_name
end

#phone_number ⇒ Object

The user’s phone number in [E.164](en.wikipedia.org/wiki/E.164) format. This field is optional, but required to enable the [returning user experience](plaid.com/docs/link/returning-user).



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

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 field is optional, but required to enable any [returning user experience](plaid.com/docs/link/returning-user). 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`



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

def phone_number_verified_time
  @phone_number_verified_time
end

#ssn ⇒ Object

To be provided in the format "ddd-dd-dddd". This field is optional and will support not-yet-implemented functionality for new products.



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

def ssn
  @ssn
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 58

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 44

def self.attribute_map
  {
    :'client_user_id' => :'client_user_id',
    :'legal_name' => :'legal_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'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



178
179
180
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 178

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



77
78
79
80
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 77

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 63

def self.openapi_types
  {
    :'client_user_id' => :'String',
    :'legal_name' => :'String',
    :'phone_number' => :'String',
    :'phone_number_verified_time' => :'Time',
    :'email_address' => :'String',
    :'email_address_verified_time' => :'Time',
    :'ssn' => :'String',
    :'date_of_birth' => :'Date'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 150

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_user_id == o.client_user_id &&
      legal_name == o.legal_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
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 208

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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 279

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:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 185

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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

See Also:

  • `==` method

Parameters:

  • to be compared

Returns:



165
166
167
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 165

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



171
172
173
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 171

def hash
  [client_user_id, legal_name, phone_number, phone_number_verified_time, email_address, email_address_verified_time, ssn, date_of_birth].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



132
133
134
135
136
137
138
139
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 132

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • Returns the object in the form of hash



255
256
257
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 255

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 261

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 presentation of the object



249
250
251
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 249

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • true if the model is valid



143
144
145
146
 
# File 'lib/plaid/models/link_token_create_request_user.rb', line 143

def valid?
  return false if @client_user_id.nil?
  true
end