proton_api 1.8.0

data/docs/VariableAnnuityRequest.md

@@ -0,0 +1,34 @@
+# ProtonApi::VariableAnnuityRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**portfolio_id** | **String** |  | [optional] 
+**result_type** | **String** |  | [optional] [default to 'median']
+**inflation_rate** | **Float** |  | [optional] [default to 0.0]
+**remove_outliers** | **BOOLEAN** |  | [optional] [default to false]
+**deposit_schedule** | [**AnnuityDepositSchedule**](AnnuityDepositSchedule.md) |  | [optional] 
+**annuitization_rate** | **Float** |  | [optional] [default to 0.0]
+**end_date** | **String** |  | [optional] 
+**market_data_source** | **String** |  | [optional] [default to 'nucleus']
+**tax_rate** | **Float** |  | [optional] [default to 0.0]
+**p** | **Float** |  | [optional] 
+**allocation_id** | **String** |  | [optional] 
+**use_proxy_data** | **BOOLEAN** |  | [optional] [default to false]
+**start_date** | **String** |  | [optional] 
+**aggregation_account_id** | **String** |  | [optional] 
+**initial_balance** | **Float** |  | [optional] [default to 0.0]
+**create_log** | **BOOLEAN** |  | [optional] [default to false]
+**decumulation_horizon** | **Integer** |  | 
+**account_id** | **String** |  | [optional] 
+**accumulation_horizon** | **Integer** |  | 
+**trading_days_per_year** | **Integer** |  | [optional] [default to 252]
+**portfolio_weights** | **Array<Float>** |  | [optional] 
+**guaranteed_accumulation_benefit** | **Float** |  | [optional] [default to 0.0]
+**portfolio_tickers** | **Array<String>** |  | [optional] 
+**guaranteed_rate_benefit** | [**Array<GuaranteedRateBenefit>**](GuaranteedRateBenefit.md) |  | [optional] 
+**model_id** | **String** |  | [optional] 
+**n** | **Integer** |  | [optional] [default to 1000]
+**frequency_interval** | **String** |  | [optional] [default to 'year']
+
+

data/docs/WConfig.md

@@ -0,0 +1,12 @@
+# ProtonApi::WConfig
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**w_min_major** | **Float** |  | 
+**cash_amount** | **Float** |  | 
+**w_min_minor** | **Float** |  | 
+**w_max_minor** | **Float** |  | 
+**w_max_major** | **Float** |  | 
+
+

data/docs/WConfig1.md

@@ -0,0 +1,12 @@
+# ProtonApi::WConfig1
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**w_min_minor** | **Float** |  | [optional] [default to 0.05]
+**cash_amount** | **Float** |  | [optional] [default to 0.0]
+**w_min_major** | **Float** |  | [optional] [default to 0.05]
+**w_max_minor** | **Float** |  | [optional] [default to 1.0]
+**w_max_major** | **Float** |  | [optional] [default to 1.0]
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id=""
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id=""
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note=""
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/proton_api.rb

@@ -0,0 +1,132 @@
+=begin
+#Hydrogen Proton API
+
+#Financial engineering module of Hydrogen Atom
+
+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.17
+
+=end
+
+# Common files
+require 'proton_api/api_client'
+require 'proton_api/api_error'
+require 'proton_api/version'
+require 'proton_api/configuration'
+require 'proton_api/auth_configuration'
+
+# Models
+require 'proton_api/models/accumulation_goal_deposit_config'
+require 'proton_api/models/annuity_calculator_accumulation_horizon_request'
+require 'proton_api/models/annuity_calculator_annuity_amount_request'
+require 'proton_api/models/annuity_calculator_decumulation_horizon_request'
+require 'proton_api/models/annuity_calculator_deposit_amount_request'
+require 'proton_api/models/annuity_calculator_initial_balance_request'
+require 'proton_api/models/annuity_deposit_schedule'
+require 'proton_api/models/backtest_request'
+require 'proton_api/models/beneficiary_bequest_config'
+require 'proton_api/models/budget_aggregation_account'
+require 'proton_api/models/budget_calculator_request'
+require 'proton_api/models/budget_component'
+require 'proton_api/models/budget_details'
+require 'proton_api/models/business_financial_health_check_request'
+require 'proton_api/models/business_invoice_analysis_request'
+require 'proton_api/models/calculator_deposit_schedule'
+require 'proton_api/models/calculator_deposit_schedule1'
+require 'proton_api/models/card_limit_check_request'
+require 'proton_api/models/card_transaction_authorization_request'
+require 'proton_api/models/cash_analysis_request'
+require 'proton_api/models/cash_flow_analysis_request'
+require 'proton_api/models/children_education_config'
+require 'proton_api/models/customer_analysis_request'
+require 'proton_api/models/decumulation_goal_deposit_config'
+require 'proton_api/models/dimensional_risk_score_request'
+require 'proton_api/models/diversification_score_request'
+require 'proton_api/models/education_calculator_annual_cost_request'
+require 'proton_api/models/education_calculator_deposit_amount_request'
+require 'proton_api/models/education_calculator_percent_covered_request'
+require 'proton_api/models/education_config'
+require 'proton_api/models/emergency_fund_calculator_request'
+require 'proton_api/models/event_study_request'
+require 'proton_api/models/fee_analysis_request'
+require 'proton_api/models/financial_health_check_request'
+require 'proton_api/models/financial_picture_request'
+require 'proton_api/models/financial_statement_analysis_request'
+require 'proton_api/models/goal_accumulation_allocation_request'
+require 'proton_api/models/goal_accumulation_recommendation_request'
+require 'proton_api/models/goal_accumulation_status_request'
+require 'proton_api/models/goal_config'
+require 'proton_api/models/goal_decumulation_allocation_request'
+require 'proton_api/models/goal_decumulation_recommendation_request'
+require 'proton_api/models/goal_decumulation_status_request'
+require 'proton_api/models/goal_withdrawal_config'
+require 'proton_api/models/guaranteed_rate_benefit'
+require 'proton_api/models/income_config'
+require 'proton_api/models/life_insurance_needs_calculator_request'
+require 'proton_api/models/monte_carlo_request'
+require 'proton_api/models/mortgage_calculator_down_payment_request'
+require 'proton_api/models/mortgage_calculator_home_price_request'
+require 'proton_api/models/mortgage_calculator_periodic_payment_request'
+require 'proton_api/models/mvo_request'
+require 'proton_api/models/opt_config'
+require 'proton_api/models/opt_config1'
+require 'proton_api/models/periods'
+require 'proton_api/models/portfolio_optimization_score_request'
+require 'proton_api/models/portfolio_what_if_request'
+require 'proton_api/models/purchase_calculator_amount_request'
+require 'proton_api/models/purchase_calculator_deposit_amount_request'
+require 'proton_api/models/purchase_calculator_horizon_request'
+require 'proton_api/models/ratio_targets'
+require 'proton_api/models/ratio_targets1'
+require 'proton_api/models/rebalancing_signal_request'
+require 'proton_api/models/recommendation_config'
+require 'proton_api/models/recommendation_config1'
+require 'proton_api/models/recurring_transaction_analysis_request'
+require 'proton_api/models/retirement_calculator_deposit_amount_request'
+require 'proton_api/models/retirement_calculator_expenses_request'
+require 'proton_api/models/retirement_calculator_percent_covered_request'
+require 'proton_api/models/risk_allocation_request'
+require 'proton_api/models/risk_score_request'
+require 'proton_api/models/savings_calculator_request'
+require 'proton_api/models/savings_deposit_schedule'
+require 'proton_api/models/scenario_analysis_request'
+require 'proton_api/models/sensitivity_analysis_request'
+require 'proton_api/models/sensitivity_factor'
+require 'proton_api/models/settings'
+require 'proton_api/models/variable_annuity_request'
+require 'proton_api/models/w_config'
+require 'proton_api/models/w_config1'
+
+# APIs
+require 'proton_api/api/annuities_api'
+require 'proton_api/api/business_financial_management_api'
+require 'proton_api/api/cards_api'
+require 'proton_api/api/financial_health_api'
+require 'proton_api/api/financial_planning_api'
+require 'proton_api/api/goals_api'
+require 'proton_api/api/life_insurance_api'
+require 'proton_api/api/personal_financial_management_api'
+require 'proton_api/api/portfolio_construction_api'
+require 'proton_api/api/portfolio_management_api'
+require 'proton_api/api/risk_scoring_api'
+require 'proton_api/api/simulations_api'
+
+module ProtonApi
+  class << self
+    # Customize default settings for the SDK using block.
+    #   ProtonApi.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(AuthConfiguration.default)
+      else
+        AuthConfiguration.default
+      end
+    end
+  end
+end

data/lib/proton_api/api/annuities_api.rb

@@ -0,0 +1,347 @@
+=begin
+#Hydrogen Proton API
+
+#Financial engineering module of Hydrogen Atom
+
+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.17
+
+=end
+
+require 'uri'
+
+module ProtonApi
+  class AnnuitiesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Annuity Calculator - Accumulation Horizon
+    # Calculate the necessary fixed annuity contribution period
+    # @param annuity_calculator_accumulation_horizon_request Request payload for Annuity Calculator - Accumulation Horizon
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, Object>]
+    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
+    # Calculate the necessary fixed annuity contribution period
+    # @param annuity_calculator_accumulation_horizon_request Request payload for Annuity Calculator - Accumulation Horizon
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers
+    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
+    # Calculate the achievable fixed annuity amount
+    # @param annuity_calculator_annuity_amount_request Request payload for Annuity Calculator - Annuity Amount
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, Object>]
+    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
+    # Calculate the achievable fixed annuity amount
+    # @param annuity_calculator_annuity_amount_request Request payload for Annuity Calculator - Annuity Amount
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers
+    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
+    # Calculate the achievable fixed annuity payout period
+    # @param annuity_calculator_decumulation_horizon_request Request payload for Annuity Calculator - Decumulation Horizon
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, Object>]
+    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
+    # Calculate the achievable fixed annuity payout period
+    # @param annuity_calculator_decumulation_horizon_request Request payload for Annuity Calculator - Decumulation Horizon
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers
+    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
+    # Calculate the necessary periodic deposit amount for a fixed annuity
+    # @param annuity_calculator_deposit_amount_request Request payload for Annuity Calculator - Deposit Amount
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, Object>]
+    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
+    # Calculate the necessary periodic deposit amount for a fixed annuity
+    # @param annuity_calculator_deposit_amount_request Request payload for Annuity Calculator - Deposit Amount
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers
+    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
+    # Calculate the necessary initial balance for a fixed annuity
+    # @param annuity_calculator_initial_balance_request Request payload for Annuity Calculator - Initial Balance
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, Object>]
+    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
+    # Calculate the necessary initial balance for a fixed annuity
+    # @param annuity_calculator_initial_balance_request Request payload for Annuity Calculator - Initial Balance
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers
+    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
+    # Project the behavior of a variable annuity over time
+    # @param variable_annuity_request Request payload for Variable Annuity
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, Object>]
+    def variable_annuity(variable_annuity_request, opts = {})
+      data, _status_code, _headers = variable_annuity_with_http_info(variable_annuity_request, opts)
+      data
+    end
+
+    # Variable Annuity
+    # Project the behavior of a variable annuity over time
+    # @param variable_annuity_request Request payload for Variable Annuity
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers
+    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
+  end
+end