Class: MoneyKit::PlaidCompatible::LinkTokenCreateRequestUser

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid_compatible/money_kit_plaid_compatible/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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request_user.rb', line 72

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError,
          'The input argument (attributes) must be a hash in `MoneyKit::PlaidCompatible::LinkTokenCreateRequestUser` initialize method'
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    unless self.class.attribute_map.key?(k.to_sym)
      raise ArgumentError,
            "`#{k}` is not a valid attribute in `MoneyKit::PlaidCompatible::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
  end

  self.client_user_id = attributes[:client_user_id] if attributes.key?(:client_user_id)

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

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

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

  return unless attributes.key?(:email_address_verified_time)

  self.email_address_verified_time = attributes[:email_address_verified_time]
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.



19
20
21
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request_user.rb', line 19

def client_user_id
  @client_user_id
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/#pre-authenticated-rux).



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

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`



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

def email_address_verified_time
  @email_address_verified_time
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).



22
23
24
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request_user.rb', line 22

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`



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

def phone_number_verified_time
  @phone_number_verified_time
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request_user.rb', line 34

def self.attribute_map
  {
    'client_user_id': :client_user_id,
    'phone_number': :phone_number,
    'phone_number_verified_time': :phone_number_verified_time,
    'email_address': :email_address,
    'email_address_verified_time': :email_address_verified_time
  }
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



150
151
152
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request_user.rb', line 150

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



61
62
63
64
65
66
67
68
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request_user.rb', line 61

def self.openapi_nullable
  Set.new(%i[
            phone_number
            phone_number_verified_time
            email_address
            email_address_verified_time
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request_user.rb', line 50

def self.openapi_types
  {
    'client_user_id': :String,
    'phone_number': :String,
    'phone_number_verified_time': :Time,
    'email_address': :String,
    'email_address_verified_time': :Time
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



124
125
126
127
128
129
130
131
132
133
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request_user.rb', line 124

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    client_user_id == other.client_user_id &&
    phone_number == other.phone_number &&
    phone_number_verified_time == other.phone_number_verified_time &&
    email_address == other.email_address &&
    email_address_verified_time == other.email_address_verified_time
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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request_user.rb', line 183

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 = MoneyKit::PlaidCompatible.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



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request_user.rb', line 254

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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request_user.rb', line 157

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)
      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)
        send("#{key}=", attributes[self.class.attribute_map[key]].map do |v|
                          _deserialize(::Regexp.last_match(1), v)
                        end)
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


137
138
139
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request_user.rb', line 137

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



143
144
145
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request_user.rb', line 143

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



105
106
107
108
109
110
111
112
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request_user.rb', line 105

def list_invalid_properties
  invalid_properties = []
  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:

  • (Hash) —

    Returns the object in the form of hash



230
231
232
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request_user.rb', line 230

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



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request_user.rb', line 236

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



224
225
226
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request_user.rb', line 224

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



116
117
118
119
120
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/link_token_create_request_user.rb', line 116

def valid?
  return false if @client_user_id.nil?

  true
end