Class: MoneyKit::InvestmentsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/moneykit/api/investments_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InvestmentsApi

Returns a new instance of InvestmentsApi.



19
20
21
 
# File 'lib/moneykit/api/investments_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/moneykit/api/investments_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_holdings(id, opts = {}) ⇒ GetHoldingsResponse

/links/id/investments/holdings Returns holdings for the investment accounts associated with a <a href=#tag/Links>link</a>. <p>Note that this endpoint does not trigger a fetch of holdings from the institution; it merely returns holdings that have already been fetched. **To force a check for new/updated owner information, you must use the <a href=#operation/refresh_products>/products</a> endpoint.** <p>If you have requested prefetch or an on-demand update, you should check the ‘refreshed_at` date for this product in the returned response, and compare that against the previous `refreshed_at` date, which you can get from any previous response for this or any other account or link request. If the refreshed_at date has not increased, then updated data is not yet available.

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Options Hash (opts):

  • :account_ids (Array<String>) —

    An optional list of account IDs to filter the results.

Returns:



28
29
30
31
 
# File 'lib/moneykit/api/investments_api.rb', line 28

def get_holdings(id, opts = {})
  data, _status_code, _headers = get_holdings_with_http_info(id, opts)
  data
end

#get_holdings_with_http_info(id, opts = {}) ⇒ Array<(GetHoldingsResponse, Integer, Hash)>

/links/id/investments/holdings Returns holdings for the investment accounts associated with a &lt;a href&#x3D;#tag/Links&gt;link&lt;/a&gt;. &lt;p&gt;Note that this endpoint does not trigger a fetch of holdings from the institution; it merely returns holdings that have already been fetched. **To force a check for new/updated owner information, you must use the &lt;a href&#x3D;#operation/refresh_products&gt;/products&lt;/a&gt; endpoint.** &lt;p&gt;If you have requested prefetch or an on-demand update, you should check the &#x60;refreshed_at&#x60; date for this product in the returned response, and compare that against the previous &#x60;refreshed_at&#x60; date, which you can get from any previous response for this or any other account or link request. If the refreshed_at date has not increased, then updated data is not yet available.

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Options Hash (opts):

  • :account_ids (Array<String>) —

    An optional list of account IDs to filter the results.

Returns:

  • (Array<(GetHoldingsResponse, Integer, Hash)>) —

    GetHoldingsResponse data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/moneykit/api/investments_api.rb', line 39

def get_holdings_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestmentsApi.get_holdings ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling InvestmentsApi.get_holdings"
  end
  # resource path
  local_var_path = '/links/{id}/investments/holdings'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'account_ids'] = @api_client.build_collection_param(opts[:'account_ids'], :multi) if !opts[:'account_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetHoldingsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials']

  new_options = opts.merge(
    :operation => :"InvestmentsApi.get_holdings",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvestmentsApi#get_holdings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_investment_transactions(id, opts = {}) ⇒ GetInvestmentTransactionsResponse

/links/id/investments/transactions Returns investment transactions for the accounts associated with a <a href=#tag/Links>link</a>. Results are paginated, and returned in reverse chronological order. <p>Note that this endpoint does not trigger a fetch of transactions from the institution; it merely returns transactions that have already been fetched. **To force a check for new/updated owner information, you must use the <a href=#operation/refresh_products>/products</a> endpoint.** <p>If you have requested prefetch or an on-demand update, you should check the ‘refreshed_at` date for this product in the returned response, and compare that against the previous `refreshed_at` date, which you can get from any previous response for this or any other account or link request. If the refreshed_at date has not increased, then updated data is not yet available.

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Options Hash (opts):

  • :account_ids (Array<String>) —

    An optional list of account IDs to filter the results.

  • :page (Integer) —

    The page number to return. (default to 1)

  • :size (Integer) —

    The number of items to return per page. (default to 50)

  • :start_date (Date) —

    The earliest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to 90 days before the &#x60;end_date&#x60;. &lt;p&gt;If you want to retrieve all transactions, use &#x60;1900-01-01&#x60;.

  • :end_date (Date) —

    The latest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to today.

Returns:



98
99
100
101
 
# File 'lib/moneykit/api/investments_api.rb', line 98

def get_investment_transactions(id, opts = {})
  data, _status_code, _headers = get_investment_transactions_with_http_info(id, opts)
  data
end

#get_investment_transactions_with_http_info(id, opts = {}) ⇒ Array<(GetInvestmentTransactionsResponse, Integer, Hash)>

/links/id/investments/transactions Returns investment transactions for the accounts associated with a &lt;a href&#x3D;#tag/Links&gt;link&lt;/a&gt;. Results are paginated, and returned in reverse chronological order. &lt;p&gt;Note that this endpoint does not trigger a fetch of transactions from the institution; it merely returns transactions that have already been fetched. **To force a check for new/updated owner information, you must use the &lt;a href&#x3D;#operation/refresh_products&gt;/products&lt;/a&gt; endpoint.** &lt;p&gt;If you have requested prefetch or an on-demand update, you should check the &#x60;refreshed_at&#x60; date for this product in the returned response, and compare that against the previous &#x60;refreshed_at&#x60; date, which you can get from any previous response for this or any other account or link request. If the refreshed_at date has not increased, then updated data is not yet available.

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Options Hash (opts):

  • :account_ids (Array<String>) —

    An optional list of account IDs to filter the results.

  • :page (Integer) —

    The page number to return. (default to 1)

  • :size (Integer) —

    The number of items to return per page. (default to 50)

  • :start_date (Date) —

    The earliest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to 90 days before the &#x60;end_date&#x60;. &lt;p&gt;If you want to retrieve all transactions, use &#x60;1900-01-01&#x60;.

  • :end_date (Date) —

    The latest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to today.

Returns:



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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/moneykit/api/investments_api.rb', line 113

def get_investment_transactions_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvestmentsApi.get_investment_transactions ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling InvestmentsApi.get_investment_transactions"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling InvestmentsApi.get_investment_transactions, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"size"]" when calling InvestmentsApi.get_investment_transactions, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"size"]" when calling InvestmentsApi.get_investment_transactions, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/links/{id}/investments/transactions'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'account_ids'] = @api_client.build_collection_param(opts[:'account_ids'], :multi) if !opts[:'account_ids'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetInvestmentTransactionsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials']

  new_options = opts.merge(
    :operation => :"InvestmentsApi.get_investment_transactions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvestmentsApi#get_investment_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end