Class: Plaid::LinkEventMetadata

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

Overview

Metadata about an event that occured while the user was going through Link

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LinkEventMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/plaid/models/link_event_metadata.rb', line 119

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_number_mask ⇒ Object

The account number mask extracted from the user-provided account number. If the user-inputted account number is four digits long, ‘account_number_mask` is empty. Emitted by `SUBMIT_ACCOUNT_NUMBER`.



62
63
64
 
# File 'lib/plaid/models/link_event_metadata.rb', line 62

def 
  @account_number_mask
end

#brand_name ⇒ Object

The name of the selected brand.



53
54
55
 
# File 'lib/plaid/models/link_event_metadata.rb', line 53

def brand_name
  @brand_name
end

#error_code ⇒ Object

The error code that the user encountered. Emitted by ‘ERROR`, `EXIT`.



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

def error_code
  @error_code
end

#error_message ⇒ Object

The error message that the user encountered. Emitted by: ‘ERROR`, `EXIT`.



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

def error_message
  @error_message
end

#error_type ⇒ Object

The error type that the user encountered. Emitted by: ‘ERROR`, `EXIT`.



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

def error_type
  @error_type
end

#exit_status ⇒ Object

The status key indicates the point at which the user exited the Link flow. Emitted by: ‘EXIT`.



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

def exit_status
  @exit_status
end

#institution_id ⇒ Object

The ID of the selected institution. Emitted by: all events.



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

def institution_id
  @institution_id
end

#institution_name ⇒ Object

The name of the selected institution. Emitted by: all events.



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

def institution_name
  @institution_name
end

#institution_search_query ⇒ Object

The query used to search for institutions. Emitted by: ‘SEARCH_INSTITUTION`.



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

def institution_search_query
  @institution_search_query
end

#match_reason ⇒ Object

The reason this institution was matched, which will be either ‘returning_user` or `routing_number`. Emitted by: `MATCHED_SELECT_INSTITUTION`.



56
57
58
 
# File 'lib/plaid/models/link_event_metadata.rb', line 56

def match_reason
  @match_reason
end

#mfa_type ⇒ Object

If set, the user has encountered one of the following MFA types: code, device, questions, selections. Emitted by: ‘SUBMIT_MFA` and `TRANSITION_VIEW` when view_name is `MFA`.



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

def mfa_type
  @mfa_type
end

#request_id ⇒ Object

The request ID for the last request made by Link. This can be shared with Plaid Support to expedite investigation. Emitted by: all events.



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

def request_id
  @request_id
end

#routing_number ⇒ Object

The routing number submitted by user at the micro-deposits routing number pane. Emitted by ‘SUBMIT_ROUTING_NUMBER`.



59
60
61
 
# File 'lib/plaid/models/link_event_metadata.rb', line 59

def routing_number
  @routing_number
end

#selection ⇒ Object

Either the verification method for a matched institution selected by the user or the Auth Type Select flow type selected by the user. If selection is used to describe selected verification method, then possible values are ‘phoneotp` or `password`; if selection is used to describe the selected Auth Type Select flow, then possible values are `flow_type_manual` or `flow_type_instant`. Emitted by: `MATCHED_SELECT_VERIFY_METHOD` and `SELECT_AUTH_TYPE`.



50
51
52
 
# File 'lib/plaid/models/link_event_metadata.rb', line 50

def selection
  @selection
end

#view_name ⇒ Object

The name of the view that is being transitioned to. Emitted by: ‘TRANSITION_VIEW`.



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

def view_name
  @view_name
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



86
87
88
 
# File 'lib/plaid/models/link_event_metadata.rb', line 86

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/plaid/models/link_event_metadata.rb', line 65

def self.attribute_map
  {
    :'error_code' => :'error_code',
    :'error_message' => :'error_message',
    :'error_type' => :'error_type',
    :'exit_status' => :'exit_status',
    :'institution_id' => :'institution_id',
    :'institution_name' => :'institution_name',
    :'institution_search_query' => :'institution_search_query',
    :'request_id' => :'request_id',
    :'mfa_type' => :'mfa_type',
    :'view_name' => :'view_name',
    :'selection' => :'selection',
    :'brand_name' => :'brand_name',
    :'match_reason' => :'match_reason',
    :'routing_number' => :'routing_number',
    :'account_number_mask' => :'account_number_mask'
  }
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



248
249
250
 
# File 'lib/plaid/models/link_event_metadata.rb', line 248

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



112
113
114
115
 
# File 'lib/plaid/models/link_event_metadata.rb', line 112

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

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/plaid/models/link_event_metadata.rb', line 91

def self.openapi_types
  {
    :'error_code' => :'String',
    :'error_message' => :'String',
    :'error_type' => :'String',
    :'exit_status' => :'String',
    :'institution_id' => :'String',
    :'institution_name' => :'String',
    :'institution_search_query' => :'String',
    :'request_id' => :'String',
    :'mfa_type' => :'String',
    :'view_name' => :'String',
    :'selection' => :'String',
    :'brand_name' => :'String',
    :'match_reason' => :'String',
    :'routing_number' => :'String',
    :'account_number_mask' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/plaid/models/link_event_metadata.rb', line 213

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      error_code == o.error_code &&
      error_message == o.error_message &&
      error_type == o.error_type &&
      exit_status == o.exit_status &&
      institution_id == o.institution_id &&
      institution_name == o.institution_name &&
      institution_search_query == o.institution_search_query &&
      request_id == o.request_id &&
      mfa_type == o.mfa_type &&
      view_name == o.view_name &&
      selection == o.selection &&
      brand_name == o.brand_name &&
      match_reason == o.match_reason &&
      routing_number == o.routing_number &&
       == o.
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



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
308
309
310
311
312
313
314
315
 
# File 'lib/plaid/models/link_event_metadata.rb', line 278

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



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/plaid/models/link_event_metadata.rb', line 349

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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/plaid/models/link_event_metadata.rb', line 255

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


235
236
237
 
# File 'lib/plaid/models/link_event_metadata.rb', line 235

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



241
242
243
 
# File 'lib/plaid/models/link_event_metadata.rb', line 241

def hash
  [error_code, error_message, error_type, exit_status, institution_id, institution_name, institution_search_query, request_id, mfa_type, view_name, selection, brand_name, match_reason, routing_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



195
196
197
198
199
200
201
202
 
# File 'lib/plaid/models/link_event_metadata.rb', line 195

def list_invalid_properties
  invalid_properties = Array.new
  if @request_id.nil?
    invalid_properties.push('invalid value for "request_id", request_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



325
326
327
 
# File 'lib/plaid/models/link_event_metadata.rb', line 325

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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/plaid/models/link_event_metadata.rb', line 331

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



319
320
321
 
# File 'lib/plaid/models/link_event_metadata.rb', line 319

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



206
207
208
209
 
# File 'lib/plaid/models/link_event_metadata.rb', line 206

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