Module: ProtonApi

Defined in:
lib/proton_api/version.rb,
lib/proton_api.rb,
lib/proton_api/api_error.rb,
lib/proton_api/api_client.rb,
lib/proton_api/api/util_api.rb,
lib/proton_api/api/cards_api.rb,
lib/proton_api/api/goals_api.rb,
lib/proton_api/configuration.rb,
lib/proton_api/models/answer.rb,
lib/proton_api/models/periods.rb,
lib/proton_api/models/location.rb,
lib/proton_api/models/settings.rb,
lib/proton_api/models/w_config.rb,
lib/proton_api/models/w_config1.rb,
lib/proton_api/api/annuities_api.rb,
lib/proton_api/models/opt_config.rb,
lib/proton_api/auth_configuration.rb,
lib/proton_api/models/goal_config.rb,
lib/proton_api/models/mvo_request.rb,
lib/proton_api/models/opt_config1.rb,
lib/proton_api/api/simulations_api.rb,
lib/proton_api/api/risk_scoring_api.rb,
lib/proton_api/models/income_config.rb,
lib/proton_api/models/ratio_targets.rb,
lib/proton_api/models/budget_details.rb,
lib/proton_api/models/ratio_targets1.rb,
lib/proton_api/api/life_insurance_api.rb,
lib/proton_api/models/backtest_request.rb,
lib/proton_api/models/budget_component.rb,
lib/proton_api/models/education_config.rb,
lib/proton_api/api/financial_health_api.rb,
lib/proton_api/models/risk_score_request.rb,
lib/proton_api/models/sensitivity_factor.rb,
lib/proton_api/api/financial_planning_api.rb,
lib/proton_api/models/event_study_request.rb,
lib/proton_api/models/monte_carlo_request.rb,
lib/proton_api/models/fee_analysis_request.rb,
lib/proton_api/api/portfolio_management_api.rb,
lib/proton_api/models/card_analysis_request.rb,
lib/proton_api/models/cash_analysis_request.rb,
lib/proton_api/models/recommendation_config.rb,
lib/proton_api/models/goal_withdrawal_config.rb,
lib/proton_api/models/recommendation_config1.rb,
lib/proton_api/api/portfolio_construction_api.rb,
lib/proton_api/models/guaranteed_rate_benefit.rb,
lib/proton_api/models/order_rebalance_request.rb,
lib/proton_api/models/risk_allocation_request.rb,
lib/proton_api/models/annuity_deposit_schedule.rb,
lib/proton_api/models/card_limit_check_request.rb,
lib/proton_api/models/savings_deposit_schedule.rb,
lib/proton_api/models/variable_annuity_request.rb,
lib/proton_api/models/budget_calculator_request.rb,
lib/proton_api/models/children_education_config.rb,
lib/proton_api/models/customer_analysis_request.rb,
lib/proton_api/models/financial_picture_request.rb,
lib/proton_api/models/portfolio_what_if_request.rb,
lib/proton_api/models/scenario_analysis_request.rb,
lib/proton_api/models/spending_analysis_request.rb,
lib/proton_api/models/beneficiary_bequest_config.rb,
lib/proton_api/models/budget_aggregation_account.rb,
lib/proton_api/models/cash_flow_analysis_request.rb,
lib/proton_api/models/rebalancing_signal_request.rb,
lib/proton_api/models/savings_calculator_request.rb,
lib/proton_api/models/calculator_deposit_schedule.rb,
lib/proton_api/models/calculator_deposit_schedule1.rb,
lib/proton_api/models/decision_tree_result_request.rb,
lib/proton_api/models/sensitivity_analysis_request.rb,
lib/proton_api/models/diversification_score_request.rb,
lib/proton_api/api/business_financial_management_api.rb,
lib/proton_api/api/personal_financial_management_api.rb,
lib/proton_api/models/dimensional_risk_score_request.rb,
lib/proton_api/models/financial_health_check_request.rb,
lib/proton_api/models/performance_calculator_request.rb,
lib/proton_api/models/accumulation_goal_deposit_config.rb,
lib/proton_api/models/decumulation_goal_deposit_config.rb,
lib/proton_api/models/goal_accumulation_status_request.rb,
lib/proton_api/models/goal_decumulation_status_request.rb,
lib/proton_api/models/business_invoice_analysis_request.rb,
lib/proton_api/models/emergency_fund_calculator_request.rb,
lib/proton_api/models/purchase_calculator_amount_request.rb,
lib/proton_api/models/purchase_calculator_horizon_request.rb,
lib/proton_api/models/financial_statement_analysis_request.rb,
lib/proton_api/models/goal_accumulation_allocation_request.rb,
lib/proton_api/models/goal_decumulation_allocation_request.rb,
lib/proton_api/models/portfolio_optimization_score_request.rb,
lib/proton_api/models/card_transaction_authorization_request.rb,
lib/proton_api/models/mortgage_calculator_home_price_request.rb,
lib/proton_api/models/recurring_transaction_analysis_request.rb,
lib/proton_api/models/retirement_calculator_expenses_request.rb,
lib/proton_api/models/business_financial_health_check_request.rb,
lib/proton_api/models/life_insurance_needs_calculator_request.rb,
lib/proton_api/models/education_calculator_annual_cost_request.rb,
lib/proton_api/models/goal_accumulation_recommendation_request.rb,
lib/proton_api/models/goal_decumulation_recommendation_request.rb,
lib/proton_api/models/mortgage_calculator_down_payment_request.rb,
lib/proton_api/models/annuity_calculator_annuity_amount_request.rb,
lib/proton_api/models/annuity_calculator_deposit_amount_request.rb,
lib/proton_api/models/annuity_calculator_initial_balance_request.rb,
lib/proton_api/models/purchase_calculator_deposit_amount_request.rb,
lib/proton_api/models/education_calculator_deposit_amount_request.rb,
lib/proton_api/models/education_calculator_percent_covered_request.rb,
lib/proton_api/models/mortgage_calculator_periodic_payment_request.rb,
lib/proton_api/models/retirement_calculator_deposit_amount_request.rb,
lib/proton_api/models/retirement_calculator_percent_covered_request.rb,
lib/proton_api/models/annuity_calculator_accumulation_horizon_request.rb,
lib/proton_api/models/annuity_calculator_decumulation_horizon_request.rb

Overview

#Hydrogen Proton API

#Financial engineering module of Hydrogen Atom

OpenAPI spec version: 1.9.0 Contact: [email protected] Generated by: github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.19

Defined Under Namespace

Classes: AccumulationGoalDepositConfig, AnnuitiesApi, AnnuityCalculatorAccumulationHorizonRequest, AnnuityCalculatorAnnuityAmountRequest, AnnuityCalculatorDecumulationHorizonRequest, AnnuityCalculatorDepositAmountRequest, AnnuityCalculatorInitialBalanceRequest, AnnuityDepositSchedule, Answer, ApiClient, ApiError, AuthConfiguration, BacktestRequest, BeneficiaryBequestConfig, BudgetAggregationAccount, BudgetCalculatorRequest, BudgetComponent, BudgetDetails, BusinessFinancialHealthCheckRequest, BusinessFinancialManagementApi, BusinessInvoiceAnalysisRequest, CalculatorDepositSchedule, CalculatorDepositSchedule1, CardAnalysisRequest, CardLimitCheckRequest, CardTransactionAuthorizationRequest, CardsApi, CashAnalysisRequest, CashFlowAnalysisRequest, ChildrenEducationConfig, Configuration, CustomerAnalysisRequest, DecisionTreeResultRequest, DecumulationGoalDepositConfig, DimensionalRiskScoreRequest, DiversificationScoreRequest, EducationCalculatorAnnualCostRequest, EducationCalculatorDepositAmountRequest, EducationCalculatorPercentCoveredRequest, EducationConfig, EmergencyFundCalculatorRequest, EventStudyRequest, FeeAnalysisRequest, FinancialHealthApi, FinancialHealthCheckRequest, FinancialPictureRequest, FinancialPlanningApi, FinancialStatementAnalysisRequest, GoalAccumulationAllocationRequest, GoalAccumulationRecommendationRequest, GoalAccumulationStatusRequest, GoalConfig, GoalDecumulationAllocationRequest, GoalDecumulationRecommendationRequest, GoalDecumulationStatusRequest, GoalWithdrawalConfig, GoalsApi, GuaranteedRateBenefit, IncomeConfig, LifeInsuranceApi, LifeInsuranceNeedsCalculatorRequest, Location, MonteCarloRequest, MortgageCalculatorDownPaymentRequest, MortgageCalculatorHomePriceRequest, MortgageCalculatorPeriodicPaymentRequest, MvoRequest, OptConfig, OptConfig1, OrderRebalanceRequest, PerformanceCalculatorRequest, Periods, PersonalFinancialManagementApi, PortfolioConstructionApi, PortfolioManagementApi, PortfolioOptimizationScoreRequest, PortfolioWhatIfRequest, PurchaseCalculatorAmountRequest, PurchaseCalculatorDepositAmountRequest, PurchaseCalculatorHorizonRequest, RatioTargets, RatioTargets1, RebalancingSignalRequest, RecommendationConfig, RecommendationConfig1, RecurringTransactionAnalysisRequest, RetirementCalculatorDepositAmountRequest, RetirementCalculatorExpensesRequest, RetirementCalculatorPercentCoveredRequest, RiskAllocationRequest, RiskScoreRequest, RiskScoringApi, SavingsCalculatorRequest, SavingsDepositSchedule, ScenarioAnalysisRequest, SensitivityAnalysisRequest, SensitivityFactor, Settings, SimulationsApi, SpendingAnalysisRequest, UtilApi, VariableAnnuityRequest, WConfig, WConfig1

Constant Summary collapse

VERSION = 
'1.9.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

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.



132
133
134
135
136
137
138
 
# File 'lib/proton_api.rb', line 132

def configure
  if block_given?
    yield(AuthConfiguration.default)
  else
    AuthConfiguration.default
  end
end