proton_api 1.8.0 → 1.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (304) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +35 -205
  3. data/lib/proton_api.rb +10 -2
  4. data/lib/proton_api/api/annuities_api.rb +2 -2
  5. data/lib/proton_api/api/business_financial_management_api.rb +2 -2
  6. data/lib/proton_api/api/cards_api.rb +56 -2
  7. data/lib/proton_api/api/financial_health_api.rb +2 -2
  8. data/lib/proton_api/api/financial_planning_api.rb +2 -2
  9. data/lib/proton_api/api/goals_api.rb +2 -2
  10. data/lib/proton_api/api/life_insurance_api.rb +2 -2
  11. data/lib/proton_api/api/personal_financial_management_api.rb +56 -2
  12. data/lib/proton_api/api/portfolio_construction_api.rb +2 -2
  13. data/lib/proton_api/api/portfolio_management_api.rb +2 -2
  14. data/lib/proton_api/api/risk_scoring_api.rb +2 -2
  15. data/lib/proton_api/api/simulations_api.rb +2 -2
  16. data/lib/proton_api/api/util_api.rb +185 -0
  17. data/lib/proton_api/api_client.rb +6 -6
  18. data/lib/proton_api/api_error.rb +2 -2
  19. data/lib/proton_api/configuration.rb +3 -3
  20. data/lib/proton_api/models/accumulation_goal_deposit_config.rb +25 -25
  21. data/lib/proton_api/models/annuity_calculator_accumulation_horizon_request.rb +138 -141
  22. data/lib/proton_api/models/annuity_calculator_annuity_amount_request.rb +129 -132
  23. data/lib/proton_api/models/annuity_calculator_decumulation_horizon_request.rb +138 -141
  24. data/lib/proton_api/models/annuity_calculator_deposit_amount_request.rb +138 -141
  25. data/lib/proton_api/models/annuity_calculator_initial_balance_request.rb +138 -141
  26. data/lib/proton_api/models/annuity_deposit_schedule.rb +33 -36
  27. data/lib/proton_api/models/answer.rb +186 -0
  28. data/lib/proton_api/models/backtest_request.rb +56 -59
  29. data/lib/proton_api/models/beneficiary_bequest_config.rb +32 -35
  30. data/lib/proton_api/models/budget_aggregation_account.rb +7 -10
  31. data/lib/proton_api/models/budget_calculator_request.rb +85 -66
  32. data/lib/proton_api/models/budget_component.rb +25 -28
  33. data/lib/proton_api/models/budget_details.rb +75 -78
  34. data/lib/proton_api/models/business_financial_health_check_request.rb +172 -166
  35. data/lib/proton_api/models/business_invoice_analysis_request.rb +79 -73
  36. data/lib/proton_api/models/calculator_deposit_schedule.rb +22 -25
  37. data/lib/proton_api/models/calculator_deposit_schedule1.rb +33 -36
  38. data/lib/proton_api/models/card_analysis_request.rb +372 -0
  39. data/lib/proton_api/models/card_limit_check_request.rb +42 -14
  40. data/lib/proton_api/models/card_transaction_authorization_request.rb +143 -80
  41. data/lib/proton_api/models/cash_analysis_request.rb +82 -63
  42. data/lib/proton_api/models/cash_flow_analysis_request.rb +104 -76
  43. data/lib/proton_api/models/children_education_config.rb +7 -10
  44. data/lib/proton_api/models/customer_analysis_request.rb +60 -54
  45. data/lib/proton_api/models/decision_tree_result_request.rb +236 -0
  46. data/lib/proton_api/models/decumulation_goal_deposit_config.rb +28 -31
  47. data/lib/proton_api/models/dimensional_risk_score_request.rb +52 -55
  48. data/lib/proton_api/models/diversification_score_request.rb +59 -62
  49. data/lib/proton_api/models/education_calculator_annual_cost_request.rb +143 -146
  50. data/lib/proton_api/models/education_calculator_deposit_amount_request.rb +170 -173
  51. data/lib/proton_api/models/education_calculator_percent_covered_request.rb +136 -139
  52. data/lib/proton_api/models/education_config.rb +44 -47
  53. data/lib/proton_api/models/emergency_fund_calculator_request.rb +182 -185
  54. data/lib/proton_api/models/event_study_request.rb +64 -67
  55. data/lib/proton_api/models/fee_analysis_request.rb +42 -34
  56. data/lib/proton_api/models/financial_health_check_request.rb +109 -112
  57. data/lib/proton_api/models/financial_picture_request.rb +53 -52
  58. data/lib/proton_api/models/financial_statement_analysis_request.rb +140 -134
  59. data/lib/proton_api/models/goal_accumulation_allocation_request.rb +271 -274
  60. data/lib/proton_api/models/goal_accumulation_recommendation_request.rb +218 -221
  61. data/lib/proton_api/models/goal_accumulation_status_request.rb +218 -221
  62. data/lib/proton_api/models/goal_config.rb +35 -38
  63. data/lib/proton_api/models/goal_decumulation_allocation_request.rb +293 -296
  64. data/lib/proton_api/models/goal_decumulation_recommendation_request.rb +242 -245
  65. data/lib/proton_api/models/goal_decumulation_status_request.rb +242 -245
  66. data/lib/proton_api/models/goal_withdrawal_config.rb +82 -85
  67. data/lib/proton_api/models/guaranteed_rate_benefit.rb +51 -54
  68. data/lib/proton_api/models/income_config.rb +37 -40
  69. data/lib/proton_api/models/life_insurance_needs_calculator_request.rb +152 -155
  70. data/lib/proton_api/models/location.rb +183 -0
  71. data/lib/proton_api/models/monte_carlo_request.rb +157 -160
  72. data/lib/proton_api/models/mortgage_calculator_down_payment_request.rb +46 -49
  73. data/lib/proton_api/models/mortgage_calculator_home_price_request.rb +46 -49
  74. data/lib/proton_api/models/mortgage_calculator_periodic_payment_request.rb +71 -74
  75. data/lib/proton_api/models/mvo_request.rb +88 -91
  76. data/lib/proton_api/models/opt_config.rb +54 -57
  77. data/lib/proton_api/models/opt_config1.rb +29 -32
  78. data/lib/proton_api/models/order_rebalance_request.rb +398 -0
  79. data/lib/proton_api/models/performance_calculator_request.rb +687 -0
  80. data/lib/proton_api/models/periods.rb +7 -10
  81. data/lib/proton_api/models/portfolio_optimization_score_request.rb +68 -71
  82. data/lib/proton_api/models/portfolio_what_if_request.rb +71 -74
  83. data/lib/proton_api/models/purchase_calculator_amount_request.rb +112 -115
  84. data/lib/proton_api/models/purchase_calculator_deposit_amount_request.rb +136 -139
  85. data/lib/proton_api/models/purchase_calculator_horizon_request.rb +100 -103
  86. data/lib/proton_api/models/ratio_targets.rb +79 -82
  87. data/lib/proton_api/models/ratio_targets1.rb +38 -41
  88. data/lib/proton_api/models/rebalancing_signal_request.rb +26 -29
  89. data/lib/proton_api/models/recommendation_config.rb +104 -107
  90. data/lib/proton_api/models/recommendation_config1.rb +100 -103
  91. data/lib/proton_api/models/recurring_transaction_analysis_request.rb +106 -76
  92. data/lib/proton_api/models/retirement_calculator_deposit_amount_request.rb +148 -151
  93. data/lib/proton_api/models/retirement_calculator_expenses_request.rb +119 -122
  94. data/lib/proton_api/models/retirement_calculator_percent_covered_request.rb +132 -135
  95. data/lib/proton_api/models/risk_allocation_request.rb +53 -56
  96. data/lib/proton_api/models/risk_score_request.rb +37 -40
  97. data/lib/proton_api/models/savings_calculator_request.rb +100 -103
  98. data/lib/proton_api/models/savings_deposit_schedule.rb +22 -25
  99. data/lib/proton_api/models/scenario_analysis_request.rb +81 -84
  100. data/lib/proton_api/models/sensitivity_analysis_request.rb +77 -80
  101. data/lib/proton_api/models/sensitivity_factor.rb +58 -61
  102. data/lib/proton_api/models/settings.rb +38 -41
  103. data/lib/proton_api/models/spending_analysis_request.rb +505 -0
  104. data/lib/proton_api/models/variable_annuity_request.rb +284 -287
  105. data/lib/proton_api/models/w_config.rb +77 -80
  106. data/lib/proton_api/models/w_config1.rb +66 -69
  107. data/lib/proton_api/version.rb +3 -3
  108. data/proton_api.gemspec +2 -2
  109. data/spec/api/annuities_api_spec.rb +2 -2
  110. data/spec/api/business_financial_management_api_spec.rb +2 -2
  111. data/spec/api/cards_api_spec.rb +14 -2
  112. data/spec/api/financial_health_api_spec.rb +2 -2
  113. data/spec/api/financial_planning_api_spec.rb +2 -2
  114. data/spec/api/goals_api_spec.rb +2 -2
  115. data/spec/api/life_insurance_api_spec.rb +2 -2
  116. data/spec/api/personal_financial_management_api_spec.rb +14 -2
  117. data/spec/api/portfolio_construction_api_spec.rb +2 -2
  118. data/spec/api/portfolio_management_api_spec.rb +2 -2
  119. data/spec/api/risk_scoring_api_spec.rb +2 -2
  120. data/spec/api/simulations_api_spec.rb +2 -2
  121. data/spec/api/util_api_spec.rb +71 -0
  122. data/spec/api_client_spec.rb +2 -2
  123. data/spec/configuration_spec.rb +5 -5
  124. data/spec/models/accumulation_goal_deposit_config_spec.rb +10 -10
  125. data/spec/models/annuity_calculator_accumulation_horizon_request_spec.rb +17 -17
  126. data/spec/models/annuity_calculator_annuity_amount_request_spec.rb +17 -17
  127. data/spec/models/annuity_calculator_decumulation_horizon_request_spec.rb +17 -17
  128. data/spec/models/annuity_calculator_deposit_amount_request_spec.rb +17 -17
  129. data/spec/models/annuity_calculator_initial_balance_request_spec.rb +17 -17
  130. data/spec/models/annuity_deposit_schedule_spec.rb +4 -4
  131. data/spec/models/answer_spec.rb +41 -0
  132. data/spec/models/backtest_request_spec.rb +10 -10
  133. data/spec/models/beneficiary_bequest_config_spec.rb +4 -4
  134. data/spec/models/budget_aggregation_account_spec.rb +2 -2
  135. data/spec/models/budget_calculator_request_spec.rb +25 -13
  136. data/spec/models/budget_component_spec.rb +4 -4
  137. data/spec/models/budget_details_spec.rb +15 -15
  138. data/spec/models/business_financial_health_check_request_spec.rb +34 -28
  139. data/spec/models/business_invoice_analysis_request_spec.rb +18 -12
  140. data/spec/models/calculator_deposit_schedule1_spec.rb +4 -4
  141. data/spec/models/calculator_deposit_schedule_spec.rb +8 -8
  142. data/spec/models/card_analysis_request_spec.rb +129 -0
  143. data/spec/models/card_limit_check_request_spec.rb +20 -2
  144. data/spec/models/card_transaction_authorization_request_spec.rb +57 -15
  145. data/spec/models/cash_analysis_request_spec.rb +25 -13
  146. data/spec/models/cash_flow_analysis_request_spec.rb +34 -16
  147. data/spec/models/children_education_config_spec.rb +2 -2
  148. data/spec/models/customer_analysis_request_spec.rb +15 -9
  149. data/spec/models/decision_tree_result_request_spec.rb +51 -0
  150. data/spec/models/decumulation_goal_deposit_config_spec.rb +10 -10
  151. data/spec/models/dimensional_risk_score_request_spec.rb +8 -8
  152. data/spec/models/diversification_score_request_spec.rb +14 -14
  153. data/spec/models/education_calculator_annual_cost_request_spec.rb +13 -13
  154. data/spec/models/education_calculator_deposit_amount_request_spec.rb +13 -13
  155. data/spec/models/education_calculator_percent_covered_request_spec.rb +12 -12
  156. data/spec/models/education_config_spec.rb +5 -5
  157. data/spec/models/emergency_fund_calculator_request_spec.rb +23 -23
  158. data/spec/models/event_study_request_spec.rb +17 -17
  159. data/spec/models/fee_analysis_request_spec.rb +12 -6
  160. data/spec/models/financial_health_check_request_spec.rb +12 -12
  161. data/spec/models/financial_picture_request_spec.rb +15 -9
  162. data/spec/models/financial_statement_analysis_request_spec.rb +39 -33
  163. data/spec/models/goal_accumulation_allocation_request_spec.rb +48 -48
  164. data/spec/models/goal_accumulation_recommendation_request_spec.rb +34 -34
  165. data/spec/models/goal_accumulation_status_request_spec.rb +34 -34
  166. data/spec/models/goal_config_spec.rb +4 -4
  167. data/spec/models/goal_decumulation_allocation_request_spec.rb +51 -51
  168. data/spec/models/goal_decumulation_recommendation_request_spec.rb +35 -35
  169. data/spec/models/goal_decumulation_status_request_spec.rb +35 -35
  170. data/spec/models/goal_withdrawal_config_spec.rb +20 -20
  171. data/spec/models/guaranteed_rate_benefit_spec.rb +5 -5
  172. data/spec/models/income_config_spec.rb +4 -4
  173. data/spec/models/life_insurance_needs_calculator_request_spec.rb +16 -16
  174. data/spec/models/location_spec.rb +41 -0
  175. data/spec/models/monte_carlo_request_spec.rb +31 -31
  176. data/spec/models/mortgage_calculator_down_payment_request_spec.rb +6 -6
  177. data/spec/models/mortgage_calculator_home_price_request_spec.rb +6 -6
  178. data/spec/models/mortgage_calculator_periodic_payment_request_spec.rb +6 -6
  179. data/spec/models/mvo_request_spec.rb +23 -23
  180. data/spec/models/opt_config1_spec.rb +10 -10
  181. data/spec/models/opt_config_spec.rb +13 -13
  182. data/spec/models/order_rebalance_request_spec.rb +123 -0
  183. data/spec/models/performance_calculator_request_spec.rb +233 -0
  184. data/spec/models/periods_spec.rb +2 -2
  185. data/spec/models/portfolio_optimization_score_request_spec.rb +16 -16
  186. data/spec/models/portfolio_what_if_request_spec.rb +16 -16
  187. data/spec/models/purchase_calculator_amount_request_spec.rb +14 -14
  188. data/spec/models/purchase_calculator_deposit_amount_request_spec.rb +16 -16
  189. data/spec/models/purchase_calculator_horizon_request_spec.rb +10 -10
  190. data/spec/models/ratio_targets1_spec.rb +4 -4
  191. data/spec/models/ratio_targets_spec.rb +8 -8
  192. data/spec/models/rebalancing_signal_request_spec.rb +6 -6
  193. data/spec/models/recommendation_config1_spec.rb +9 -9
  194. data/spec/models/recommendation_config_spec.rb +9 -9
  195. data/spec/models/recurring_transaction_analysis_request_spec.rb +33 -15
  196. data/spec/models/retirement_calculator_deposit_amount_request_spec.rb +13 -13
  197. data/spec/models/retirement_calculator_expenses_request_spec.rb +12 -12
  198. data/spec/models/retirement_calculator_percent_covered_request_spec.rb +12 -12
  199. data/spec/models/risk_allocation_request_spec.rb +15 -15
  200. data/spec/models/risk_score_request_spec.rb +8 -8
  201. data/spec/models/savings_calculator_request_spec.rb +16 -16
  202. data/spec/models/savings_deposit_schedule_spec.rb +8 -8
  203. data/spec/models/scenario_analysis_request_spec.rb +19 -19
  204. data/spec/models/sensitivity_analysis_request_spec.rb +23 -23
  205. data/spec/models/sensitivity_factor_spec.rb +6 -6
  206. data/spec/models/settings_spec.rb +13 -13
  207. data/spec/models/spending_analysis_request_spec.rb +187 -0
  208. data/spec/models/variable_annuity_request_spec.rb +40 -40
  209. data/spec/models/w_config1_spec.rb +6 -6
  210. data/spec/models/w_config_spec.rb +7 -7
  211. data/spec/spec_helper.rb +2 -2
  212. metadata +26 -94
  213. data/docs/AccumulationGoalDepositConfig.md +0 -14
  214. data/docs/AnnuitiesApi.md +0 -344
  215. data/docs/AnnuityCalculatorAccumulationHorizonRequest.md +0 -19
  216. data/docs/AnnuityCalculatorAnnuityAmountRequest.md +0 -19
  217. data/docs/AnnuityCalculatorDecumulationHorizonRequest.md +0 -19
  218. data/docs/AnnuityCalculatorDepositAmountRequest.md +0 -19
  219. data/docs/AnnuityCalculatorInitialBalanceRequest.md +0 -19
  220. data/docs/AnnuityDepositSchedule.md +0 -10
  221. data/docs/BacktestRequest.md +0 -17
  222. data/docs/BeneficiaryBequestConfig.md +0 -10
  223. data/docs/BudgetAggregationAccount.md +0 -8
  224. data/docs/BudgetCalculatorRequest.md +0 -16
  225. data/docs/BudgetComponent.md +0 -10
  226. data/docs/BudgetDetails.md +0 -17
  227. data/docs/BusinessFinancialHealthCheckRequest.md +0 -22
  228. data/docs/BusinessFinancialManagementApi.md +0 -288
  229. data/docs/BusinessInvoiceAnalysisRequest.md +0 -20
  230. data/docs/CalculatorDepositSchedule.md +0 -9
  231. data/docs/CalculatorDepositSchedule1.md +0 -10
  232. data/docs/CardLimitCheckRequest.md +0 -9
  233. data/docs/CardTransactionAuthorizationRequest.md +0 -19
  234. data/docs/CardsApi.md +0 -120
  235. data/docs/CashAnalysisRequest.md +0 -17
  236. data/docs/CashFlowAnalysisRequest.md +0 -20
  237. data/docs/ChildrenEducationConfig.md +0 -9
  238. data/docs/CustomerAnalysisRequest.md +0 -17
  239. data/docs/DecumulationGoalDepositConfig.md +0 -14
  240. data/docs/DimensionalRiskScoreRequest.md +0 -16
  241. data/docs/DiversificationScoreRequest.md +0 -19
  242. data/docs/EducationCalculatorAnnualCostRequest.md +0 -18
  243. data/docs/EducationCalculatorDepositAmountRequest.md +0 -19
  244. data/docs/EducationCalculatorPercentCoveredRequest.md +0 -18
  245. data/docs/EducationConfig.md +0 -10
  246. data/docs/EmergencyFundCalculatorRequest.md +0 -24
  247. data/docs/EventStudyRequest.md +0 -18
  248. data/docs/FeeAnalysisRequest.md +0 -13
  249. data/docs/FinancialHealthApi.md +0 -232
  250. data/docs/FinancialHealthCheckRequest.md +0 -17
  251. data/docs/FinancialPictureRequest.md +0 -16
  252. data/docs/FinancialPlanningApi.md +0 -680
  253. data/docs/FinancialStatementAnalysisRequest.md +0 -22
  254. data/docs/GoalAccumulationAllocationRequest.md +0 -33
  255. data/docs/GoalAccumulationRecommendationRequest.md +0 -28
  256. data/docs/GoalAccumulationStatusRequest.md +0 -28
  257. data/docs/GoalConfig.md +0 -9
  258. data/docs/GoalDecumulationAllocationRequest.md +0 -34
  259. data/docs/GoalDecumulationRecommendationRequest.md +0 -29
  260. data/docs/GoalDecumulationStatusRequest.md +0 -29
  261. data/docs/GoalWithdrawalConfig.md +0 -14
  262. data/docs/GoalsApi.md +0 -344
  263. data/docs/GuaranteedRateBenefit.md +0 -11
  264. data/docs/IncomeConfig.md +0 -10
  265. data/docs/LifeInsuranceApi.md +0 -64
  266. data/docs/LifeInsuranceNeedsCalculatorRequest.md +0 -22
  267. data/docs/MonteCarloRequest.md +0 -29
  268. data/docs/MortgageCalculatorDownPaymentRequest.md +0 -11
  269. data/docs/MortgageCalculatorHomePriceRequest.md +0 -11
  270. data/docs/MortgageCalculatorPeriodicPaymentRequest.md +0 -11
  271. data/docs/MvoRequest.md +0 -18
  272. data/docs/OptConfig.md +0 -14
  273. data/docs/OptConfig1.md +0 -12
  274. data/docs/Periods.md +0 -9
  275. data/docs/PersonalFinancialManagementApi.md +0 -288
  276. data/docs/PortfolioConstructionApi.md +0 -64
  277. data/docs/PortfolioManagementApi.md +0 -64
  278. data/docs/PortfolioOptimizationScoreRequest.md +0 -21
  279. data/docs/PortfolioWhatIfRequest.md +0 -21
  280. data/docs/PurchaseCalculatorAmountRequest.md +0 -16
  281. data/docs/PurchaseCalculatorDepositAmountRequest.md +0 -17
  282. data/docs/PurchaseCalculatorHorizonRequest.md +0 -15
  283. data/docs/RatioTargets.md +0 -13
  284. data/docs/RatioTargets1.md +0 -13
  285. data/docs/RebalancingSignalRequest.md +0 -13
  286. data/docs/RecommendationConfig.md +0 -15
  287. data/docs/RecommendationConfig1.md +0 -14
  288. data/docs/RecurringTransactionAnalysisRequest.md +0 -19
  289. data/docs/RetirementCalculatorDepositAmountRequest.md +0 -20
  290. data/docs/RetirementCalculatorExpensesRequest.md +0 -19
  291. data/docs/RetirementCalculatorPercentCoveredRequest.md +0 -19
  292. data/docs/RiskAllocationRequest.md +0 -14
  293. data/docs/RiskScoreRequest.md +0 -13
  294. data/docs/RiskScoringApi.md +0 -176
  295. data/docs/SavingsCalculatorRequest.md +0 -17
  296. data/docs/SavingsDepositSchedule.md +0 -11
  297. data/docs/ScenarioAnalysisRequest.md +0 -22
  298. data/docs/SensitivityAnalysisRequest.md +0 -22
  299. data/docs/SensitivityFactor.md +0 -11
  300. data/docs/Settings.md +0 -13
  301. data/docs/SimulationsApi.md +0 -400
  302. data/docs/VariableAnnuityRequest.md +0 -34
  303. data/docs/WConfig.md +0 -12
  304. data/docs/WConfig1.md +0 -12
@@ -3,10 +3,10 @@
3
3
 
4
4
  #Financial engineering module of Hydrogen Atom
5
5
 
6
- OpenAPI spec version: 1.8.0
6
+ OpenAPI spec version: 1.9.0
7
7
  Contact: info@hydrogenplatform.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.4.17
9
+ Swagger Codegen version: 2.4.19
10
10
 
11
11
  =end
12
12
 
@@ -14,35 +14,37 @@ require 'date'
14
14
 
15
15
  module ProtonApi
16
16
  class BusinessFinancialHealthCheckRequest
17
- attr_accessor :period_length
17
+ attr_accessor :currency_code
18
18
 
19
- attr_accessor :net_income
19
+ attr_accessor :client_id
20
20
 
21
- attr_accessor :period_month
21
+ attr_accessor :ratio_targets
22
22
 
23
- attr_accessor :total_revenue
23
+ attr_accessor :accounting_method
24
+
25
+ attr_accessor :total_liabilities
24
26
 
25
27
  attr_accessor :total_assets
26
28
 
27
- attr_accessor :client_id
29
+ attr_accessor :currency_conversion
28
30
 
29
- attr_accessor :accounting_method
31
+ attr_accessor :period_quarter
30
32
 
31
- attr_accessor :period_year
33
+ attr_accessor :period_month
32
34
 
33
- attr_accessor :currency_conversion
35
+ attr_accessor :total_equity
34
36
 
35
- attr_accessor :total_liabilities
37
+ attr_accessor :business_id
36
38
 
37
- attr_accessor :period_type
39
+ attr_accessor :period_year
38
40
 
39
- attr_accessor :currency_code
41
+ attr_accessor :total_revenue
40
42
 
41
- attr_accessor :ratio_targets
43
+ attr_accessor :period_length
42
44
 
43
- attr_accessor :total_equity
45
+ attr_accessor :net_income
44
46
 
45
- attr_accessor :period_quarter
47
+ attr_accessor :period_type
46
48
 
47
49
  class EnumAttributeValidator
48
50
  attr_reader :datatype
@@ -69,42 +71,44 @@ module ProtonApi
69
71
  # Attribute mapping from ruby-style variable name to JSON key.
70
72
  def self.attribute_map
71
73
  {
72
- :'period_length' => :'period_length',
73
- :'net_income' => :'net_income',
74
- :'period_month' => :'period_month',
75
- :'total_revenue' => :'total_revenue',
76
- :'total_assets' => :'total_assets',
74
+ :'currency_code' => :'currency_code',
77
75
  :'client_id' => :'client_id',
76
+ :'ratio_targets' => :'ratio_targets',
78
77
  :'accounting_method' => :'accounting_method',
79
- :'period_year' => :'period_year',
80
- :'currency_conversion' => :'currency_conversion',
81
78
  :'total_liabilities' => :'total_liabilities',
82
- :'period_type' => :'period_type',
83
- :'currency_code' => :'currency_code',
84
- :'ratio_targets' => :'ratio_targets',
79
+ :'total_assets' => :'total_assets',
80
+ :'currency_conversion' => :'currency_conversion',
81
+ :'period_quarter' => :'period_quarter',
82
+ :'period_month' => :'period_month',
85
83
  :'total_equity' => :'total_equity',
86
- :'period_quarter' => :'period_quarter'
84
+ :'business_id' => :'business_id',
85
+ :'period_year' => :'period_year',
86
+ :'total_revenue' => :'total_revenue',
87
+ :'period_length' => :'period_length',
88
+ :'net_income' => :'net_income',
89
+ :'period_type' => :'period_type'
87
90
  }
88
91
  end
89
92
 
90
93
  # Attribute type mapping.
91
94
  def self.swagger_types
92
95
  {
93
- :'period_length' => :'String',
94
- :'net_income' => :'Float',
95
- :'period_month' => :'Integer',
96
- :'total_revenue' => :'Float',
97
- :'total_assets' => :'Float',
96
+ :'currency_code' => :'String',
98
97
  :'client_id' => :'String',
98
+ :'ratio_targets' => :'RatioTargets1',
99
99
  :'accounting_method' => :'String',
100
- :'period_year' => :'Integer',
101
- :'currency_conversion' => :'String',
102
100
  :'total_liabilities' => :'Float',
103
- :'period_type' => :'String',
104
- :'currency_code' => :'String',
105
- :'ratio_targets' => :'RatioTargets1',
101
+ :'total_assets' => :'Float',
102
+ :'currency_conversion' => :'String',
103
+ :'period_quarter' => :'Integer',
104
+ :'period_month' => :'Integer',
106
105
  :'total_equity' => :'Float',
107
- :'period_quarter' => :'Integer'
106
+ :'business_id' => :'String',
107
+ :'period_year' => :'Integer',
108
+ :'total_revenue' => :'Float',
109
+ :'period_length' => :'String',
110
+ :'net_income' => :'Float',
111
+ :'period_type' => :'String'
108
112
  }
109
113
  end
110
114
 
@@ -116,66 +120,70 @@ module ProtonApi
116
120
  # convert string to symbol for hash key
117
121
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
118
122
 
119
- if attributes.has_key?(:'period_length')
120
- self.period_length = attributes[:'period_length']
121
- else
122
- self.period_length = 'quarterly'
123
+ if attributes.has_key?(:'currency_code')
124
+ self.currency_code = attributes[:'currency_code']
123
125
  end
124
126
 
125
- if attributes.has_key?(:'net_income')
126
- self.net_income = attributes[:'net_income']
127
+ if attributes.has_key?(:'client_id')
128
+ self.client_id = attributes[:'client_id']
127
129
  end
128
130
 
129
- if attributes.has_key?(:'period_month')
130
- self.period_month = attributes[:'period_month']
131
+ if attributes.has_key?(:'ratio_targets')
132
+ self.ratio_targets = attributes[:'ratio_targets']
131
133
  end
132
134
 
133
- if attributes.has_key?(:'total_revenue')
134
- self.total_revenue = attributes[:'total_revenue']
135
+ if attributes.has_key?(:'accounting_method')
136
+ self.accounting_method = attributes[:'accounting_method']
137
+ end
138
+
139
+ if attributes.has_key?(:'total_liabilities')
140
+ self.total_liabilities = attributes[:'total_liabilities']
135
141
  end
136
142
 
137
143
  if attributes.has_key?(:'total_assets')
138
144
  self.total_assets = attributes[:'total_assets']
139
145
  end
140
146
 
141
- if attributes.has_key?(:'client_id')
142
- self.client_id = attributes[:'client_id']
147
+ if attributes.has_key?(:'currency_conversion')
148
+ self.currency_conversion = attributes[:'currency_conversion']
143
149
  end
144
150
 
145
- if attributes.has_key?(:'accounting_method')
146
- self.accounting_method = attributes[:'accounting_method']
151
+ if attributes.has_key?(:'period_quarter')
152
+ self.period_quarter = attributes[:'period_quarter']
147
153
  end
148
154
 
149
- if attributes.has_key?(:'period_year')
150
- self.period_year = attributes[:'period_year']
155
+ if attributes.has_key?(:'period_month')
156
+ self.period_month = attributes[:'period_month']
151
157
  end
152
158
 
153
- if attributes.has_key?(:'currency_conversion')
154
- self.currency_conversion = attributes[:'currency_conversion']
159
+ if attributes.has_key?(:'total_equity')
160
+ self.total_equity = attributes[:'total_equity']
155
161
  end
156
162
 
157
- if attributes.has_key?(:'total_liabilities')
158
- self.total_liabilities = attributes[:'total_liabilities']
163
+ if attributes.has_key?(:'business_id')
164
+ self.business_id = attributes[:'business_id']
159
165
  end
160
166
 
161
- if attributes.has_key?(:'period_type')
162
- self.period_type = attributes[:'period_type']
167
+ if attributes.has_key?(:'period_year')
168
+ self.period_year = attributes[:'period_year']
163
169
  end
164
170
 
165
- if attributes.has_key?(:'currency_code')
166
- self.currency_code = attributes[:'currency_code']
171
+ if attributes.has_key?(:'total_revenue')
172
+ self.total_revenue = attributes[:'total_revenue']
167
173
  end
168
174
 
169
- if attributes.has_key?(:'ratio_targets')
170
- self.ratio_targets = attributes[:'ratio_targets']
175
+ if attributes.has_key?(:'period_length')
176
+ self.period_length = attributes[:'period_length']
177
+ else
178
+ self.period_length = 'quarterly'
171
179
  end
172
180
 
173
- if attributes.has_key?(:'total_equity')
174
- self.total_equity = attributes[:'total_equity']
181
+ if attributes.has_key?(:'net_income')
182
+ self.net_income = attributes[:'net_income']
175
183
  end
176
184
 
177
- if attributes.has_key?(:'period_quarter')
178
- self.period_quarter = attributes[:'period_quarter']
185
+ if attributes.has_key?(:'period_type')
186
+ self.period_type = attributes[:'period_type']
179
187
  end
180
188
  end
181
189
 
@@ -183,36 +191,36 @@ module ProtonApi
183
191
  # @return Array for valid properties with the reasons
184
192
  def list_invalid_properties
185
193
  invalid_properties = Array.new
186
- if !@period_month.nil? && @period_month > 12
187
- invalid_properties.push('invalid value for "period_month", must be smaller than or equal to 12.')
194
+ if !@total_liabilities.nil? && @total_liabilities < 0
195
+ invalid_properties.push('invalid value for "total_liabilities", must be greater than or equal to 0.')
188
196
  end
189
197
 
190
- if !@period_month.nil? && @period_month < 1
191
- invalid_properties.push('invalid value for "period_month", must be greater than or equal to 1.')
198
+ if !@total_assets.nil? && @total_assets < 0
199
+ invalid_properties.push('invalid value for "total_assets", must be greater than or equal to 0.')
192
200
  end
193
201
 
194
- if !@total_revenue.nil? && @total_revenue < 0
195
- invalid_properties.push('invalid value for "total_revenue", must be greater than or equal to 0.')
202
+ if !@period_quarter.nil? && @period_quarter > 4
203
+ invalid_properties.push('invalid value for "period_quarter", must be smaller than or equal to 4.')
196
204
  end
197
205
 
198
- if !@total_assets.nil? && @total_assets < 0
199
- invalid_properties.push('invalid value for "total_assets", must be greater than or equal to 0.')
206
+ if !@period_quarter.nil? && @period_quarter < 1
207
+ invalid_properties.push('invalid value for "period_quarter", must be greater than or equal to 1.')
200
208
  end
201
209
 
202
- if !@total_liabilities.nil? && @total_liabilities < 0
203
- invalid_properties.push('invalid value for "total_liabilities", must be greater than or equal to 0.')
210
+ if !@period_month.nil? && @period_month > 12
211
+ invalid_properties.push('invalid value for "period_month", must be smaller than or equal to 12.')
204
212
  end
205
213
 
206
- if !@total_equity.nil? && @total_equity < 0
207
- invalid_properties.push('invalid value for "total_equity", must be greater than or equal to 0.')
214
+ if !@period_month.nil? && @period_month < 1
215
+ invalid_properties.push('invalid value for "period_month", must be greater than or equal to 1.')
208
216
  end
209
217
 
210
- if !@period_quarter.nil? && @period_quarter > 4
211
- invalid_properties.push('invalid value for "period_quarter", must be smaller than or equal to 4.')
218
+ if !@total_equity.nil? && @total_equity < 0
219
+ invalid_properties.push('invalid value for "total_equity", must be greater than or equal to 0.')
212
220
  end
213
221
 
214
- if !@period_quarter.nil? && @period_quarter < 1
215
- invalid_properties.push('invalid value for "period_quarter", must be greater than or equal to 1.')
222
+ if !@total_revenue.nil? && @total_revenue < 0
223
+ invalid_properties.push('invalid value for "total_revenue", must be greater than or equal to 0.')
216
224
  end
217
225
 
218
226
  invalid_properties
@@ -221,55 +229,41 @@ module ProtonApi
221
229
  # Check to see if the all the properties in the model are valid
222
230
  # @return true if the model is valid
223
231
  def valid?
224
- period_length_validator = EnumAttributeValidator.new('String', ['annual', 'quarterly', 'monthly', 'ytd', 'qtd', 'mtd'])
225
- return false unless period_length_validator.valid?(@period_length)
226
- return false if !@period_month.nil? && @period_month > 12
227
- return false if !@period_month.nil? && @period_month < 1
228
- return false if !@total_revenue.nil? && @total_revenue < 0
229
- return false if !@total_assets.nil? && @total_assets < 0
230
232
  accounting_method_validator = EnumAttributeValidator.new('String', ['accrual', 'cash'])
231
233
  return false unless accounting_method_validator.valid?(@accounting_method)
232
234
  return false if !@total_liabilities.nil? && @total_liabilities < 0
233
- period_type_validator = EnumAttributeValidator.new('String', ['calendar', 'fiscal'])
234
- return false unless period_type_validator.valid?(@period_type)
235
- return false if !@total_equity.nil? && @total_equity < 0
235
+ return false if !@total_assets.nil? && @total_assets < 0
236
236
  return false if !@period_quarter.nil? && @period_quarter > 4
237
237
  return false if !@period_quarter.nil? && @period_quarter < 1
238
+ return false if !@period_month.nil? && @period_month > 12
239
+ return false if !@period_month.nil? && @period_month < 1
240
+ return false if !@total_equity.nil? && @total_equity < 0
241
+ return false if !@total_revenue.nil? && @total_revenue < 0
242
+ period_length_validator = EnumAttributeValidator.new('String', ['annual', 'quarterly', 'monthly', 'ytd', 'qtd', 'mtd'])
243
+ return false unless period_length_validator.valid?(@period_length)
244
+ period_type_validator = EnumAttributeValidator.new('String', ['calendar', 'fiscal'])
245
+ return false unless period_type_validator.valid?(@period_type)
238
246
  true
239
247
  end
240
248
 
241
249
  # Custom attribute writer method checking allowed values (enum).
242
- # @param [Object] period_length Object to be assigned
243
- def period_length=(period_length)
244
- validator = EnumAttributeValidator.new('String', ['annual', 'quarterly', 'monthly', 'ytd', 'qtd', 'mtd'])
245
- unless validator.valid?(period_length)
246
- fail ArgumentError, 'invalid value for "period_length", must be one of #{validator.allowable_values}.'
247
- end
248
- @period_length = period_length
249
- end
250
-
251
- # Custom attribute writer method with validation
252
- # @param [Object] period_month Value to be assigned
253
- def period_month=(period_month)
254
- if !period_month.nil? && period_month > 12
255
- fail ArgumentError, 'invalid value for "period_month", must be smaller than or equal to 12.'
256
- end
257
-
258
- if !period_month.nil? && period_month < 1
259
- fail ArgumentError, 'invalid value for "period_month", must be greater than or equal to 1.'
250
+ # @param [Object] accounting_method Object to be assigned
251
+ def accounting_method=(accounting_method)
252
+ validator = EnumAttributeValidator.new('String', ['accrual', 'cash'])
253
+ unless validator.valid?(accounting_method)
254
+ fail ArgumentError, 'invalid value for "accounting_method", must be one of #{validator.allowable_values}.'
260
255
  end
261
-
262
- @period_month = period_month
256
+ @accounting_method = accounting_method
263
257
  end
264
258
 
265
259
  # Custom attribute writer method with validation
266
- # @param [Object] total_revenue Value to be assigned
267
- def total_revenue=(total_revenue)
268
- if !total_revenue.nil? && total_revenue < 0
269
- fail ArgumentError, 'invalid value for "total_revenue", must be greater than or equal to 0.'
260
+ # @param [Object] total_liabilities Value to be assigned
261
+ def total_liabilities=(total_liabilities)
262
+ if !total_liabilities.nil? && total_liabilities < 0
263
+ fail ArgumentError, 'invalid value for "total_liabilities", must be greater than or equal to 0.'
270
264
  end
271
265
 
272
- @total_revenue = total_revenue
266
+ @total_liabilities = total_liabilities
273
267
  end
274
268
 
275
269
  # Custom attribute writer method with validation
@@ -282,34 +276,32 @@ module ProtonApi
282
276
  @total_assets = total_assets
283
277
  end
284
278
 
285
- # Custom attribute writer method checking allowed values (enum).
286
- # @param [Object] accounting_method Object to be assigned
287
- def accounting_method=(accounting_method)
288
- validator = EnumAttributeValidator.new('String', ['accrual', 'cash'])
289
- unless validator.valid?(accounting_method)
290
- fail ArgumentError, 'invalid value for "accounting_method", must be one of #{validator.allowable_values}.'
279
+ # Custom attribute writer method with validation
280
+ # @param [Object] period_quarter Value to be assigned
281
+ def period_quarter=(period_quarter)
282
+ if !period_quarter.nil? && period_quarter > 4
283
+ fail ArgumentError, 'invalid value for "period_quarter", must be smaller than or equal to 4.'
291
284
  end
292
- @accounting_method = accounting_method
293
- end
294
285
 
295
- # Custom attribute writer method with validation
296
- # @param [Object] total_liabilities Value to be assigned
297
- def total_liabilities=(total_liabilities)
298
- if !total_liabilities.nil? && total_liabilities < 0
299
- fail ArgumentError, 'invalid value for "total_liabilities", must be greater than or equal to 0.'
286
+ if !period_quarter.nil? && period_quarter < 1
287
+ fail ArgumentError, 'invalid value for "period_quarter", must be greater than or equal to 1.'
300
288
  end
301
289
 
302
- @total_liabilities = total_liabilities
290
+ @period_quarter = period_quarter
303
291
  end
304
292
 
305
- # Custom attribute writer method checking allowed values (enum).
306
- # @param [Object] period_type Object to be assigned
307
- def period_type=(period_type)
308
- validator = EnumAttributeValidator.new('String', ['calendar', 'fiscal'])
309
- unless validator.valid?(period_type)
310
- fail ArgumentError, 'invalid value for "period_type", must be one of #{validator.allowable_values}.'
293
+ # Custom attribute writer method with validation
294
+ # @param [Object] period_month Value to be assigned
295
+ def period_month=(period_month)
296
+ if !period_month.nil? && period_month > 12
297
+ fail ArgumentError, 'invalid value for "period_month", must be smaller than or equal to 12.'
311
298
  end
312
- @period_type = period_type
299
+
300
+ if !period_month.nil? && period_month < 1
301
+ fail ArgumentError, 'invalid value for "period_month", must be greater than or equal to 1.'
302
+ end
303
+
304
+ @period_month = period_month
313
305
  end
314
306
 
315
307
  # Custom attribute writer method with validation
@@ -323,17 +315,33 @@ module ProtonApi
323
315
  end
324
316
 
325
317
  # Custom attribute writer method with validation
326
- # @param [Object] period_quarter Value to be assigned
327
- def period_quarter=(period_quarter)
328
- if !period_quarter.nil? && period_quarter > 4
329
- fail ArgumentError, 'invalid value for "period_quarter", must be smaller than or equal to 4.'
318
+ # @param [Object] total_revenue Value to be assigned
319
+ def total_revenue=(total_revenue)
320
+ if !total_revenue.nil? && total_revenue < 0
321
+ fail ArgumentError, 'invalid value for "total_revenue", must be greater than or equal to 0.'
330
322
  end
331
323
 
332
- if !period_quarter.nil? && period_quarter < 1
333
- fail ArgumentError, 'invalid value for "period_quarter", must be greater than or equal to 1.'
324
+ @total_revenue = total_revenue
325
+ end
326
+
327
+ # Custom attribute writer method checking allowed values (enum).
328
+ # @param [Object] period_length Object to be assigned
329
+ def period_length=(period_length)
330
+ validator = EnumAttributeValidator.new('String', ['annual', 'quarterly', 'monthly', 'ytd', 'qtd', 'mtd'])
331
+ unless validator.valid?(period_length)
332
+ fail ArgumentError, 'invalid value for "period_length", must be one of #{validator.allowable_values}.'
334
333
  end
334
+ @period_length = period_length
335
+ end
335
336
 
336
- @period_quarter = period_quarter
337
+ # Custom attribute writer method checking allowed values (enum).
338
+ # @param [Object] period_type Object to be assigned
339
+ def period_type=(period_type)
340
+ validator = EnumAttributeValidator.new('String', ['calendar', 'fiscal'])
341
+ unless validator.valid?(period_type)
342
+ fail ArgumentError, 'invalid value for "period_type", must be one of #{validator.allowable_values}.'
343
+ end
344
+ @period_type = period_type
337
345
  end
338
346
 
339
347
  # Checks equality by comparing each attribute.
@@ -341,21 +349,22 @@ module ProtonApi
341
349
  def ==(o)
342
350
  return true if self.equal?(o)
343
351
  self.class == o.class &&
344
- period_length == o.period_length &&
345
- net_income == o.net_income &&
346
- period_month == o.period_month &&
347
- total_revenue == o.total_revenue &&
348
- total_assets == o.total_assets &&
352
+ currency_code == o.currency_code &&
349
353
  client_id == o.client_id &&
354
+ ratio_targets == o.ratio_targets &&
350
355
  accounting_method == o.accounting_method &&
351
- period_year == o.period_year &&
352
- currency_conversion == o.currency_conversion &&
353
356
  total_liabilities == o.total_liabilities &&
354
- period_type == o.period_type &&
355
- currency_code == o.currency_code &&
356
- ratio_targets == o.ratio_targets &&
357
+ total_assets == o.total_assets &&
358
+ currency_conversion == o.currency_conversion &&
359
+ period_quarter == o.period_quarter &&
360
+ period_month == o.period_month &&
357
361
  total_equity == o.total_equity &&
358
- period_quarter == o.period_quarter
362
+ business_id == o.business_id &&
363
+ period_year == o.period_year &&
364
+ total_revenue == o.total_revenue &&
365
+ period_length == o.period_length &&
366
+ net_income == o.net_income &&
367
+ period_type == o.period_type
359
368
  end
360
369
 
361
370
  # @see the `==` method
@@ -367,7 +376,7 @@ module ProtonApi
367
376
  # Calculates hash code according to all attributes.
368
377
  # @return [Fixnum] Hash code
369
378
  def hash
370
- [period_length, net_income, period_month, total_revenue, total_assets, client_id, accounting_method, period_year, currency_conversion, total_liabilities, period_type, currency_code, ratio_targets, total_equity, period_quarter].hash
379
+ [currency_code, client_id, ratio_targets, accounting_method, total_liabilities, total_assets, currency_conversion, period_quarter, period_month, total_equity, business_id, period_year, total_revenue, period_length, net_income, period_type].hash
371
380
  end
372
381
 
373
382
  # Builds the object from hash
@@ -389,17 +398,16 @@ module ProtonApi
389
398
 
390
399
  self
391
400
  end
392
-
393
- # Deserializes the data based on type
401
+ # Deserializes the data based on type
394
402
  # @param string type Data type
395
403
  # @param string value Value to be deserialized
396
404
  # @return [Object] Deserialized data
397
405
  def _deserialize(type, value)
398
406
  case type.to_sym
399
407
  when :DateTime
400
- DateTime.parse(value)
408
+ value
401
409
  when :Date
402
- Date.parse(value)
410
+ value
403
411
  when :String
404
412
  value.to_s
405
413
  when :Integer
@@ -431,8 +439,7 @@ module ProtonApi
431
439
  temp_model.build_from_hash(value)
432
440
  end
433
441
  end
434
-
435
- # Returns the string representation of the object
442
+ # Returns the string representation of the object
436
443
  # @return [String] String presentation of the object
437
444
  def to_s
438
445
  to_hash.to_s
@@ -455,8 +462,7 @@ module ProtonApi
455
462
  end
456
463
  hash
457
464
  end
458
-
459
- # Outputs non-array value in the form of hash
465
+ # Outputs non-array value in the form of hash
460
466
  # For object, use to_hash. Otherwise, just return the value
461
467
  # @param [Object] value Any valid value
462
468
  # @return [Hash] Returns the value in the form of hash