Class: ThePlaidApi::LinkSessionSuccessMetadataInstitution

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/the_plaid_api/models/link_session_success_metadata_institution.rb

Overview

An institution object. If the Item was created via Same-Day or Instant micro-deposit verification, will be ‘null`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(name: SKIP, institution_id: SKIP, additional_properties: nil) ⇒ LinkSessionSuccessMetadataInstitution

Returns a new instance of LinkSessionSuccessMetadataInstitution.



42
43
44
45
46
47
48
49
 
# File 'lib/the_plaid_api/models/link_session_success_metadata_institution.rb', line 42

def initialize(name: SKIP, institution_id: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @name = name unless name == SKIP
  @institution_id = institution_id unless institution_id == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#institution_id ⇒ String

The Plaid institution identifier

Returns:

  • (String) 


19
20
21
 
# File 'lib/the_plaid_api/models/link_session_success_metadata_institution.rb', line 19

def institution_id
  @institution_id
end

#name ⇒ String

The full institution name, such as ‘’Wells Fargo’‘

Returns:

  • (String) 


15
16
17
 
# File 'lib/the_plaid_api/models/link_session_success_metadata_institution.rb', line 15

def name
  @name
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/the_plaid_api/models/link_session_success_metadata_institution.rb', line 52

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  name = hash.key?('name') ? hash['name'] : SKIP
  institution_id =
    hash.key?('institution_id') ? hash['institution_id'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  LinkSessionSuccessMetadataInstitution.new(name: name,
                                            institution_id: institution_id,
                                            additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



22
23
24
25
26
27
 
# File 'lib/the_plaid_api/models/link_session_success_metadata_institution.rb', line 22

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['name'] = 'name'
  @_hash['institution_id'] = 'institution_id'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



38
39
40
 
# File 'lib/the_plaid_api/models/link_session_success_metadata_institution.rb', line 38

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



30
31
32
33
34
35
 
# File 'lib/the_plaid_api/models/link_session_success_metadata_institution.rb', line 30

def self.optionals
  %w[
    name
    institution_id
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



81
82
83
84
85
 
# File 'lib/the_plaid_api/models/link_session_success_metadata_institution.rb', line 81

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} name: #{@name.inspect}, institution_id: #{@institution_id.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



74
75
76
77
78
 
# File 'lib/the_plaid_api/models/link_session_success_metadata_institution.rb', line 74

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} name: #{@name}, institution_id: #{@institution_id}, additional_properties:"\
  " #{@additional_properties}>"
end