hydrogen-proton-api 1.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c79e7bd7feb34230f468b3a1e5e2602e5c7333f2cacd1f15d9b093446f3da56
+  data.tar.gz: 74160219b16105700a6ec7230b2360b00ee788a9af5837b2b0e380bd6c134971
+SHA512:
+  metadata.gz: 63363c0e58cb66aae3a8f71c4e4b02ce31f5fa076e1edd10fdf1f421d3e795ce1927cc166a30b3ad861ff9cf6ceb8e16e46c5314f249c92cfb6e25ea1420ffa8
+  data.tar.gz: c4ccd61187e9e32612e5e4967b13a2facbbc4b8dc092f72054fabd2c1375bcd8a6980dee0498df98214a3b91b9b3531ca8d188d4922746ffbe37ca3fd8515393

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.3.3'
+end

data/README.md

@@ -0,0 +1,82 @@
+# Hydrogen Proton API
+
+Hydrogen Proton API
+- API version: 1.9.1
+  - Build date: 01-07-2021
+
+For more information, please visit [https://www.hydrogenplatform.com/apis](https://www.hydrogenplatform.com/apis)
+
+## Documentation
+
+https://www.hydrogenplatform.com/docs/proton/v1
+
+## Requirements
+1. Ruby 2.7+
+
+## Installation
+
+### Install via Ruby Gems
+
+Install the gem:
+
+```shell
+gem install hydrogen-proton-api
+```
+
+The add this to the Gemfile:
+
+    gem 'hydrogen-proton-api', '~> 1.9', '>= 1.9.1'
+
+## Getting Started
+
+Please first follow the [installation](#installation) instructions. Then make sure you use the proper base URL:
+
+### Base URL
+
+Create an object of **Environment** and use the **set_environment** method to update the environment.
+
+**Sandbox URL**
+
+environment_config = ProtonApi::Environment.new
+
+environment_config.set_environment(environment_config.SANDBOX)
+
+**Production URL**
+
+environment_config = ProtonApi::Environment.new
+
+environment_config.set_environment(environment_config.PRODUCTION)
+
+```ruby
+# Load the gem
+require 'proton_api'
+environment_config = ProtonApi::Environment.new
+environment_config.set_environment(environment_config.PRODUCTION)
+# Setup authorization
+ProtonApi.configure do |config|
+# Use one of the below method to generate oauth token        
+# Creating a token for grant_type=client_credentials
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
+# Creating a token for grant_type=password
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
+# Creating a token using client token
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
+end
+api_instance = ProtonApi::AnnuitiesApi.new
+
+annuity_calculator_accumulation_horizon_request = ProtonApi::AnnuityCalculatorAccumulationHorizonRequest.new # AnnuityCalculatorAccumulationHorizonRequest | Request payload for Annuity Calculator - Accumulation Horizon
+begin
+  #Annuity Calculator - Accumulation Horizon
+  result = api_instance.annuity_calculator_accumulation_horizon(annuity_calculator_accumulation_horizon_request)
+  p result
+rescue ProtonApi::ApiError => e
+  puts "Exception when calling AnnuitiesApi->annuity_calculator_accumulation_horizon: #{e}"
+end
+
+```
+## Author
+The Hydrogen Technology Corporation
+
+https://www.hydrogenplatform.com
+
+*Generated using [Swagger Codegen](https://github.com/swagger-api/swagger-codegen)*

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

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,141 @@
+=begin
+#Hydrogen Proton API
+
+#Financial engineering module of Hydrogen Atom
+
+OpenAPI spec version: 1.9.1
+Contact: info@hydrogenplatform.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.19
+
+=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'
+require 'proton_api/environment'
+
+# 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/answer'
+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_analysis_request'
+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/decision_tree_result_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/location'
+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/order_rebalance_request'
+require 'proton_api/models/performance_calculator_request'
+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/spending_analysis_request'
+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'
+require 'proton_api/api/util_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.9.1
+Contact: info@hydrogenplatform.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.19
+
+=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