Class: ProtonApi::FinancialPlanningApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FinancialPlanningApi

Returns a new instance of FinancialPlanningApi.



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

def api_client
  @api_client
end

Instance Method Details

#education_calculator_annual_cost(education_calculator_annual_cost_request, opts = {}) ⇒ Hash<String, Object>

Education Calculator - Annual Cost Calculate the achievable education costs

Parameters:

  • education_calculator_annual_cost_request —

    Request payload for Education Calculator - Annual Cost

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


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

def education_calculator_annual_cost(education_calculator_annual_cost_request, opts = {})
  data, _status_code, _headers = education_calculator_annual_cost_with_http_info(education_calculator_annual_cost_request, opts)
  data
end

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

Education Calculator - Annual Cost Calculate the achievable education costs

Parameters:

  • education_calculator_annual_cost_request —

    Request payload for Education Calculator - Annual Cost

  • 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/financial_planning_api.rb', line 37

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

  # 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(education_calculator_annual_cost_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: FinancialPlanningApi#education_calculator_annual_cost\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#education_calculator_deposit_amount(education_calculator_deposit_amount_request, opts = {}) ⇒ Hash<String, Object>

Education Calculator - Deposit Amount Calculate the necessary periodic deposit amount to achieve education costs

Parameters:

  • education_calculator_deposit_amount_request —

    Request payload for Education Calculator - Deposit Amount

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


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

def education_calculator_deposit_amount(education_calculator_deposit_amount_request, opts = {})
  data, _status_code, _headers = education_calculator_deposit_amount_with_http_info(education_calculator_deposit_amount_request, opts)
  data
end

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

Education Calculator - Deposit Amount Calculate the necessary periodic deposit amount to achieve education costs

Parameters:

  • education_calculator_deposit_amount_request —

    Request payload for Education Calculator - Deposit Amount

  • 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/financial_planning_api.rb', line 91

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

  # 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(education_calculator_deposit_amount_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: FinancialPlanningApi#education_calculator_deposit_amount\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#education_calculator_percent_covered(education_calculator_percent_covered_request, opts = {}) ⇒ Hash<String, Object>

Education Calculator - Percent Covered Calculate the achievable percentage of education costs that can be covered

Parameters:

  • education_calculator_percent_covered_request —

    Request payload for Education Calculator - Percent Covered

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


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

def education_calculator_percent_covered(education_calculator_percent_covered_request, opts = {})
  data, _status_code, _headers = education_calculator_percent_covered_with_http_info(education_calculator_percent_covered_request, opts)
  data
end

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

Education Calculator - Percent Covered Calculate the achievable percentage of education costs that can be covered

Parameters:

  • education_calculator_percent_covered_request —

    Request payload for Education Calculator - Percent Covered

  • 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/financial_planning_api.rb', line 145

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

  # 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(education_calculator_percent_covered_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: FinancialPlanningApi#education_calculator_percent_covered\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mortgage_calculator_down_payment(mortgage_calculator_down_payment_request, opts = {}) ⇒ Hash<String, Object>

Mortgage Calculator - Down Payment Calculate the necessary down payment for the mortgage

Parameters:

  • mortgage_calculator_down_payment_request —

    Request payload for Mortgage Calculator - Down Payment

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


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

def mortgage_calculator_down_payment(mortgage_calculator_down_payment_request, opts = {})
  data, _status_code, _headers = mortgage_calculator_down_payment_with_http_info(mortgage_calculator_down_payment_request, opts)
  data
end

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

Mortgage Calculator - Down Payment Calculate the necessary down payment for the mortgage

Parameters:

  • mortgage_calculator_down_payment_request —

    Request payload for Mortgage Calculator - Down Payment

  • 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/financial_planning_api.rb', line 199

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

  # 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(mortgage_calculator_down_payment_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: FinancialPlanningApi#mortgage_calculator_down_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mortgage_calculator_home_price(mortgage_calculator_home_price_request, opts = {}) ⇒ Hash<String, Object>

Mortgage Calculator - Home Price Calculate the achievable home price for the mortgage

Parameters:

  • mortgage_calculator_home_price_request —

    Request payload for Mortgage Calculator - Home Price

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


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

def mortgage_calculator_home_price(mortgage_calculator_home_price_request, opts = {})
  data, _status_code, _headers = mortgage_calculator_home_price_with_http_info(mortgage_calculator_home_price_request, opts)
  data
end

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

Mortgage Calculator - Home Price Calculate the achievable home price for the mortgage

Parameters:

  • mortgage_calculator_home_price_request —

    Request payload for Mortgage Calculator - Home Price

  • 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/financial_planning_api.rb', line 253

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

  # 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(mortgage_calculator_home_price_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: FinancialPlanningApi#mortgage_calculator_home_price\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mortgage_calculator_periodic_payment(mortgage_calculator_periodic_payment_request, opts = {}) ⇒ Hash<String, Object>

Mortgage Calculator - Periodic Payment Calculate the periodic payment for the mortgage

Parameters:

  • mortgage_calculator_periodic_payment_request —

    Request payload for Mortgage Calculator - Periodic Payment

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


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

def mortgage_calculator_periodic_payment(mortgage_calculator_periodic_payment_request, opts = {})
  data, _status_code, _headers = mortgage_calculator_periodic_payment_with_http_info(mortgage_calculator_periodic_payment_request, opts)
  data
end

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

Mortgage Calculator - Periodic Payment Calculate the periodic payment for the mortgage

Parameters:

  • mortgage_calculator_periodic_payment_request —

    Request payload for Mortgage Calculator - Periodic Payment

  • 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/financial_planning_api.rb', line 307

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

  # 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(mortgage_calculator_periodic_payment_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: FinancialPlanningApi#mortgage_calculator_periodic_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#purchase_calculator_amount(purchase_calculator_amount_request, opts = {}) ⇒ Hash<String, Object>

Purchase Calculator - Amount Calculate the achievable purchase amount

Parameters:

  • purchase_calculator_amount_request —

    Request payload for Purchase Calculator - Amount

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


351
352
353
354
 
# File 'lib/proton_api/api/financial_planning_api.rb', line 351

def purchase_calculator_amount(purchase_calculator_amount_request, opts = {})
  data, _status_code, _headers = purchase_calculator_amount_with_http_info(purchase_calculator_amount_request, opts)
  data
end

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

Purchase Calculator - Amount Calculate the achievable purchase amount

Parameters:

  • purchase_calculator_amount_request —

    Request payload for Purchase Calculator - Amount

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

    the optional parameters

Returns:

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

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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/proton_api/api/financial_planning_api.rb', line 361

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

  # 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(purchase_calculator_amount_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: FinancialPlanningApi#purchase_calculator_amount\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#purchase_calculator_deposit_amount(purchase_calculator_deposit_amount_request, opts = {}) ⇒ Hash<String, Object>

Purchase Calculator - Deposit Amount Calculate the necessary periodic deposit amount to achieve the purchase amount

Parameters:

  • purchase_calculator_deposit_amount_request —

    Request payload for Purchase Calculator - Deposit Amount

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


405
406
407
408
 
# File 'lib/proton_api/api/financial_planning_api.rb', line 405

def purchase_calculator_deposit_amount(purchase_calculator_deposit_amount_request, opts = {})
  data, _status_code, _headers = purchase_calculator_deposit_amount_with_http_info(purchase_calculator_deposit_amount_request, opts)
  data
end

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

Purchase Calculator - Deposit Amount Calculate the necessary periodic deposit amount to achieve the purchase amount

Parameters:

  • purchase_calculator_deposit_amount_request —

    Request payload for Purchase Calculator - Deposit Amount

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

    the optional parameters

Returns:

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

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



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/proton_api/api/financial_planning_api.rb', line 415

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

  # 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(purchase_calculator_deposit_amount_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: FinancialPlanningApi#purchase_calculator_deposit_amount\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#purchase_calculator_horizon(purchase_calculator_horizon_request, opts = {}) ⇒ Hash<String, Object>

Purchase Calculator - Horizon Calculate the necessary time horizon to achieve the purchase amount

Parameters:

  • purchase_calculator_horizon_request —

    Request payload for Purchase Calculator - Horizon

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


459
460
461
462
 
# File 'lib/proton_api/api/financial_planning_api.rb', line 459

def purchase_calculator_horizon(purchase_calculator_horizon_request, opts = {})
  data, _status_code, _headers = purchase_calculator_horizon_with_http_info(purchase_calculator_horizon_request, opts)
  data
end

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

Purchase Calculator - Horizon Calculate the necessary time horizon to achieve the purchase amount

Parameters:

  • purchase_calculator_horizon_request —

    Request payload for Purchase Calculator - Horizon

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

    the optional parameters

Returns:

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

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



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/proton_api/api/financial_planning_api.rb', line 469

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

  # 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(purchase_calculator_horizon_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: FinancialPlanningApi#purchase_calculator_horizon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retirement_calculator_deposit_amount(retirement_calculator_deposit_amount_request, opts = {}) ⇒ Hash<String, Object>

Retirement Calculator - Deposit Amount Calculate the necessary period deposit amount to achieve the retirement expenses

Parameters:

  • retirement_calculator_deposit_amount_request —

    Request payload for Retirement Calculator - Deposit AMount

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


513
514
515
516
 
# File 'lib/proton_api/api/financial_planning_api.rb', line 513

def retirement_calculator_deposit_amount(retirement_calculator_deposit_amount_request, opts = {})
  data, _status_code, _headers = retirement_calculator_deposit_amount_with_http_info(retirement_calculator_deposit_amount_request, opts)
  data
end

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

Retirement Calculator - Deposit Amount Calculate the necessary period deposit amount to achieve the retirement expenses

Parameters:

  • retirement_calculator_deposit_amount_request —

    Request payload for Retirement Calculator - Deposit AMount

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

    the optional parameters

Returns:

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

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



523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/proton_api/api/financial_planning_api.rb', line 523

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

  # 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(retirement_calculator_deposit_amount_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: FinancialPlanningApi#retirement_calculator_deposit_amount\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retirement_calculator_expenses(retirement_calculator_expenses_request, opts = {}) ⇒ Hash<String, Object>

Retirement Calculator - Expenses Calculate the achievable retirement expenses

Parameters:

  • retirement_calculator_expenses_request —

    Request payload for Retirement Calculator - Expenses

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


567
568
569
570
 
# File 'lib/proton_api/api/financial_planning_api.rb', line 567

def retirement_calculator_expenses(retirement_calculator_expenses_request, opts = {})
  data, _status_code, _headers = retirement_calculator_expenses_with_http_info(retirement_calculator_expenses_request, opts)
  data
end

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

Retirement Calculator - Expenses Calculate the achievable retirement expenses

Parameters:

  • retirement_calculator_expenses_request —

    Request payload for Retirement Calculator - Expenses

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

    the optional parameters

Returns:

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

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



577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
 
# File 'lib/proton_api/api/financial_planning_api.rb', line 577

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

  # 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(retirement_calculator_expenses_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: FinancialPlanningApi#retirement_calculator_expenses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retirement_calculator_percent_covered(retirement_calculator_percent_covered_request, opts = {}) ⇒ Hash<String, Object>

Retirement Calculator - Percent Covered Calculate the achievable percentage of retirement expenses that can be covered

Parameters:

  • retirement_calculator_percent_covered_request —

    Request payload for Retirement Calculator - Percent Covered

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


621
622
623
624
 
# File 'lib/proton_api/api/financial_planning_api.rb', line 621

def retirement_calculator_percent_covered(retirement_calculator_percent_covered_request, opts = {})
  data, _status_code, _headers = retirement_calculator_percent_covered_with_http_info(retirement_calculator_percent_covered_request, opts)
  data
end

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

Retirement Calculator - Percent Covered Calculate the achievable percentage of retirement expenses that can be covered

Parameters:

  • retirement_calculator_percent_covered_request —

    Request payload for Retirement Calculator - Percent Covered

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

    the optional parameters

Returns:

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

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



631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
 
# File 'lib/proton_api/api/financial_planning_api.rb', line 631

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

  # 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(retirement_calculator_percent_covered_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: FinancialPlanningApi#retirement_calculator_percent_covered\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end