Class: Plaid::InvestmentsHoldingsGetResponse

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

Overview

InvestmentsHoldingsGetResponse defines the response schema for ‘/investments/holdings/get`

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(accounts:, holdings:, securities:, item:, request_id:, additional_properties: nil) ⇒ InvestmentsHoldingsGetResponse

Returns a new instance of InvestmentsHoldingsGetResponse.



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

def initialize(accounts:, holdings:, securities:, item:, request_id:,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @accounts = accounts
  @holdings = holdings
  @securities = securities
  @item = item
  @request_id = request_id
  @additional_properties = additional_properties
end

Instance Attribute Details

#accounts ⇒ Array[Account]

The accounts associated with the Item

Returns:



15
16
17
 
# File 'lib/plaid/models/investments_holdings_get_response.rb', line 15

def accounts
  @accounts
end

#holdings ⇒ Array[Holding]

The holdings belonging to investment accounts associated with the Item. Details of the securities in the holdings are provided in the ‘securities` field.

Returns:



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

def holdings
  @holdings
end

#item ⇒ Item

Metadata about the Item.

Returns:



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

def item
  @item
end

#request_id ⇒ String

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Returns:

  • (String) 


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

def request_id
  @request_id
end

#securities ⇒ Array[Security]

Objects describing the securities held in the accounts associated with the Item.

Returns:



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

def securities
  @securities
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



73
74
75
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
119
120
121
122
123
124
 
# File 'lib/plaid/models/investments_holdings_get_response.rb', line 73

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  # Parameter is an array, so we need to iterate through it
  accounts = nil
  unless hash['accounts'].nil?
    accounts = []
    hash['accounts'].each do |structure|
      accounts << (Account.from_hash(structure) if structure)
    end
  end

  accounts = nil unless hash.key?('accounts')
  # Parameter is an array, so we need to iterate through it
  holdings = nil
  unless hash['holdings'].nil?
    holdings = []
    hash['holdings'].each do |structure|
      holdings << (Holding.from_hash(structure) if structure)
    end
  end

  holdings = nil unless hash.key?('holdings')
  # Parameter is an array, so we need to iterate through it
  securities = nil
  unless hash['securities'].nil?
    securities = []
    hash['securities'].each do |structure|
      securities << (Security.from_hash(structure) if structure)
    end
  end

  securities = nil unless hash.key?('securities')
  item = Item.from_hash(hash['item']) if hash['item']
  request_id = hash.key?('request_id') ? hash['request_id'] : nil

  # 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.
  InvestmentsHoldingsGetResponse.new(accounts: accounts,
                                     holdings: holdings,
                                     securities: securities,
                                     item: item,
                                     request_id: request_id,
                                     additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['accounts'] = 'accounts'
  @_hash['holdings'] = 'holdings'
  @_hash['securities'] = 'securities'
  @_hash['item'] = 'item'
  @_hash['request_id'] = 'request_id'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



55
56
57
 
# File 'lib/plaid/models/investments_holdings_get_response.rb', line 55

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



135
136
137
138
139
140
 
# File 'lib/plaid/models/investments_holdings_get_response.rb', line 135

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



127
128
129
130
131
132
 
# File 'lib/plaid/models/investments_holdings_get_response.rb', line 127

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