Class: Plaid::LinkCallbackMetadata

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

Overview

Information related to the callback from the hosted Link session.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LinkCallbackMetadata

Initializes the object



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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 76

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

  if attributes.key?(:'event_name')
    self.event_name = attributes[:'event_name']
  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?(:'request_id')
    self.request_id = attributes[:'request_id']
  end

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

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

Instance Attribute Details

#accounts ⇒ Object

A list of accounts attached to the connected Item. If Account Select is enabled via the developer dashboard, accounts will only include selected accounts.



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

def accounts
  @accounts
end

#callback_type ⇒ Object

Returns the value of attribute callback_type.



19
20
21
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 19

def callback_type
  @callback_type
end

#event_name ⇒ Object

Returns the value of attribute event_name.



21
22
23
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 21

def event_name
  @event_name
end

#institution ⇒ Object

Returns the value of attribute institution.



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

def institution
  @institution
end

#link_session_id ⇒ Object

A unique identifier associated with a user’s actions and events through the Link flow. Include this identifier when opening a support ticket for faster turnaround.



27
28
29
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 27

def link_session_id
  @link_session_id
end

#request_id ⇒ Object

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



30
31
32
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 30

def request_id
  @request_id
end

#status ⇒ Object

Indicates where in the flow the Link user exited



24
25
26
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 24

def status
  @status
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



51
52
53
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 51

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 38

def self.attribute_map
  {
    :'callback_type' => :'callback_type',
    :'event_name' => :'event_name',
    :'status' => :'status',
    :'link_session_id' => :'link_session_id',
    :'request_id' => :'request_id',
    :'institution' => :'institution',
    :'accounts' => :'accounts'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



162
163
164
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 162

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



69
70
71
72
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 69

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

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 56

def self.openapi_types
  {
    :'callback_type' => :'LinkDeliveryWebhookCallbackType',
    :'event_name' => :'LinkEventName',
    :'status' => :'String',
    :'link_session_id' => :'String',
    :'request_id' => :'String',
    :'institution' => :'LinkDeliveryInstitution',
    :'accounts' => :'Array<LinkDeliveryAccount>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 135

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      callback_type == o.callback_type &&
      event_name == o.event_name &&
      status == o.status &&
      link_session_id == o.link_session_id &&
      request_id == o.request_id &&
      institution == o.institution &&
      accounts == o.accounts
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
221
222
223
224
225
226
227
228
229
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 192

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



263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 263

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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 169

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


149
150
151
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 149

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



155
156
157
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 155

def hash
  [callback_type, event_name, status, link_session_id, request_id, institution, accounts].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



122
123
124
125
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 122

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



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

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 245

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



233
234
235
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 233

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



129
130
131
 
# File 'lib/plaid/models/link_callback_metadata.rb', line 129

def valid?
  true
end