Class: Plaid::LinkSessionFinishedWebhook

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

Overview

Contains the state of a completed Link session, along with the public token(s) if available. By default, this webhook is sent only for sessions enabled for the Hosted Link flow (including Link Recovery flows), a Multi-Item Link flow, or a Layer flow. If you would like to receive this webhook for other sessions, contact your Account Manager or Support. This enablement will also enable the EVENTS webhook for all Link sessions and the ability to use /link/token/get to retrieve events for non-Hosted-Link sessions.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LinkSessionFinishedWebhook

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
156
157
158
159
160
 
# File 'lib/plaid/models/link_session_finished_webhook.rb', line 110

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

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

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

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

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

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

  if attributes.key?(:'public_tokens')
    if (value = attributes[:'public_tokens']).is_a?(Array)
      self.public_tokens = value
    end
  end

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

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

Instance Attribute Details

#environment ⇒ Object

Returns the value of attribute environment.



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

def environment
  @environment
end

#link_session_id ⇒ Object

The identifier for the Link session.



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

def link_session_id
  @link_session_id
end

#link_token ⇒ Object

The link token used to create the Link session.



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

def link_token
  @link_token
end

#public_token ⇒ Object

The public token generated by the Link session. This field has been deprecated; please use public_tokens instead.



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

def public_token
  @public_token
end

#public_tokens ⇒ Object

The public tokens generated by the Link session.



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

def public_tokens
  @public_tokens
end

#status ⇒ Object

The final status of the Link session. Will always be "SUCCESS" or "EXITED".



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

def status
  @status
end

#user_id ⇒ Object

The Plaid user_id of the User associated with this webhook, warning, or error.



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

def user_id
  @user_id
end

#webhook_code ⇒ Object

SESSION_FINISHED



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

def webhook_code
  @webhook_code
end

#webhook_type ⇒ Object

LINK



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

def webhook_type
  @webhook_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



83
84
85
 
# File 'lib/plaid/models/link_session_finished_webhook.rb', line 83

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/plaid/models/link_session_finished_webhook.rb', line 68

def self.attribute_map
  {
    :'webhook_type' => :'webhook_type',
    :'webhook_code' => :'webhook_code',
    :'status' => :'status',
    :'link_session_id' => :'link_session_id',
    :'link_token' => :'link_token',
    :'public_token' => :'public_token',
    :'public_tokens' => :'public_tokens',
    :'user_id' => :'user_id',
    :'environment' => :'environment'
  }
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
 
# File 'lib/plaid/models/link_session_finished_webhook.rb', line 236

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
 
# File 'lib/plaid/models/link_session_finished_webhook.rb', line 103

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

.openapi_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/plaid/models/link_session_finished_webhook.rb', line 88

def self.openapi_types
  {
    :'webhook_type' => :'String',
    :'webhook_code' => :'String',
    :'status' => :'String',
    :'link_session_id' => :'String',
    :'link_token' => :'String',
    :'public_token' => :'String',
    :'public_tokens' => :'Array<String>',
    :'user_id' => :'String',
    :'environment' => :'WebhookEnvironmentValues'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/plaid/models/link_session_finished_webhook.rb', line 207

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      webhook_type == o.webhook_type &&
      webhook_code == o.webhook_code &&
      status == o.status &&
      link_session_id == o.link_session_id &&
      link_token == o.link_token &&
      public_token == o.public_token &&
      public_tokens == o.public_tokens &&
      user_id == o.user_id &&
      environment == o.environment
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



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
298
299
300
301
302
303
304
 
# File 'lib/plaid/models/link_session_finished_webhook.rb', line 267

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



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/plaid/models/link_session_finished_webhook.rb', line 338

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/plaid/models/link_session_finished_webhook.rb', line 243

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


223
224
225
 
# File 'lib/plaid/models/link_session_finished_webhook.rb', line 223

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [webhook_type, webhook_code, status, link_session_id, link_token, public_token, public_tokens, user_id, environment].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



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_session_finished_webhook.rb', line 164

def list_invalid_properties
  invalid_properties = Array.new
  if @webhook_type.nil?
    invalid_properties.push('invalid value for "webhook_type", webhook_type cannot be nil.')
  end

  if @webhook_code.nil?
    invalid_properties.push('invalid value for "webhook_code", webhook_code cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @link_session_id.nil?
    invalid_properties.push('invalid value for "link_session_id", link_session_id cannot be nil.')
  end

  if @link_token.nil?
    invalid_properties.push('invalid value for "link_token", link_token cannot be nil.')
  end

  if @environment.nil?
    invalid_properties.push('invalid value for "environment", environment 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



314
315
316
 
# File 'lib/plaid/models/link_session_finished_webhook.rb', line 314

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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/plaid/models/link_session_finished_webhook.rb', line 320

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



308
309
310
 
# File 'lib/plaid/models/link_session_finished_webhook.rb', line 308

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



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

def valid?
  return false if @webhook_type.nil?
  return false if @webhook_code.nil?
  return false if @status.nil?
  return false if @link_session_id.nil?
  return false if @link_token.nil?
  return false if @environment.nil?
  true
end