Class: ProtonApi::SimulationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SimulationsApi

Returns a new instance of SimulationsApi.



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

def api_client
  @api_client
end

Instance Method Details

#backtest(backtest_request, opts = {}) ⇒ Hash<String, Object>

Backtest Run a historical analysis for a group of investments

Parameters:

  • backtest_request —

    Request payload for Backtest

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


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

def backtest(backtest_request, opts = {})
  data, _status_code, _headers = backtest_with_http_info(backtest_request, opts)
  data
end

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

Backtest Run a historical analysis for a group of investments

Parameters:

  • backtest_request —

    Request payload for Backtest

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

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

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

#event_study(event_study_request, opts = {}) ⇒ Hash<String, Object>

Event Study Analyze a group of investments against key historical events

Parameters:

  • event_study_request —

    Request payload for Event Study

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


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

def event_study(event_study_request, opts = {})
  data, _status_code, _headers = event_study_with_http_info(event_study_request, opts)
  data
end

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

Event Study Analyze a group of investments against key historical events

Parameters:

  • event_study_request —

    Request payload for Event Study

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

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

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

#monte_carlo(monte_carlo_request, opts = {}) ⇒ Hash<String, Object>

Monte Carlo Simulate the future growth of a group of investments

Parameters:

  • monte_carlo_request —

    Request payload for Monte Carlo

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


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

def monte_carlo(monte_carlo_request, opts = {})
  data, _status_code, _headers = monte_carlo_with_http_info(monte_carlo_request, opts)
  data
end

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

Monte Carlo Simulate the future growth of a group of investments

Parameters:

  • monte_carlo_request —

    Request payload for Monte Carlo

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

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

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

#portfolio_what_if(portfolio_what_if_request, opts = {}) ⇒ Hash<String, Object>

Porfolio What-If Simulate the impact of adding, removing, reducing, or increasing various positions in a group of investments

Parameters:

  • portfolio_what_if_request —

    Request payload for Portfolio What-If

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


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

def portfolio_what_if(portfolio_what_if_request, opts = {})
  data, _status_code, _headers = portfolio_what_if_with_http_info(portfolio_what_if_request, opts)
  data
end

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

Porfolio What-If Simulate the impact of adding, removing, reducing, or increasing various positions in a group of investments

Parameters:

  • portfolio_what_if_request —

    Request payload for Portfolio What-If

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

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

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

#savings_calculator(savings_calculator_request, opts = {}) ⇒ Hash<String, Object>

Savings Calculator Simulate the future growth of a simple savings account

Parameters:

  • savings_calculator_request —

    Request payload for Savings Calculator

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


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

def savings_calculator(savings_calculator_request, opts = {})
  data, _status_code, _headers = savings_calculator_with_http_info(savings_calculator_request, opts)
  data
end

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

Savings Calculator Simulate the future growth of a simple savings account

Parameters:

  • savings_calculator_request —

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



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

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

#scenario_analysis(scneario_analysis_request, opts = {}) ⇒ Hash<String, Object>

Scenario Analysis Analyze a group of investments against a series of external economic factors

Parameters:

  • scneario_analysis_request —

    Request payload for Scenario Analysis

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


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

def scenario_analysis(scneario_analysis_request, opts = {})
  data, _status_code, _headers = scenario_analysis_with_http_info(scneario_analysis_request, opts)
  data
end

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

Scenario Analysis Analyze a group of investments against a series of external economic factors

Parameters:

  • scneario_analysis_request —

    Request payload for Scenario 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/simulations_api.rb', line 307

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

#sensitivity_analysis(sensitivity_analysis_request, opts = {}) ⇒ Hash<String, Object>

Sensitivity Analysis Analyze a group of investments against an external economic factor

Parameters:

  • sensitivity_analysis_request —

    Request payload for Sensitivity Analysis

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


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

def sensitivity_analysis(sensitivity_analysis_request, opts = {})
  data, _status_code, _headers = sensitivity_analysis_with_http_info(sensitivity_analysis_request, opts)
  data
end

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

Sensitivity Analysis Analyze a group of investments against an external economic factor

Parameters:

  • sensitivity_analysis_request —

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



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/simulations_api.rb', line 361

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