Class: Plaid::InstitutionStatus

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

Overview

The status of an institution is determined by the health of its Item logins, Transactions updates, Investments updates, Liabilities updates, Auth requests, Balance requests, Identity requests, Investments requests, and Liabilities requests. A login attempt is conducted during the initial Item add in Link. If there is not enough traffic to accurately calculate an institution’s status, Plaid will return null rather than potentially inaccurate data. Institution status is accessible in the Dashboard and via the API using the ‘/institutions/get_by_id` endpoint with the `include_status` option set to true. Note that institution status is not available in the Sandbox environment.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstitutionStatus

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/plaid/models/institution_status.rb', line 90

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#auth ⇒ Object

Returns the value of attribute auth.



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

def auth
  @auth
end

#health_incidents ⇒ Object

Details of recent health incidents associated with the institution.



36
37
38
 
# File 'lib/plaid/models/institution_status.rb', line 36

def health_incidents
  @health_incidents
end

#identity ⇒ Object

Returns the value of attribute identity.



25
26
27
 
# File 'lib/plaid/models/institution_status.rb', line 25

def identity
  @identity
end

#investments ⇒ Object

Returns the value of attribute investments.



33
34
35
 
# File 'lib/plaid/models/institution_status.rb', line 33

def investments
  @investments
end

#investments_updates ⇒ Object

Returns the value of attribute investments_updates.



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

def investments_updates
  @investments_updates
end

#item_logins ⇒ Object

Returns the value of attribute item_logins.



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

def item_logins
  @item_logins
end

#liabilities ⇒ Object

Returns the value of attribute liabilities.



31
32
33
 
# File 'lib/plaid/models/institution_status.rb', line 31

def liabilities
  @liabilities
end

#liabilities_updates ⇒ Object

Returns the value of attribute liabilities_updates.



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

def liabilities_updates
  @liabilities_updates
end

#transactions_updates ⇒ Object

Returns the value of attribute transactions_updates.



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

def transactions_updates
  @transactions_updates
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



54
55
56
 
# File 'lib/plaid/models/institution_status.rb', line 54

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/plaid/models/institution_status.rb', line 39

def self.attribute_map
  {
    :'item_logins' => :'item_logins',
    :'transactions_updates' => :'transactions_updates',
    :'auth' => :'auth',
    :'identity' => :'identity',
    :'investments_updates' => :'investments_updates',
    :'liabilities_updates' => :'liabilities_updates',
    :'liabilities' => :'liabilities',
    :'investments' => :'investments',
    :'health_incidents' => :'health_incidents'
  }
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



186
187
188
 
# File 'lib/plaid/models/institution_status.rb', line 186

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
    :'item_logins',
    :'transactions_updates',
    :'auth',
    :'identity',
    :'investments_updates',
    :'liabilities_updates',
    :'liabilities',
    :'investments',
    :'health_incidents'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/plaid/models/institution_status.rb', line 59

def self.openapi_types
  {
    :'item_logins' => :'ProductStatus',
    :'transactions_updates' => :'ProductStatus',
    :'auth' => :'ProductStatus',
    :'identity' => :'ProductStatus',
    :'investments_updates' => :'ProductStatus',
    :'liabilities_updates' => :'ProductStatus',
    :'liabilities' => :'ProductStatus',
    :'investments' => :'ProductStatus',
    :'health_incidents' => :'Array<HealthIncident>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/plaid/models/institution_status.rb', line 157

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      item_logins == o.item_logins &&
      transactions_updates == o.transactions_updates &&
      auth == o.auth &&
      identity == o.identity &&
      investments_updates == o.investments_updates &&
      liabilities_updates == o.liabilities_updates &&
      liabilities == o.liabilities &&
      investments == o.investments &&
      health_incidents == o.health_incidents
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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/plaid/models/institution_status.rb', line 217

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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/plaid/models/institution_status.rb', line 288

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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/plaid/models/institution_status.rb', line 193

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



179
180
181
 
# File 'lib/plaid/models/institution_status.rb', line 179

def hash
  [item_logins, transactions_updates, auth, identity, investments_updates, liabilities_updates, liabilities, investments, health_incidents].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



144
145
146
147
 
# File 'lib/plaid/models/institution_status.rb', line 144

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



264
265
266
 
# File 'lib/plaid/models/institution_status.rb', line 264

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



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/plaid/models/institution_status.rb', line 270

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



258
259
260
 
# File 'lib/plaid/models/institution_status.rb', line 258

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



151
152
153
 
# File 'lib/plaid/models/institution_status.rb', line 151

def valid?
  true
end