Class: ProtonApi::PersonalFinancialManagementApi

Inherits:
Object
  • Object
show all
Defined in:
lib/proton_api/api/personal_financial_management_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PersonalFinancialManagementApi

Returns a new instance of PersonalFinancialManagementApi.



19
20
21
 
# File 'lib/proton_api/api/personal_financial_management_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/proton_api/api/personal_financial_management_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#budget_calculator(budget_calculator_request, opts = {}) ⇒ Hash<String, Object>

Budget Calculator Analyze spending against a defined budget

Parameters:

  • budget_calculator_request —

    Request payload for Budget Calculator

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


27
28
29
30
 
# File 'lib/proton_api/api/personal_financial_management_api.rb', line 27

def budget_calculator(budget_calculator_request, opts = {})
  data, _status_code, _headers = budget_calculator_with_http_info(budget_calculator_request, opts)
  data
end

#budget_calculator_with_http_info(budget_calculator_request, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Budget Calculator Analyze spending against a defined budget

Parameters:

  • budget_calculator_request —

    Request payload for Budget Calculator

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> data, response status code and response headers



37
38
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
 
# File 'lib/proton_api/api/personal_financial_management_api.rb', line 37

def budget_calculator_with_http_info(budget_calculator_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PersonalFinancialManagementApi.budget_calculator ...'
  end
  # verify the required parameter 'budget_calculator_request' is set
  if @api_client.config.client_side_validation && budget_calculator_request.nil?
    fail ArgumentError, "Missing the required parameter 'budget_calculator_request' when calling PersonalFinancialManagementApi.budget_calculator"
  end
  # resource path
  local_var_path = '/budget_calculator'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(budget_calculator_request)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PersonalFinancialManagementApi#budget_calculator\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cash_flow_analysis(cash_flow_analysis_request, opts = {}) ⇒ Hash<String, Object>

Cash Flow Analysis Analyze income, expenses, and net income

Parameters:

  • cash_flow_analysis_request —

    Request payload for Cash Flow Analysis

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


81
82
83
84
 
# File 'lib/proton_api/api/personal_financial_management_api.rb', line 81

def cash_flow_analysis(cash_flow_analysis_request, opts = {})
  data, _status_code, _headers = cash_flow_analysis_with_http_info(cash_flow_analysis_request, opts)
  data
end

#cash_flow_analysis_with_http_info(cash_flow_analysis_request, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Cash Flow Analysis Analyze income, expenses, and net income

Parameters:

  • cash_flow_analysis_request —

    Request payload for Cash Flow Analysis

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
 
# File 'lib/proton_api/api/personal_financial_management_api.rb', line 91

def cash_flow_analysis_with_http_info(cash_flow_analysis_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PersonalFinancialManagementApi.cash_flow_analysis ...'
  end
  # verify the required parameter 'cash_flow_analysis_request' is set
  if @api_client.config.client_side_validation && cash_flow_analysis_request.nil?
    fail ArgumentError, "Missing the required parameter 'cash_flow_analysis_request' when calling PersonalFinancialManagementApi.cash_flow_analysis"
  end
  # resource path
  local_var_path = '/cash_flow_analysis'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(cash_flow_analysis_request)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PersonalFinancialManagementApi#cash_flow_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fee_analysis(fee_analysis_request, opts = {}) ⇒ Hash<String, Object>

RFee Analysis Analyze fee data

Parameters:

  • fee_analysis_request —

    Request payload for Fee Analysis

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


135
136
137
138
 
# File 'lib/proton_api/api/personal_financial_management_api.rb', line 135

def fee_analysis(fee_analysis_request, opts = {})
  data, _status_code, _headers = fee_analysis_with_http_info(fee_analysis_request, opts)
  data
end

#fee_analysis_with_http_info(fee_analysis_request, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

RFee Analysis Analyze fee data

Parameters:

  • fee_analysis_request —

    Request payload for Fee Analysis

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
177
178
179
180
181
182
183
 
# File 'lib/proton_api/api/personal_financial_management_api.rb', line 145

def fee_analysis_with_http_info(fee_analysis_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PersonalFinancialManagementApi.fee_analysis ...'
  end
  # verify the required parameter 'fee_analysis_request' is set
  if @api_client.config.client_side_validation && fee_analysis_request.nil?
    fail ArgumentError, "Missing the required parameter 'fee_analysis_request' when calling PersonalFinancialManagementApi.fee_analysis"
  end
  # resource path
  local_var_path = '/fee_analysis'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(fee_analysis_request)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PersonalFinancialManagementApi#fee_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#financial_picture(financial_picture_request, opts = {}) ⇒ Hash<String, Object>

Financial Picture Assess assets, liabilities, and net worth

Parameters:

  • financial_picture_request —

    Request payload for Financial Picture

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


189
190
191
192
 
# File 'lib/proton_api/api/personal_financial_management_api.rb', line 189

def financial_picture(financial_picture_request, opts = {})
  data, _status_code, _headers = financial_picture_with_http_info(financial_picture_request, opts)
  data
end

#financial_picture_with_http_info(financial_picture_request, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Financial Picture Assess assets, liabilities, and net worth

Parameters:

  • financial_picture_request —

    Request payload for Financial Picture

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
230
231
232
233
234
235
236
237
 
# File 'lib/proton_api/api/personal_financial_management_api.rb', line 199

def financial_picture_with_http_info(financial_picture_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PersonalFinancialManagementApi.financial_picture ...'
  end
  # verify the required parameter 'financial_picture_request' is set
  if @api_client.config.client_side_validation && financial_picture_request.nil?
    fail ArgumentError, "Missing the required parameter 'financial_picture_request' when calling PersonalFinancialManagementApi.financial_picture"
  end
  # resource path
  local_var_path = '/financial_picture'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(financial_picture_request)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PersonalFinancialManagementApi#financial_picture\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#recurring_transaction_analysis(recurring_transaction_analysis_request, opts = {}) ⇒ Hash<String, Object>

Recurring Transaction Analysis Analyze recurring transactions

Parameters:

  • recurring_transaction_analysis_request —

    Request payload for Recurring Transaction Analysis

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


243
244
245
246
 
# File 'lib/proton_api/api/personal_financial_management_api.rb', line 243

def recurring_transaction_analysis(recurring_transaction_analysis_request, opts = {})
  data, _status_code, _headers = recurring_transaction_analysis_with_http_info(recurring_transaction_analysis_request, opts)
  data
end

#recurring_transaction_analysis_with_http_info(recurring_transaction_analysis_request, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Recurring Transaction Analysis Analyze recurring transactions

Parameters:

  • recurring_transaction_analysis_request —

    Request payload for Recurring Transaction Analysis

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> data, response status code and response headers



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/proton_api/api/personal_financial_management_api.rb', line 253

def recurring_transaction_analysis_with_http_info(recurring_transaction_analysis_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PersonalFinancialManagementApi.recurring_transaction_analysis ...'
  end
  # verify the required parameter 'recurring_transaction_analysis_request' is set
  if @api_client.config.client_side_validation && recurring_transaction_analysis_request.nil?
    fail ArgumentError, "Missing the required parameter 'recurring_transaction_analysis_request' when calling PersonalFinancialManagementApi.recurring_transaction_analysis"
  end
  # resource path
  local_var_path = '/recurring_transaction_analysis'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(recurring_transaction_analysis_request)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PersonalFinancialManagementApi#recurring_transaction_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#spending_analysis(spending_analysis_request, opts = {}) ⇒ Hash<String, Object>

Spending Analysis Analyze spending transaction activity

Parameters:

  • spending_analysis_request —

    Request payload for Spending Analysis

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


297
298
299
300
 
# File 'lib/proton_api/api/personal_financial_management_api.rb', line 297

def spending_analysis(spending_analysis_request, opts = {})
  data, _status_code, _headers = spending_analysis_with_http_info(spending_analysis_request, opts)
  data
end

#spending_analysis_with_http_info(spending_analysis_request, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Spending Analysis Analyze spending transaction activity

Parameters:

  • spending_analysis_request —

    Request payload for Spending Analysis

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> data, response status code and response headers



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/proton_api/api/personal_financial_management_api.rb', line 307

def spending_analysis_with_http_info(spending_analysis_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PersonalFinancialManagementApi.spending_analysis ...'
  end
  # verify the required parameter 'spending_analysis_request' is set
  if @api_client.config.client_side_validation && spending_analysis_request.nil?
    fail ArgumentError, "Missing the required parameter 'spending_analysis_request' when calling PersonalFinancialManagementApi.spending_analysis"
  end
  # resource path
  local_var_path = '/spending_analysis'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(spending_analysis_request)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PersonalFinancialManagementApi#spending_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end