Class: Plaid::LinkTokenCreateRequestAuth

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

Overview

Specifies options for initializing Link for use with the Auth product. This field can be used to enable or disable extended Auth flows for the resulting Link session. Omitting any field will result in a default that can be configured by your account manager. The default behavior described in the documentation is the default behavior that will apply if you have not requested your account manager to apply a different default. If you have enabled the [Dashboard Account Verification pane](dashboard.plaid.com/account-verification), the settings enabled there will override any settings in this object.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LinkTokenCreateRequestAuth

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/plaid/models/link_token_create_request_auth.rb', line 116

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::LinkTokenCreateRequestAuth` 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::LinkTokenCreateRequestAuth`. 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?(:'auth_type_select_enabled')
    self.auth_type_select_enabled = attributes[:'auth_type_select_enabled']
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#auth_type_select_enabled ⇒ Object

Specifies whether Auth Type Select is enabled for the Link session, allowing the end user to choose between linking via a credentials-based flow (i.e. Instant Auth, Instant Match, Automated Micro-deposits) or a manual flow that does not require login (all other Auth flows) prior to selecting their financial institution. Default behavior is ‘false`.



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

def auth_type_select_enabled
  @auth_type_select_enabled
end

#automated_microdeposits_enabled ⇒ Object

Specifies whether the Link session is enabled for the Automated Micro-deposits flow. Default behavior is ‘false`.



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

def automated_microdeposits_enabled
  @automated_microdeposits_enabled
end

#database_insights_enabled ⇒ Object

Database Insights has been deprecated and replaced with Database Auth. Use the [Account Verification Dashboard](dashboard.plaid.com/account-verification) to enable Database Auth.



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

def database_insights_enabled
  @database_insights_enabled
end

#database_match_enabled ⇒ Object

Database Match has been deprecated and replaced with Database Auth. Use the [Account Verification Dashboard](dashboard.plaid.com/account-verification) to enable Database Auth.



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

def database_match_enabled
  @database_match_enabled
end

#flow_type ⇒ Object

This field has been deprecated in favor of ‘auth_type_select_enabled`.



44
45
46
 
# File 'lib/plaid/models/link_token_create_request_auth.rb', line 44

def flow_type
  @flow_type
end

#instant_match_enabled ⇒ Object

Specifies whether the Link session is enabled for the Instant Match flow. Instant Match is enabled by default. Instant Match can be disabled by setting this field to ‘false`.



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

def instant_match_enabled
  @instant_match_enabled
end

#instant_microdeposits_enabled ⇒ Object

Specifies whether the Link session is enabled for the Instant Micro-deposits flow. Default behavior for Plaid teams created after November 2023 is ‘false`; default behavior for Plaid teams created before that date is `true`.



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

def instant_microdeposits_enabled
  @instant_microdeposits_enabled
end

#reroute_to_credentials ⇒ Object

Specifies what type of [Reroute to Credentials](plaid.com/docs/auth/coverage/flow-options/#removing-manual-verification-entry-points-with-reroute-to-credentials) pane should be used in the Link session for the Same Day Micro-deposits flow. Default behavior is ‘OPTIONAL`.



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

def reroute_to_credentials
  @reroute_to_credentials
end

#same_day_microdeposits_enabled ⇒ Object

Specifies whether the Link session is enabled for the Same Day Micro-deposits flow. Default behavior is ‘false`.



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

def same_day_microdeposits_enabled
  @same_day_microdeposits_enabled
end

#sms_microdeposits_verification_enabled ⇒ Object

Specifies whether the Link session is enabled for SMS micro-deposits verification. Default behavior is ‘true`.



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

def sms_microdeposits_verification_enabled
  @sms_microdeposits_verification_enabled
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



88
89
90
 
# File 'lib/plaid/models/link_token_create_request_auth.rb', line 88

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/plaid/models/link_token_create_request_auth.rb', line 72

def self.attribute_map
  {
    :'auth_type_select_enabled' => :'auth_type_select_enabled',
    :'automated_microdeposits_enabled' => :'automated_microdeposits_enabled',
    :'instant_match_enabled' => :'instant_match_enabled',
    :'same_day_microdeposits_enabled' => :'same_day_microdeposits_enabled',
    :'instant_microdeposits_enabled' => :'instant_microdeposits_enabled',
    :'reroute_to_credentials' => :'reroute_to_credentials',
    :'database_match_enabled' => :'database_match_enabled',
    :'database_insights_enabled' => :'database_insights_enabled',
    :'flow_type' => :'flow_type',
    :'sms_microdeposits_verification_enabled' => :'sms_microdeposits_verification_enabled'
  }
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



239
240
241
 
# File 'lib/plaid/models/link_token_create_request_auth.rb', line 239

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



109
110
111
112
 
# File 'lib/plaid/models/link_token_create_request_auth.rb', line 109

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

.openapi_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/plaid/models/link_token_create_request_auth.rb', line 93

def self.openapi_types
  {
    :'auth_type_select_enabled' => :'Boolean',
    :'automated_microdeposits_enabled' => :'Boolean',
    :'instant_match_enabled' => :'Boolean',
    :'same_day_microdeposits_enabled' => :'Boolean',
    :'instant_microdeposits_enabled' => :'Boolean',
    :'reroute_to_credentials' => :'String',
    :'database_match_enabled' => :'Boolean',
    :'database_insights_enabled' => :'Boolean',
    :'flow_type' => :'String',
    :'sms_microdeposits_verification_enabled' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/plaid/models/link_token_create_request_auth.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auth_type_select_enabled == o.auth_type_select_enabled &&
      automated_microdeposits_enabled == o.automated_microdeposits_enabled &&
      instant_match_enabled == o.instant_match_enabled &&
      same_day_microdeposits_enabled == o.same_day_microdeposits_enabled &&
      instant_microdeposits_enabled == o.instant_microdeposits_enabled &&
      reroute_to_credentials == o.reroute_to_credentials &&
      database_match_enabled == o.database_match_enabled &&
      database_insights_enabled == o.database_insights_enabled &&
      flow_type == o.flow_type &&
      sms_microdeposits_verification_enabled == o.sms_microdeposits_verification_enabled
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



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
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/plaid/models/link_token_create_request_auth.rb', line 270

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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/plaid/models/link_token_create_request_auth.rb', line 341

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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/plaid/models/link_token_create_request_auth.rb', line 246

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


226
227
228
 
# File 'lib/plaid/models/link_token_create_request_auth.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



232
233
234
 
# File 'lib/plaid/models/link_token_create_request_auth.rb', line 232

def hash
  [auth_type_select_enabled, automated_microdeposits_enabled, instant_match_enabled, same_day_microdeposits_enabled, instant_microdeposits_enabled, reroute_to_credentials, database_match_enabled, database_insights_enabled, flow_type, sms_microdeposits_verification_enabled].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



172
173
174
175
 
# File 'lib/plaid/models/link_token_create_request_auth.rb', line 172

def list_invalid_properties
  invalid_properties = Array.new
  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



317
318
319
 
# File 'lib/plaid/models/link_token_create_request_auth.rb', line 317

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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/plaid/models/link_token_create_request_auth.rb', line 323

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



311
312
313
 
# File 'lib/plaid/models/link_token_create_request_auth.rb', line 311

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



179
180
181
182
183
184
185
 
# File 'lib/plaid/models/link_token_create_request_auth.rb', line 179

def valid?
  reroute_to_credentials_validator = EnumAttributeValidator.new('String', ["OFF", "OPTIONAL", "FORCED"])
  return false unless reroute_to_credentials_validator.valid?(@reroute_to_credentials)
  flow_type_validator = EnumAttributeValidator.new('String', ["FLEXIBLE_AUTH"])
  return false unless flow_type_validator.valid?(@flow_type)
  true
end