Class: ProtonApi::AnnuitiesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AnnuitiesApi

Returns a new instance of AnnuitiesApi.



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

def api_client
  @api_client
end

Instance Method Details

#annuity_calculator_accumulation_horizon(annuity_calculator_accumulation_horizon_request, opts = {}) ⇒ Hash<String, Object>

Annuity Calculator - Accumulation Horizon Calculate the necessary fixed annuity contribution period

Parameters:

  • annuity_calculator_accumulation_horizon_request —

    Request payload for Annuity Calculator - Accumulation Horizon

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


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

def annuity_calculator_accumulation_horizon(annuity_calculator_accumulation_horizon_request, opts = {})
  data, _status_code, _headers = annuity_calculator_accumulation_horizon_with_http_info(annuity_calculator_accumulation_horizon_request, opts)
  data
end

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

Annuity Calculator - Accumulation Horizon Calculate the necessary fixed annuity contribution period

Parameters:

  • annuity_calculator_accumulation_horizon_request —

    Request payload for Annuity Calculator - Accumulation 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



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

def annuity_calculator_accumulation_horizon_with_http_info(annuity_calculator_accumulation_horizon_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnnuitiesApi.annuity_calculator_accumulation_horizon ...'
  end
  # verify the required parameter 'annuity_calculator_accumulation_horizon_request' is set
  if @api_client.config.client_side_validation && annuity_calculator_accumulation_horizon_request.nil?
    fail ArgumentError, "Missing the required parameter 'annuity_calculator_accumulation_horizon_request' when calling AnnuitiesApi.annuity_calculator_accumulation_horizon"
  end
  # resource path
  local_var_path = '/annuity_calculator/accumulation_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(annuity_calculator_accumulation_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: AnnuitiesApi#annuity_calculator_accumulation_horizon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#annuity_calculator_annuity_amount(annuity_calculator_annuity_amount_request, opts = {}) ⇒ Hash<String, Object>

Annuity Calculator - Annuity Amount Calculate the achievable fixed annuity amount

Parameters:

  • annuity_calculator_annuity_amount_request —

    Request payload for Annuity Calculator - Annuity Amount

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


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

def annuity_calculator_annuity_amount(annuity_calculator_annuity_amount_request, opts = {})
  data, _status_code, _headers = annuity_calculator_annuity_amount_with_http_info(annuity_calculator_annuity_amount_request, opts)
  data
end

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

Annuity Calculator - Annuity Amount Calculate the achievable fixed annuity amount

Parameters:

  • annuity_calculator_annuity_amount_request —

    Request payload for Annuity Calculator - Annuity 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/annuities_api.rb', line 91

def annuity_calculator_annuity_amount_with_http_info(annuity_calculator_annuity_amount_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnnuitiesApi.annuity_calculator_annuity_amount ...'
  end
  # verify the required parameter 'annuity_calculator_annuity_amount_request' is set
  if @api_client.config.client_side_validation && annuity_calculator_annuity_amount_request.nil?
    fail ArgumentError, "Missing the required parameter 'annuity_calculator_annuity_amount_request' when calling AnnuitiesApi.annuity_calculator_annuity_amount"
  end
  # resource path
  local_var_path = '/annuity_calculator/annuity_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(annuity_calculator_annuity_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: AnnuitiesApi#annuity_calculator_annuity_amount\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#annuity_calculator_decumulation_horizon(annuity_calculator_decumulation_horizon_request, opts = {}) ⇒ Hash<String, Object>

Annuity Calculator - Decumulation Horizon Calculate the achievable fixed annuity payout period

Parameters:

  • annuity_calculator_decumulation_horizon_request —

    Request payload for Annuity Calculator - Decumulation Horizon

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


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

def annuity_calculator_decumulation_horizon(annuity_calculator_decumulation_horizon_request, opts = {})
  data, _status_code, _headers = annuity_calculator_decumulation_horizon_with_http_info(annuity_calculator_decumulation_horizon_request, opts)
  data
end

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

Annuity Calculator - Decumulation Horizon Calculate the achievable fixed annuity payout period

Parameters:

  • annuity_calculator_decumulation_horizon_request —

    Request payload for Annuity Calculator - Decumulation 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



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

def annuity_calculator_decumulation_horizon_with_http_info(annuity_calculator_decumulation_horizon_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnnuitiesApi.annuity_calculator_decumulation_horizon ...'
  end
  # verify the required parameter 'annuity_calculator_decumulation_horizon_request' is set
  if @api_client.config.client_side_validation && annuity_calculator_decumulation_horizon_request.nil?
    fail ArgumentError, "Missing the required parameter 'annuity_calculator_decumulation_horizon_request' when calling AnnuitiesApi.annuity_calculator_decumulation_horizon"
  end
  # resource path
  local_var_path = '/annuity_calculator/decumulation_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(annuity_calculator_decumulation_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: AnnuitiesApi#annuity_calculator_decumulation_horizon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#annuity_calculator_deposit_amount(annuity_calculator_deposit_amount_request, opts = {}) ⇒ Hash<String, Object>

Annuity Calculator - Deposit Amount Calculate the necessary periodic deposit amount for a fixed annuity

Parameters:

  • annuity_calculator_deposit_amount_request —

    Request payload for Annuity Calculator - Deposit Amount

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


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

def annuity_calculator_deposit_amount(annuity_calculator_deposit_amount_request, opts = {})
  data, _status_code, _headers = annuity_calculator_deposit_amount_with_http_info(annuity_calculator_deposit_amount_request, opts)
  data
end

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

Annuity Calculator - Deposit Amount Calculate the necessary periodic deposit amount for a fixed annuity

Parameters:

  • annuity_calculator_deposit_amount_request —

    Request payload for Annuity 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



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

def annuity_calculator_deposit_amount_with_http_info(annuity_calculator_deposit_amount_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnnuitiesApi.annuity_calculator_deposit_amount ...'
  end
  # verify the required parameter 'annuity_calculator_deposit_amount_request' is set
  if @api_client.config.client_side_validation && annuity_calculator_deposit_amount_request.nil?
    fail ArgumentError, "Missing the required parameter 'annuity_calculator_deposit_amount_request' when calling AnnuitiesApi.annuity_calculator_deposit_amount"
  end
  # resource path
  local_var_path = '/annuity_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(annuity_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: AnnuitiesApi#annuity_calculator_deposit_amount\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#annuity_calculator_initial_balance(annuity_calculator_initial_balance_request, opts = {}) ⇒ Hash<String, Object>

Annuity Calculator - Initial Balance Calculate the necessary initial balance for a fixed annuity

Parameters:

  • annuity_calculator_initial_balance_request —

    Request payload for Annuity Calculator - Initial Balance

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


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

def annuity_calculator_initial_balance(annuity_calculator_initial_balance_request, opts = {})
  data, _status_code, _headers = annuity_calculator_initial_balance_with_http_info(annuity_calculator_initial_balance_request, opts)
  data
end

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

Annuity Calculator - Initial Balance Calculate the necessary initial balance for a fixed annuity

Parameters:

  • annuity_calculator_initial_balance_request —

    Request payload for Annuity Calculator - Initial Balance

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

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

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

#variable_annuity(variable_annuity_request, opts = {}) ⇒ Hash<String, Object>

Variable Annuity Project the behavior of a variable annuity over time

Parameters:

  • variable_annuity_request —

    Request payload for Variable Annuity

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


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

def variable_annuity(variable_annuity_request, opts = {})
  data, _status_code, _headers = variable_annuity_with_http_info(variable_annuity_request, opts)
  data
end

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

Variable Annuity Project the behavior of a variable annuity over time

Parameters:

  • variable_annuity_request —

    Request payload for Variable Annuity

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

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

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