nucleus_api 1.8.0

data/spec/api/performance_api_spec.rb

@@ -0,0 +1,355 @@
+=begin
+#Hydrogen Nucleus API
+
+#The Hydrogen Nucleus API
+
+OpenAPI spec version: 1.8.0
+Contact: info@hydrogenplatform.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.18
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for NucleusApi::PerformanceApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'PerformanceApi' do
+  before do
+    # run before each test
+    @instance = NucleusApi::PerformanceApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PerformanceApi' do
+    it 'should create an instance of PerformanceApi' do
+      expect(@instance).to be_instance_of(NucleusApi::PerformanceApi)
+    end
+  end
+
+  # unit tests for get_account_performance_using_get
+  # Account Performance
+  # Get information on the performance of an account using IRR (Internal Rate of Return). You must provide the unique account_id.
+  # @param account_id Account Id -/account
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: 'D')
+  # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: 'D')
+  # @option opts [String] :benchmark_id Client Benchmark or Tenant Benchmark id -/benchmark
+  # @option opts [Date] :end_date end date
+  # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
+  # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0) 
+  # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
+  # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
+  # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
+  # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
+  # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)  
+  # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
+  # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
+  # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
+  # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000) 
+  # @option opts [String] :period_type  Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: 'D')
+  # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
+  # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0) 
+  # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
+  # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0) 
+  # @option opts [Date] :start_date start date
+  # @option opts [String] :stat A stat type - /statistics
+  # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
+  # @return [Object]
+  describe 'get_account_performance_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_allocation_performance_using_get
+  # Allocation Performance
+  # Get information on the performance of an allocation using TWR (Time Weighted Return). You must provide the unique allocation_id.
+  # @param allocation_id Allocation Id -/allocation
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: 'D')
+  # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: 'D')
+  # @option opts [String] :benchmark_id Tenant Benchmark Id -/benchmark
+  # @option opts [Date] :end_date end date
+  # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
+  # @option opts [BOOLEAN] :is_current_weight is_current_weight
+  # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0) 
+  # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
+  # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
+  # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
+  # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
+  # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)  
+  # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
+  # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
+  # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
+  # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000) 
+  # @option opts [String] :period_type  Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: 'D')
+  # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
+  # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0) 
+  # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
+  # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0) 
+  # @option opts [Date] :start_date start date
+  # @option opts [String] :stat A stat type found under the Statistics banner
+  # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
+  # @return [Hash<String, Object>]
+  describe 'get_allocation_performance_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_benchmark_performance_using_get
+  # Benchmark Performance
+  # Get information on the performance of a benchmark using TWR (Time Weighted Return). You must provide the unique benchmark_id.
+  # @param benchmark_id Benchmark Id - /benchmark
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
+  # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
+  # @option opts [String] :comparison_benchmark_id comparison_benchmark_id
+  # @option opts [Date] :end_date end date
+  # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
+  # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0) 
+  # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
+  # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
+  # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
+  # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
+  # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)  
+  # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
+  # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
+  # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
+  # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000) 
+  # @option opts [String] :period_type  Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
+  # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
+  # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0) 
+  # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
+  # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0) 
+  # @option opts [Date] :start_date start date
+  # @option opts [String] :stat Stat type - /statistics endpoint
+  # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
+  # @return [Object]
+  describe 'get_benchmark_performance_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_client_performance_using_get
+  # Client Performance
+  # Get information on the performance of a client using IRR (Internal Rate of Return). You must provide the unique client_id.
+  # @param client_id Client Id -/client
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
+  # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
+  # @option opts [String] :benchmark_id Client Benchmark or Tenant Benchmark id -/benchmark
+  # @option opts [Date] :end_date end date
+  # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
+  # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0) 
+  # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
+  # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
+  # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
+  # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
+  # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)  
+  # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
+  # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
+  # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
+  # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000) 
+  # @option opts [String] :period_type  Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
+  # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
+  # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0) 
+  # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
+  # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0) 
+  # @option opts [Date] :start_date start date
+  # @option opts [String] :stat A stat type -- /statistics
+  # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
+  # @return [Object]
+  describe 'get_client_performance_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_goal_performance_using_get
+  # Goal Performance
+  # Get information on the performance of a goal using IRR (Internal Rate of Return). You must provide the unique goal_id.
+  # @param client_id client_id
+  # @param goal_id Goal Id - /account
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
+  # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
+  # @option opts [String] :benchmark_id Client Benchmark or Tenant Benchmark id -/benchmark
+  # @option opts [Date] :end_date end date
+  # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
+  # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0) 
+  # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
+  # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
+  # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
+  # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
+  # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)  
+  # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
+  # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
+  # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
+  # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000) 
+  # @option opts [String] :period_type  Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
+  # @option opts [BOOLEAN] :portfolio_goal portfolio_goal
+  # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
+  # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0) 
+  # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
+  # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0) 
+  # @option opts [Date] :start_date start date
+  # @option opts [String] :stat A stat type - /statistics
+  # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
+  # @return [Object]
+  describe 'get_goal_performance_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_household_client_performance_using_get
+  # Household Performance
+  # Get information on the performance of a Household using IRR (Internal Rate of Return). You must provide the unique household_id.
+  # @param household_id Household Id -/household
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
+  # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
+  # @option opts [String] :benchmark_id Client Benchmark or Tenant Benchmark id -/benchmark
+  # @option opts [Date] :end_date end date
+  # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
+  # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0) 
+  # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
+  # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
+  # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
+  # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
+  # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)  
+  # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
+  # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
+  # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
+  # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000) 
+  # @option opts [String] :period_type  Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
+  # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
+  # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0) 
+  # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
+  # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0) 
+  # @option opts [Date] :start_date start date
+  # @option opts [String] :stat A stat type -- /statistics
+  # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
+  # @return [Object]
+  describe 'get_household_client_performance_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_model_performance_using_get
+  # Model Performance
+  # Get information on the performance of a model using TWR (Time Weighted Return). You must provide the unique model_id.
+  # @param model_id Model Id - /model
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
+  # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
+  # @option opts [String] :benchmark_id Tenant Benchmark Id -/benchmark
+  # @option opts [Date] :end_date end date
+  # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
+  # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0) 
+  # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
+  # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
+  # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
+  # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
+  # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)  
+  # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
+  # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
+  # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
+  # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000) 
+  # @option opts [String] :period_type  Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
+  # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
+  # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0) 
+  # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
+  # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0) 
+  # @option opts [Date] :start_date start date
+  # @option opts [String] :stat Stat Type
+  # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
+  # @return [Object]
+  describe 'get_model_performance_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_portfolio_performance_using_get
+  # Portfolio Performance
+  # Get information on the performance of a portfolio using IRR (Internal Rate of Return). You must provide the unique portfolio_id.
+  # @param portfolio_id Portfolio Id -/portoflio
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
+  # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
+  # @option opts [String] :benchmark_id Benchmark Id - benchmarkId or clientBenchmarkId -/benchmark
+  # @option opts [Date] :end_date end date
+  # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
+  # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0) 
+  # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
+  # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
+  # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
+  # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
+  # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)  
+  # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
+  # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
+  # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
+  # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000) 
+  # @option opts [String] :period_type  Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
+  # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
+  # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0) 
+  # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
+  # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0) 
+  # @option opts [Date] :start_date start date
+  # @option opts [String] :stat A stat type - /statistics endpoint to get types
+  # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
+  # @return [Object]
+  describe 'get_portfolio_performance_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_security_performance_using_get
+  # Security Performance
+  # Get performance statistics for a security using TWR (Time Weighted Return). You must provide the unique security_id
+  # @param security_id security_id
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
+  # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
+  # @option opts [String] :bench_ticker Bench Ticker for security - (default: ^GSPC) 
+  # @option opts [String] :benchmark_id benchmark_id
+  # @option opts [Date] :end_date Ending parameter for time window
+  # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
+  # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0) 
+  # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
+  # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
+  # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
+  # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
+  # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)  
+  # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
+  # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
+  # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
+  # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000) 
+  # @option opts [String] :period_type  Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
+  # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
+  # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0) 
+  # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
+  # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0) 
+  # @option opts [Date] :start_date Starting parameter for time window
+  # @option opts [String] :stat A stat type - /statistics endpoint
+  # @option opts [String] :ticker Ticker for security
+  # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
+  # @return [Object]
+  describe 'get_security_performance_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/portfolio_api_spec.rb

@@ -0,0 +1,448 @@
+=begin
+#Hydrogen Nucleus API
+
+#The Hydrogen Nucleus API
+
+OpenAPI spec version: 1.8.0
+Contact: info@hydrogenplatform.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.18
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for NucleusApi::PortfolioApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'PortfolioApi' do
+  before do
+    # run before each test
+    @instance = NucleusApi::PortfolioApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PortfolioApi' do
+    it 'should create an instance of PortfolioApi' do
+      expect(@instance).to be_instance_of(NucleusApi::PortfolioApi)
+    end
+  end
+
+  # unit tests for create_portfolio_asset_size_using_post
+  # Create a portfolio asset size
+  # Create a new asset size record for a portfolio.
+  # @param portfolio_asset_size_log_request portfolioAssetSizeLogRequest
+  # @param [Hash] opts the optional parameters
+  # @return [PortfolioAssetSizeLog]
+  describe 'create_portfolio_asset_size_using_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for create_portfolio_comment_using_post
+  # Create a portfolio commentary
+  # Create a new comment for a portfolio defined for your firm.
+  # @param portfolio_comment portfolioComment
+  # @param [Hash] opts the optional parameters
+  # @return [PortfolioComment]
+  describe 'create_portfolio_comment_using_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for create_portfolio_goal_using_post
+  # Create an portfolio goal
+  # Create an portfolio goal.
+  # @param portfolio_goal portfolioGoal
+  # @param [Hash] opts the optional parameters
+  # @return [PortfolioGoal]
+  describe 'create_portfolio_goal_using_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for create_portfolio_holding_using_post
+  # Create a portfolio holding
+  # Create a new holding record for a portfolio.
+  # @param portfolio_holdin_log_request portfolioHoldinLogRequest
+  # @param [Hash] opts the optional parameters
+  # @return [PortfolioHoldingLog]
+  describe 'create_portfolio_holding_using_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for create_portfolio_transaction_using_post
+  # Create a portfolio transaction
+  # Create a new transaction record for a portfolio.
+  # @param portfolio_transaction_request portfolioTransactionRequest
+  # @param [Hash] opts the optional parameters
+  # @return [PortfolioTransaction]
+  describe 'create_portfolio_transaction_using_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for create_portfolio_using_post
+  # Create a portfolio
+  # Create a new portfolio for an account.
+  # @param portfolio_request portfolioRequest
+  # @param [Hash] opts the optional parameters
+  # @return [Portfolio]
+  describe 'create_portfolio_using_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_portfolio_asset_size_using_delete
+  # Delete a portfolio asset size
+  # Permanently delete a portfolio asset size record for a portfolio.
+  # @param portfolio_asset_size_id UUID portfolio_asset_size_id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_portfolio_asset_size_using_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_portfolio_comment_using_delete
+  # Delete a portfolio commentary
+  # Permanently delete a portfolio comment for a portfolio.
+  # @param portfolio_comment_id UUID portfolio_comment_id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_portfolio_comment_using_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_portfolio_goal_using_delete
+  # Delete an portfolio goal
+  # Permanently delete an portfolio-goal mapping.
+  # @param portfolio_goal_id UUID portfolio_goal_id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_portfolio_goal_using_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_portfolio_holding_using_delete
+  # Delete a portfolio holding
+  # Permanently delete a portfolio holding record for a portfolio.
+  # @param portfolio_holding_id UUID portfolio_holding_id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_portfolio_holding_using_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_portfolio_transaction_using_delete
+  # Delete a portfolio transaction
+  # Permanently delete a portfolio transaction record for a portfolio.
+  # @param portfolio_transaction_id UUID portfolio_transaction_id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_portfolio_transaction_using_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_portfolio_using_delete
+  # Delete a portfolio
+  # Permanently delete a portfolio for an account.
+  # @param portfolio_id UUID portfolio_id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_portfolio_using_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_portfolio_aggregated_data_using_get
+  # Retrieve an portfolio aggregate data
+  # Retrieve the information for a securities associated with a portfolio.
+  # @param portfolio_id Portfolio Id
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :show_asset_class true or false
+  # @option opts [BOOLEAN] :show_category true or false
+  # @option opts [BOOLEAN] :show_industry true or false
+  # @option opts [BOOLEAN] :show_sector true or false
+  # @option opts [BOOLEAN] :show_security_class true or false
+  # @return [Object]
+  describe 'get_portfolio_aggregated_data_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_portfolio_all_using_get
+  # List all portfolios
+  # Get the information for all portfolios assigned to all of your firm’s accounts. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :ascending ascending
+  # @option opts [String] :filter filter
+  # @option opts [String] :order_by order_by
+  # @option opts [Integer] :page page
+  # @option opts [Integer] :size size
+  # @return [PagePortfolio]
+  describe 'get_portfolio_all_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_portfolio_asset_size_all_using_get
+  # Retrieve a portfolio asset size
+  # Retrieve the information for a portfolio asset size record for a portfolio. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :ascending ascending
+  # @option opts [String] :currency_conversion currency_conversion
+  # @option opts [String] :filter filter
+  # @option opts [String] :order_by order_by
+  # @option opts [Integer] :page page
+  # @option opts [Integer] :size size
+  # @return [PagePortfolioAssetSizeLog]
+  describe 'get_portfolio_asset_size_all_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_portfolio_asset_size_using_get
+  # Retrieve a portfolio asset size
+  # Retrieve the information for a portfolio asset size record for a portfolio.
+  # @param portfolio_asset_size_id portfolio_asset_size_id
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :currency_conversion currency_conversion
+  # @return [PortfolioAssetSizeLog]
+  describe 'get_portfolio_asset_size_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_portfolio_comment_all_using_get
+  # List all portfolio commentary
+  # List all comments for all portfolios defined for your firm.
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :ascending ascending
+  # @option opts [String] :filter filter
+  # @option opts [String] :order_by order_by
+  # @option opts [Integer] :page page
+  # @option opts [Integer] :size size
+  # @return [PagePortfolioComment]
+  describe 'get_portfolio_comment_all_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_portfolio_comment_using_get
+  # Retrieve a portfolio commentary
+  # Retrieve the information for a portfolio comment for a portfolio.
+  # @param portfolio_comment_id UUID portfolio_comment_id
+  # @param [Hash] opts the optional parameters
+  # @return [PortfolioComment]
+  describe 'get_portfolio_comment_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_portfolio_goal_all_using_get
+  # List all portfolio goals
+  # Get information for all portfolio-goal mappings defined for your firm.
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :ascending ascending
+  # @option opts [String] :filter filter
+  # @option opts [String] :order_by order_by
+  # @option opts [Integer] :page page
+  # @option opts [Integer] :size size
+  # @return [PagePortfolioGoal]
+  describe 'get_portfolio_goal_all_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_portfolio_goal_using_get
+  # Retrieve an portfolio goal
+  # Retrieve the information for a specific portfolio-goal mapping.
+  # @param portfolio_goal_id UUID portfolio_goal_id
+  # @param [Hash] opts the optional parameters
+  # @return [PortfolioGoal]
+  describe 'get_portfolio_goal_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_portfolio_holding_all_using_get
+  # List all portfolio holdings
+  # Get the information for all holding records for all portfolios defined for your firm.
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :ascending ascending
+  # @option opts [String] :currency_conversion currency_conversion
+  # @option opts [String] :filter filter
+  # @option opts [String] :order_by order_by
+  # @option opts [Integer] :page page
+  # @option opts [Integer] :size size
+  # @return [PagePortfolioHoldingLog]
+  describe 'get_portfolio_holding_all_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_portfolio_holding_using_get
+  # Retrieve a portfolio holding
+  # Retrieve the information for a portfolio holding record for a portfolio.
+  # @param portfolio_holding_id UUID portfolio_holding_id
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :currency_conversion USD
+  # @return [PortfolioHoldingLog]
+  describe 'get_portfolio_holding_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_portfolio_transaction_all_using_get
+  # List all portfolio transactions
+  # Get the information for all transaction records for all portfolios defined for your firm.
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :ascending ascending
+  # @option opts [String] :currency_conversion currency_conversion
+  # @option opts [String] :filter filter
+  # @option opts [String] :order_by order_by
+  # @option opts [Integer] :page page
+  # @option opts [Integer] :size size
+  # @return [PagePortfolioTransaction]
+  describe 'get_portfolio_transaction_all_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_portfolio_transaction_using_get
+  # Retrieve a portfolio transaction
+  # Retrieve the information for a portfolio transaction record for a portfolio. 
+  # @param portfolio_transaction_id UUID portfolio_transaction_id
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :currency_conversion USD
+  # @return [PortfolioTransaction]
+  describe 'get_portfolio_transaction_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_portfolio_using_get
+  # Retrieve a portfolio
+  # Retrieve a portfolio for an account.
+  # @param portfolio_id UUID portfolio_id
+  # @param [Hash] opts the optional parameters
+  # @return [Portfolio]
+  describe 'get_portfolio_using_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_portfolio_asset_size_using_put
+  # Update a portfolio asset size
+  # Update the information for a portfolio asset size record for a portfolio.
+  # @param portfolio_asset_size portfolio_asset_size
+  # @param portfolio_asset_size_id UUID portfolio_asset_size_id
+  # @param [Hash] opts the optional parameters
+  # @return [PortfolioAssetSizeLog]
+  describe 'update_portfolio_asset_size_using_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_portfolio_comment_using_put
+  # Update a portfolio comment
+  # Update the information for a portfolio comment for a portfolio.
+  # @param portfolio_comment portfolio_comment
+  # @param portfolio_comment_id UUID portfolio_comment_id
+  # @param [Hash] opts the optional parameters
+  # @return [PortfolioComment]
+  describe 'update_portfolio_comment_using_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_portfolio_goal_using_put
+  # Update an portfolio goal
+  # Update the information for an portfolio-goal mapping.
+  # @param portfolio_goal portfolio_goal
+  # @param portfolio_goal_id UUID portfolio_goal_id
+  # @param [Hash] opts the optional parameters
+  # @return [PortfolioGoal]
+  describe 'update_portfolio_goal_using_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_portfolio_holding_using_put
+  # Update a portfolio holding
+  # Update the information for a portfolio holding record for a portfolio.
+  # @param portfolio_holding portfolio_holding
+  # @param portfolio_holding_id UUID portfolio_holding_id
+  # @param [Hash] opts the optional parameters
+  # @return [PortfolioHoldingLog]
+  describe 'update_portfolio_holding_using_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_portfolio_transaction_using_put
+  # Update a portfolio transaction
+  # Update the information for a portfolio transaction record for a portfolio.
+  # @param portfolio_transaction portfolio_transaction
+  # @param portfolio_transaction_id UUID portfolio_transaction_id
+  # @param [Hash] opts the optional parameters
+  # @return [PortfolioTransaction]
+  describe 'update_portfolio_transaction_using_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_portfolio_using_put
+  # Update a portfolio
+  # Update a portfolio for an account.
+  # @param portfolio portfolio
+  # @param portfolio_id UUID portfolio_id
+  # @param [Hash] opts the optional parameters
+  # @return [Portfolio]
+  describe 'update_portfolio_using_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end