nucleus_api 1.8.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 (805) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/README.md +787 -0
  4. data/Rakefile +8 -0
  5. data/docs/Account.md +22 -0
  6. data/docs/AccountAllocationMapping.md +17 -0
  7. data/docs/AccountApi.md +1919 -0
  8. data/docs/AccountMap.md +9 -0
  9. data/docs/AccountPermissionVO.md +9 -0
  10. data/docs/AccountPortfolioRebalanceRequest.md +21 -0
  11. data/docs/AccountStatus.md +16 -0
  12. data/docs/AccountType.md +23 -0
  13. data/docs/AclClientPermissionVO.md +10 -0
  14. data/docs/AdminClient.md +18 -0
  15. data/docs/AdminClientApi.md +309 -0
  16. data/docs/AggregationAccount.md +30 -0
  17. data/docs/AggregationAccountApi.md +1702 -0
  18. data/docs/AggregationAccountBalance.md +18 -0
  19. data/docs/AggregationAccountHolding.md +26 -0
  20. data/docs/AggregationAccountTransaction.md +23 -0
  21. data/docs/AggregationAccountsMap.md +9 -0
  22. data/docs/Allocation.md +22 -0
  23. data/docs/AllocationAggregatedVO.md +13 -0
  24. data/docs/AllocationApi.md +872 -0
  25. data/docs/AllocationComposition.md +18 -0
  26. data/docs/AllocationCompositionAggregatedVO.md +19 -0
  27. data/docs/AllocationCompositionModelHoldingsVO.md +22 -0
  28. data/docs/AllocationNodeMap.md +8 -0
  29. data/docs/Answer.md +18 -0
  30. data/docs/AnswerMap.md +8 -0
  31. data/docs/Application.md +15 -0
  32. data/docs/ApplicationApi.md +309 -0
  33. data/docs/AuditLog.md +23 -0
  34. data/docs/AuditLogApi.md +191 -0
  35. data/docs/AvailableDateDoubleVO.md +14 -0
  36. data/docs/BankCredit.md +15 -0
  37. data/docs/BankLink.md +29 -0
  38. data/docs/BankLinkMap.md +9 -0
  39. data/docs/Benchmark.md +17 -0
  40. data/docs/BenchmarkApi.md +375 -0
  41. data/docs/BenchmarkComposition.md +9 -0
  42. data/docs/Brokers.md +9 -0
  43. data/docs/Budget.md +25 -0
  44. data/docs/BudgetAggregationAccount.md +8 -0
  45. data/docs/BudgetApi.md +315 -0
  46. data/docs/BudgetObject.md +10 -0
  47. data/docs/BulkApi.md +249 -0
  48. data/docs/BulkTransaction.md +13 -0
  49. data/docs/BulkTransactionVO.md +12 -0
  50. data/docs/Business.md +32 -0
  51. data/docs/BusinessAddress.md +15 -0
  52. data/docs/BusinessApi.md +523 -0
  53. data/docs/Card.md +35 -0
  54. data/docs/CardAddress.md +14 -0
  55. data/docs/CardApi.md +754 -0
  56. data/docs/CardProgram.md +23 -0
  57. data/docs/Cash.md +10 -0
  58. data/docs/CategoriesMap.md +9 -0
  59. data/docs/CategoryInternalResponseVO.md +10 -0
  60. data/docs/CategoryResponseVO.md +9 -0
  61. data/docs/Check.md +10 -0
  62. data/docs/CheckImages.md +9 -0
  63. data/docs/Client.md +39 -0
  64. data/docs/ClientAccountMapping.md +10 -0
  65. data/docs/ClientAddress.md +15 -0
  66. data/docs/ClientApi.md +1008 -0
  67. data/docs/ClientRelationship.md +10 -0
  68. data/docs/ClientResponse.md +17 -0
  69. data/docs/ClientStatus.md +16 -0
  70. data/docs/ClientViewGoalData.md +21 -0
  71. data/docs/Country.md +12 -0
  72. data/docs/Currency.md +11 -0
  73. data/docs/Customer.md +21 -0
  74. data/docs/CustomerAddress.md +14 -0
  75. data/docs/CustomerApi.md +616 -0
  76. data/docs/CustomerRevenue.md +16 -0
  77. data/docs/DailyDeposit.md +28 -0
  78. data/docs/DailyWithdrawal.md +29 -0
  79. data/docs/DateDoubleVO.md +10 -0
  80. data/docs/DecisionTree.md +17 -0
  81. data/docs/DecisionTreeApi.md +971 -0
  82. data/docs/DecisionTreeCO.md +9 -0
  83. data/docs/DecisionTreeResultVO.md +9 -0
  84. data/docs/Document.md +30 -0
  85. data/docs/DocumentApi.md +309 -0
  86. data/docs/Employment.md +11 -0
  87. data/docs/ExternalAccountTransfer.md +28 -0
  88. data/docs/Feature.md +18 -0
  89. data/docs/FeatureApi.md +610 -0
  90. data/docs/FeatureTrack.md +14 -0
  91. data/docs/FinancialStatement.md +23 -0
  92. data/docs/FinancialStatementApi.md +315 -0
  93. data/docs/Funding.md +37 -0
  94. data/docs/FundingApi.md +1601 -0
  95. data/docs/FundingRequestMap.md +8 -0
  96. data/docs/FxRateView.md +11 -0
  97. data/docs/Goal.md +24 -0
  98. data/docs/GoalAccountMapping.md +11 -0
  99. data/docs/GoalApi.md +841 -0
  100. data/docs/GoalTrack.md +26 -0
  101. data/docs/GoalTrackAccounts.md +8 -0
  102. data/docs/Household.md +18 -0
  103. data/docs/HouseholdApi.md +523 -0
  104. data/docs/Investment.md +16 -0
  105. data/docs/Invoice.md +32 -0
  106. data/docs/InvoiceApi.md +622 -0
  107. data/docs/InvoicePayment.md +15 -0
  108. data/docs/JsonNode.md +29 -0
  109. data/docs/LineItems.md +15 -0
  110. data/docs/Location.md +15 -0
  111. data/docs/MXMerchantRes.md +14 -0
  112. data/docs/Member.md +11 -0
  113. data/docs/MerchantCategoryCode.md +11 -0
  114. data/docs/MerchantsMap.md +9 -0
  115. data/docs/Model.md +29 -0
  116. data/docs/ModelApi.md +1580 -0
  117. data/docs/ModelAssetSize.md +16 -0
  118. data/docs/ModelComment.md +15 -0
  119. data/docs/ModelHolding.md +25 -0
  120. data/docs/ModelHoldingVO.md +11 -0
  121. data/docs/ModelTransaction.md +17 -0
  122. data/docs/Node.md +15 -0
  123. data/docs/NodeRelationship.md +18 -0
  124. data/docs/Notification.md +20 -0
  125. data/docs/NotificationApi.md +911 -0
  126. data/docs/NotificationClient.md +19 -0
  127. data/docs/NotificationSetting.md +19 -0
  128. data/docs/Order.md +27 -0
  129. data/docs/OrderApi.md +1764 -0
  130. data/docs/OrderBulk.md +18 -0
  131. data/docs/OrderReconcileRequest.md +12 -0
  132. data/docs/OrderReconcileReturnObject.md +12 -0
  133. data/docs/OrderStatus.md +14 -0
  134. data/docs/OrderTrack.md +20 -0
  135. data/docs/OrderVoClone.md +20 -0
  136. data/docs/Overflow.md +16 -0
  137. data/docs/OverflowApi.md +492 -0
  138. data/docs/OverflowBankLinkMap.md +9 -0
  139. data/docs/OverflowSettings.md +17 -0
  140. data/docs/OverflowVO.md +10 -0
  141. data/docs/Ownership.md +12 -0
  142. data/docs/PageAccount.md +16 -0
  143. data/docs/PageAccountAllocationMapping.md +16 -0
  144. data/docs/PageAccountPermissionVO.md +16 -0
  145. data/docs/PageAccountStatus.md +16 -0
  146. data/docs/PageAccountType.md +16 -0
  147. data/docs/PageAdminClient.md +16 -0
  148. data/docs/PageAggregationAccount.md +16 -0
  149. data/docs/PageAggregationAccountBalance.md +16 -0
  150. data/docs/PageAggregationAccountHolding.md +16 -0
  151. data/docs/PageAggregationAccountTransaction.md +16 -0
  152. data/docs/PageAllocation.md +16 -0
  153. data/docs/PageAllocationComposition.md +16 -0
  154. data/docs/PageAnswer.md +16 -0
  155. data/docs/PageApplication.md +16 -0
  156. data/docs/PageAuditLog.md +16 -0
  157. data/docs/PageBankLink.md +16 -0
  158. data/docs/PageBenchmark.md +16 -0
  159. data/docs/PageBudget.md +16 -0
  160. data/docs/PageBusiness.md +16 -0
  161. data/docs/PageCard.md +16 -0
  162. data/docs/PageCardProgram.md +16 -0
  163. data/docs/PageClient.md +16 -0
  164. data/docs/PageClientResponse.md +16 -0
  165. data/docs/PageClientStatus.md +16 -0
  166. data/docs/PageCustomer.md +16 -0
  167. data/docs/PageCustomerRevenue.md +16 -0
  168. data/docs/PageDailyDeposit.md +16 -0
  169. data/docs/PageDailyWithdrawal.md +16 -0
  170. data/docs/PageDecisionTree.md +16 -0
  171. data/docs/PageDocument.md +16 -0
  172. data/docs/PageExternalAccountTransfer.md +16 -0
  173. data/docs/PageFeature.md +16 -0
  174. data/docs/PageFeatureTrack.md +16 -0
  175. data/docs/PageFinancialStatement.md +16 -0
  176. data/docs/PageFunding.md +16 -0
  177. data/docs/PageGoal.md +16 -0
  178. data/docs/PageGoalTrack.md +16 -0
  179. data/docs/PageHousehold.md +16 -0
  180. data/docs/PageInvoice.md +16 -0
  181. data/docs/PageInvoicePayment.md +16 -0
  182. data/docs/PageMXMerchantRes.md +16 -0
  183. data/docs/PageModel.md +16 -0
  184. data/docs/PageModelAssetSize.md +16 -0
  185. data/docs/PageModelComment.md +16 -0
  186. data/docs/PageModelHolding.md +16 -0
  187. data/docs/PageModelTransaction.md +16 -0
  188. data/docs/PageNode.md +16 -0
  189. data/docs/PageNodeRelationship.md +16 -0
  190. data/docs/PageNotification.md +16 -0
  191. data/docs/PageNotificationClient.md +16 -0
  192. data/docs/PageNotificationSetting.md +16 -0
  193. data/docs/PageOrder.md +16 -0
  194. data/docs/PageOrderBulk.md +16 -0
  195. data/docs/PageOrderStatus.md +16 -0
  196. data/docs/PageOrderTrack.md +16 -0
  197. data/docs/PageOverflow.md +16 -0
  198. data/docs/PageOverflowSettings.md +16 -0
  199. data/docs/PagePortfolio.md +16 -0
  200. data/docs/PagePortfolioAssetSizeLog.md +16 -0
  201. data/docs/PagePortfolioComment.md +16 -0
  202. data/docs/PagePortfolioGoal.md +16 -0
  203. data/docs/PagePortfolioHoldingLog.md +16 -0
  204. data/docs/PagePortfolioTransaction.md +16 -0
  205. data/docs/PageQuestion.md +16 -0
  206. data/docs/PageQuestionnaire.md +16 -0
  207. data/docs/PageReasonCode.md +16 -0
  208. data/docs/PageRiskProfile.md +16 -0
  209. data/docs/PageRoundup.md +16 -0
  210. data/docs/PageRoundupSettings.md +16 -0
  211. data/docs/PageScore.md +16 -0
  212. data/docs/PageSecurity.md +16 -0
  213. data/docs/PageSecurityExclusion.md +16 -0
  214. data/docs/PageSecurityPrice.md +16 -0
  215. data/docs/PageSpendingControl.md +16 -0
  216. data/docs/PageStage.md +16 -0
  217. data/docs/PageTransactionCode.md +16 -0
  218. data/docs/PageVAccountAssetSize.md +16 -0
  219. data/docs/PageWebhook.md +16 -0
  220. data/docs/PerformanceApi.md +973 -0
  221. data/docs/PermissionVO.md +9 -0
  222. data/docs/Portfolio.md +22 -0
  223. data/docs/PortfolioApi.md +1902 -0
  224. data/docs/PortfolioAssetSizeLog.md +20 -0
  225. data/docs/PortfolioComment.md +16 -0
  226. data/docs/PortfolioGoal.md +14 -0
  227. data/docs/PortfolioGoalMap.md +9 -0
  228. data/docs/PortfolioHoldingAgg.md +14 -0
  229. data/docs/PortfolioHoldingLog.md +21 -0
  230. data/docs/PortfolioTransaction.md +37 -0
  231. data/docs/Question.md +23 -0
  232. data/docs/Questionnaire.md +17 -0
  233. data/docs/QuestionnaireApi.md +1212 -0
  234. data/docs/ReasonCode.md +17 -0
  235. data/docs/ResourceApi.md +534 -0
  236. data/docs/RiskProfile.md +18 -0
  237. data/docs/RiskProfileApi.md +309 -0
  238. data/docs/Roundup.md +15 -0
  239. data/docs/RoundupApi.md +492 -0
  240. data/docs/RoundupCO.md +12 -0
  241. data/docs/RoundupSettings.md +21 -0
  242. data/docs/Score.md +23 -0
  243. data/docs/ScoreApi.md +309 -0
  244. data/docs/SecuritiesApi.md +917 -0
  245. data/docs/SecuritiesComposition.md +11 -0
  246. data/docs/SecuritiesCountry.md +9 -0
  247. data/docs/Security.md +32 -0
  248. data/docs/SecurityCompositionVO.md +21 -0
  249. data/docs/SecurityCountryVO.md +9 -0
  250. data/docs/SecurityExclusion.md +18 -0
  251. data/docs/SecurityPrice.md +20 -0
  252. data/docs/Sort.md +13 -0
  253. data/docs/SpendingControl.md +21 -0
  254. data/docs/SpendingControlApi.md +309 -0
  255. data/docs/Stage.md +22 -0
  256. data/docs/Stat.md +9 -0
  257. data/docs/State.md +10 -0
  258. data/docs/StatisticResourceVO.md +11 -0
  259. data/docs/TokenDateRequest.md +13 -0
  260. data/docs/TransactionCode.md +20 -0
  261. data/docs/UtilsApi.md +911 -0
  262. data/docs/VAccountAssetSize.md +11 -0
  263. data/docs/VAccountVO.md +13 -0
  264. data/docs/VClientGoalViewData.md +13 -0
  265. data/docs/VPortfolioVO.md +11 -0
  266. data/docs/Webhook.md +15 -0
  267. data/docs/WebhookApi.md +309 -0
  268. data/git_push.sh +55 -0
  269. data/lib/nucleus_api.rb +303 -0
  270. data/lib/nucleus_api/api/account_api.rb +1794 -0
  271. data/lib/nucleus_api/api/admin_client_api.rb +301 -0
  272. data/lib/nucleus_api/api/aggregation_account_api.rb +1587 -0
  273. data/lib/nucleus_api/api/allocation_api.rb +824 -0
  274. data/lib/nucleus_api/api/application_api.rb +301 -0
  275. data/lib/nucleus_api/api/audit_log_api.rb +190 -0
  276. data/lib/nucleus_api/api/benchmark_api.rb +362 -0
  277. data/lib/nucleus_api/api/budget_api.rb +307 -0
  278. data/lib/nucleus_api/api/bulk_api.rb +253 -0
  279. data/lib/nucleus_api/api/business_api.rb +508 -0
  280. data/lib/nucleus_api/api/card_api.rb +719 -0
  281. data/lib/nucleus_api/api/client_api.rb +950 -0
  282. data/lib/nucleus_api/api/customer_api.rb +585 -0
  283. data/lib/nucleus_api/api/decision_tree_api.rb +913 -0
  284. data/lib/nucleus_api/api/document_api.rb +301 -0
  285. data/lib/nucleus_api/api/feature_api.rb +579 -0
  286. data/lib/nucleus_api/api/financial_statement_api.rb +307 -0
  287. data/lib/nucleus_api/api/funding_api.rb +1497 -0
  288. data/lib/nucleus_api/api/goal_api.rb +819 -0
  289. data/lib/nucleus_api/api/household_api.rb +508 -0
  290. data/lib/nucleus_api/api/invoice_api.rb +591 -0
  291. data/lib/nucleus_api/api/model_api.rb +1479 -0
  292. data/lib/nucleus_api/api/notification_api.rb +857 -0
  293. data/lib/nucleus_api/api/order_api.rb +1688 -0
  294. data/lib/nucleus_api/api/overflow_api.rb +468 -0
  295. data/lib/nucleus_api/api/performance_api.rb +1131 -0
  296. data/lib/nucleus_api/api/portfolio_api.rb +1776 -0
  297. data/lib/nucleus_api/api/questionnaire_api.rb +1135 -0
  298. data/lib/nucleus_api/api/resource_api.rb +479 -0
  299. data/lib/nucleus_api/api/risk_profile_api.rb +301 -0
  300. data/lib/nucleus_api/api/roundup_api.rb +468 -0
  301. data/lib/nucleus_api/api/score_api.rb +301 -0
  302. data/lib/nucleus_api/api/securities_api.rb +863 -0
  303. data/lib/nucleus_api/api/spending_control_api.rb +301 -0
  304. data/lib/nucleus_api/api/utils_api.rb +857 -0
  305. data/lib/nucleus_api/api/webhook_api.rb +301 -0
  306. data/lib/nucleus_api/api_client.rb +428 -0
  307. data/lib/nucleus_api/api_error.rb +38 -0
  308. data/lib/nucleus_api/auth_configuration.rb +177 -0
  309. data/lib/nucleus_api/configuration.rb +224 -0
  310. data/lib/nucleus_api/models/account.rb +333 -0
  311. data/lib/nucleus_api/models/account_allocation_mapping.rb +294 -0
  312. data/lib/nucleus_api/models/account_map.rb +202 -0
  313. data/lib/nucleus_api/models/account_permission_vo.rb +195 -0
  314. data/lib/nucleus_api/models/account_portfolio_rebalance_request.rb +313 -0
  315. data/lib/nucleus_api/models/account_status.rb +275 -0
  316. data/lib/nucleus_api/models/account_type.rb +335 -0
  317. data/lib/nucleus_api/models/acl_client_permission_vo.rb +236 -0
  318. data/lib/nucleus_api/models/admin_client.rb +272 -0
  319. data/lib/nucleus_api/models/aggregation_account.rb +420 -0
  320. data/lib/nucleus_api/models/aggregation_account_balance.rb +284 -0
  321. data/lib/nucleus_api/models/aggregation_account_holding.rb +364 -0
  322. data/lib/nucleus_api/models/aggregation_account_transaction.rb +382 -0
  323. data/lib/nucleus_api/models/aggregation_accounts_map.rb +202 -0
  324. data/lib/nucleus_api/models/allocation.rb +325 -0
  325. data/lib/nucleus_api/models/allocation_aggregated_vo.rb +228 -0
  326. data/lib/nucleus_api/models/allocation_composition.rb +304 -0
  327. data/lib/nucleus_api/models/allocation_composition_aggregated_vo.rb +282 -0
  328. data/lib/nucleus_api/models/allocation_composition_model_holdings_vo.rb +311 -0
  329. data/lib/nucleus_api/models/allocation_node_map.rb +187 -0
  330. data/lib/nucleus_api/models/answer.rb +286 -0
  331. data/lib/nucleus_api/models/answer_map.rb +181 -0
  332. data/lib/nucleus_api/models/application.rb +256 -0
  333. data/lib/nucleus_api/models/audit_log.rb +357 -0
  334. data/lib/nucleus_api/models/available_date_double_vo.rb +243 -0
  335. data/lib/nucleus_api/models/bank_credit.rb +262 -0
  336. data/lib/nucleus_api/models/bank_link.rb +410 -0
  337. data/lib/nucleus_api/models/bank_link_map.rb +202 -0
  338. data/lib/nucleus_api/models/benchmark.rb +277 -0
  339. data/lib/nucleus_api/models/benchmark_composition.rb +202 -0
  340. data/lib/nucleus_api/models/brokers.rb +203 -0
  341. data/lib/nucleus_api/models/budget.rb +372 -0
  342. data/lib/nucleus_api/models/budget_aggregation_account.rb +187 -0
  343. data/lib/nucleus_api/models/budget_object.rb +213 -0
  344. data/lib/nucleus_api/models/bulk_transaction.rb +226 -0
  345. data/lib/nucleus_api/models/bulk_transaction_vo.rb +217 -0
  346. data/lib/nucleus_api/models/business.rb +430 -0
  347. data/lib/nucleus_api/models/business_address.rb +278 -0
  348. data/lib/nucleus_api/models/card.rb +489 -0
  349. data/lib/nucleus_api/models/card_address.rb +268 -0
  350. data/lib/nucleus_api/models/card_program.rb +350 -0
  351. data/lib/nucleus_api/models/cash.rb +213 -0
  352. data/lib/nucleus_api/models/categories_map.rb +202 -0
  353. data/lib/nucleus_api/models/category_internal_response_vo.rb +201 -0
  354. data/lib/nucleus_api/models/category_response_vo.rb +192 -0
  355. data/lib/nucleus_api/models/check.rb +210 -0
  356. data/lib/nucleus_api/models/check_images.rb +198 -0
  357. data/lib/nucleus_api/models/client.rb +523 -0
  358. data/lib/nucleus_api/models/client_account_mapping.rb +212 -0
  359. data/lib/nucleus_api/models/client_address.rb +278 -0
  360. data/lib/nucleus_api/models/client_relationship.rb +209 -0
  361. data/lib/nucleus_api/models/client_response.rb +280 -0
  362. data/lib/nucleus_api/models/client_status.rb +275 -0
  363. data/lib/nucleus_api/models/client_view_goal_data.rb +302 -0
  364. data/lib/nucleus_api/models/country.rb +233 -0
  365. data/lib/nucleus_api/models/currency.rb +212 -0
  366. data/lib/nucleus_api/models/customer.rb +317 -0
  367. data/lib/nucleus_api/models/customer_address.rb +268 -0
  368. data/lib/nucleus_api/models/customer_revenue.rb +284 -0
  369. data/lib/nucleus_api/models/daily_deposit.rb +395 -0
  370. data/lib/nucleus_api/models/daily_withdrawal.rb +405 -0
  371. data/lib/nucleus_api/models/date_double_vo.rb +203 -0
  372. data/lib/nucleus_api/models/decision_tree.rb +275 -0
  373. data/lib/nucleus_api/models/decision_tree_co.rb +202 -0
  374. data/lib/nucleus_api/models/decision_tree_result_vo.rb +192 -0
  375. data/lib/nucleus_api/models/document.rb +409 -0
  376. data/lib/nucleus_api/models/employment.rb +213 -0
  377. data/lib/nucleus_api/models/external_account_transfer.rb +412 -0
  378. data/lib/nucleus_api/models/feature.rb +286 -0
  379. data/lib/nucleus_api/models/feature_track.rb +251 -0
  380. data/lib/nucleus_api/models/financial_statement.rb +352 -0
  381. data/lib/nucleus_api/models/funding.rb +496 -0
  382. data/lib/nucleus_api/models/funding_request_map.rb +187 -0
  383. data/lib/nucleus_api/models/fx_rate_view.rb +233 -0
  384. data/lib/nucleus_api/models/goal.rb +340 -0
  385. data/lib/nucleus_api/models/goal_account_mapping.rb +218 -0
  386. data/lib/nucleus_api/models/goal_track.rb +372 -0
  387. data/lib/nucleus_api/models/goal_track_accounts.rb +187 -0
  388. data/lib/nucleus_api/models/household.rb +285 -0
  389. data/lib/nucleus_api/models/investment.rb +283 -0
  390. data/lib/nucleus_api/models/invoice.rb +452 -0
  391. data/lib/nucleus_api/models/invoice_payment.rb +269 -0
  392. data/lib/nucleus_api/models/json_node.rb +404 -0
  393. data/lib/nucleus_api/models/line_items.rb +278 -0
  394. data/lib/nucleus_api/models/location.rb +253 -0
  395. data/lib/nucleus_api/models/member.rb +217 -0
  396. data/lib/nucleus_api/models/merchant_category_code.rb +213 -0
  397. data/lib/nucleus_api/models/merchants_map.rb +202 -0
  398. data/lib/nucleus_api/models/model.rb +396 -0
  399. data/lib/nucleus_api/models/model_asset_size.rb +274 -0
  400. data/lib/nucleus_api/models/model_comment.rb +264 -0
  401. data/lib/nucleus_api/models/model_holding.rb +370 -0
  402. data/lib/nucleus_api/models/model_holding_vo.rb +208 -0
  403. data/lib/nucleus_api/models/model_transaction.rb +298 -0
  404. data/lib/nucleus_api/models/mx_merchant_res.rb +235 -0
  405. data/lib/nucleus_api/models/node.rb +260 -0
  406. data/lib/nucleus_api/models/node_relationship.rb +300 -0
  407. data/lib/nucleus_api/models/notification.rb +313 -0
  408. data/lib/nucleus_api/models/notification_client.rb +309 -0
  409. data/lib/nucleus_api/models/notification_setting.rb +300 -0
  410. data/lib/nucleus_api/models/order.rb +390 -0
  411. data/lib/nucleus_api/models/order_bulk.rb +309 -0
  412. data/lib/nucleus_api/models/order_reconcile_request.rb +220 -0
  413. data/lib/nucleus_api/models/order_reconcile_return_object.rb +227 -0
  414. data/lib/nucleus_api/models/order_status.rb +250 -0
  415. data/lib/nucleus_api/models/order_track.rb +316 -0
  416. data/lib/nucleus_api/models/order_vo_clone.rb +304 -0
  417. data/lib/nucleus_api/models/overflow.rb +281 -0
  418. data/lib/nucleus_api/models/overflow_bank_link_map.rb +202 -0
  419. data/lib/nucleus_api/models/overflow_settings.rb +287 -0
  420. data/lib/nucleus_api/models/overflow_vo.rb +203 -0
  421. data/lib/nucleus_api/models/ownership.rb +233 -0
  422. data/lib/nucleus_api/models/page_account.rb +258 -0
  423. data/lib/nucleus_api/models/page_account_allocation_mapping.rb +258 -0
  424. data/lib/nucleus_api/models/page_account_permission_vo.rb +258 -0
  425. data/lib/nucleus_api/models/page_account_status.rb +258 -0
  426. data/lib/nucleus_api/models/page_account_type.rb +258 -0
  427. data/lib/nucleus_api/models/page_admin_client.rb +258 -0
  428. data/lib/nucleus_api/models/page_aggregation_account.rb +258 -0
  429. data/lib/nucleus_api/models/page_aggregation_account_balance.rb +258 -0
  430. data/lib/nucleus_api/models/page_aggregation_account_holding.rb +258 -0
  431. data/lib/nucleus_api/models/page_aggregation_account_transaction.rb +258 -0
  432. data/lib/nucleus_api/models/page_allocation.rb +258 -0
  433. data/lib/nucleus_api/models/page_allocation_composition.rb +258 -0
  434. data/lib/nucleus_api/models/page_answer.rb +258 -0
  435. data/lib/nucleus_api/models/page_application.rb +258 -0
  436. data/lib/nucleus_api/models/page_audit_log.rb +258 -0
  437. data/lib/nucleus_api/models/page_bank_link.rb +258 -0
  438. data/lib/nucleus_api/models/page_benchmark.rb +258 -0
  439. data/lib/nucleus_api/models/page_budget.rb +258 -0
  440. data/lib/nucleus_api/models/page_business.rb +258 -0
  441. data/lib/nucleus_api/models/page_card.rb +258 -0
  442. data/lib/nucleus_api/models/page_card_program.rb +258 -0
  443. data/lib/nucleus_api/models/page_client.rb +258 -0
  444. data/lib/nucleus_api/models/page_client_response.rb +258 -0
  445. data/lib/nucleus_api/models/page_client_status.rb +258 -0
  446. data/lib/nucleus_api/models/page_customer.rb +258 -0
  447. data/lib/nucleus_api/models/page_customer_revenue.rb +258 -0
  448. data/lib/nucleus_api/models/page_daily_deposit.rb +258 -0
  449. data/lib/nucleus_api/models/page_daily_withdrawal.rb +258 -0
  450. data/lib/nucleus_api/models/page_decision_tree.rb +258 -0
  451. data/lib/nucleus_api/models/page_document.rb +258 -0
  452. data/lib/nucleus_api/models/page_external_account_transfer.rb +258 -0
  453. data/lib/nucleus_api/models/page_feature.rb +258 -0
  454. data/lib/nucleus_api/models/page_feature_track.rb +258 -0
  455. data/lib/nucleus_api/models/page_financial_statement.rb +258 -0
  456. data/lib/nucleus_api/models/page_funding.rb +258 -0
  457. data/lib/nucleus_api/models/page_goal.rb +258 -0
  458. data/lib/nucleus_api/models/page_goal_track.rb +258 -0
  459. data/lib/nucleus_api/models/page_household.rb +258 -0
  460. data/lib/nucleus_api/models/page_invoice.rb +258 -0
  461. data/lib/nucleus_api/models/page_invoice_payment.rb +258 -0
  462. data/lib/nucleus_api/models/page_model.rb +258 -0
  463. data/lib/nucleus_api/models/page_model_asset_size.rb +258 -0
  464. data/lib/nucleus_api/models/page_model_comment.rb +258 -0
  465. data/lib/nucleus_api/models/page_model_holding.rb +258 -0
  466. data/lib/nucleus_api/models/page_model_transaction.rb +258 -0
  467. data/lib/nucleus_api/models/page_mx_merchant_res.rb +255 -0
  468. data/lib/nucleus_api/models/page_node.rb +258 -0
  469. data/lib/nucleus_api/models/page_node_relationship.rb +258 -0
  470. data/lib/nucleus_api/models/page_notification.rb +258 -0
  471. data/lib/nucleus_api/models/page_notification_client.rb +258 -0
  472. data/lib/nucleus_api/models/page_notification_setting.rb +258 -0
  473. data/lib/nucleus_api/models/page_order.rb +258 -0
  474. data/lib/nucleus_api/models/page_order_bulk.rb +258 -0
  475. data/lib/nucleus_api/models/page_order_status.rb +258 -0
  476. data/lib/nucleus_api/models/page_order_track.rb +258 -0
  477. data/lib/nucleus_api/models/page_overflow.rb +258 -0
  478. data/lib/nucleus_api/models/page_overflow_settings.rb +258 -0
  479. data/lib/nucleus_api/models/page_portfolio.rb +258 -0
  480. data/lib/nucleus_api/models/page_portfolio_asset_size_log.rb +258 -0
  481. data/lib/nucleus_api/models/page_portfolio_comment.rb +258 -0
  482. data/lib/nucleus_api/models/page_portfolio_goal.rb +258 -0
  483. data/lib/nucleus_api/models/page_portfolio_holding_log.rb +258 -0
  484. data/lib/nucleus_api/models/page_portfolio_transaction.rb +258 -0
  485. data/lib/nucleus_api/models/page_question.rb +258 -0
  486. data/lib/nucleus_api/models/page_questionnaire.rb +258 -0
  487. data/lib/nucleus_api/models/page_reason_code.rb +258 -0
  488. data/lib/nucleus_api/models/page_risk_profile.rb +258 -0
  489. data/lib/nucleus_api/models/page_roundup.rb +258 -0
  490. data/lib/nucleus_api/models/page_roundup_settings.rb +258 -0
  491. data/lib/nucleus_api/models/page_score.rb +258 -0
  492. data/lib/nucleus_api/models/page_security.rb +258 -0
  493. data/lib/nucleus_api/models/page_security_exclusion.rb +258 -0
  494. data/lib/nucleus_api/models/page_security_price.rb +258 -0
  495. data/lib/nucleus_api/models/page_spending_control.rb +258 -0
  496. data/lib/nucleus_api/models/page_stage.rb +258 -0
  497. data/lib/nucleus_api/models/page_transaction_code.rb +258 -0
  498. data/lib/nucleus_api/models/page_v_account_asset_size.rb +258 -0
  499. data/lib/nucleus_api/models/page_webhook.rb +258 -0
  500. data/lib/nucleus_api/models/permission_vo.rb +226 -0
  501. data/lib/nucleus_api/models/portfolio.rb +341 -0
  502. data/lib/nucleus_api/models/portfolio_asset_size_log.rb +329 -0
  503. data/lib/nucleus_api/models/portfolio_comment.rb +279 -0
  504. data/lib/nucleus_api/models/portfolio_goal.rb +255 -0
  505. data/lib/nucleus_api/models/portfolio_goal_map.rb +202 -0
  506. data/lib/nucleus_api/models/portfolio_holding_agg.rb +243 -0
  507. data/lib/nucleus_api/models/portfolio_holding_log.rb +339 -0
  508. data/lib/nucleus_api/models/portfolio_transaction.rb +495 -0
  509. data/lib/nucleus_api/models/question.rb +334 -0
  510. data/lib/nucleus_api/models/questionnaire.rb +275 -0
  511. data/lib/nucleus_api/models/reason_code.rb +274 -0
  512. data/lib/nucleus_api/models/risk_profile.rb +286 -0
  513. data/lib/nucleus_api/models/roundup.rb +266 -0
  514. data/lib/nucleus_api/models/roundup_co.rb +232 -0
  515. data/lib/nucleus_api/models/roundup_settings.rb +331 -0
  516. data/lib/nucleus_api/models/score.rb +374 -0
  517. data/lib/nucleus_api/models/securities_composition.rb +232 -0
  518. data/lib/nucleus_api/models/securities_country.rb +202 -0
  519. data/lib/nucleus_api/models/security.rb +434 -0
  520. data/lib/nucleus_api/models/security_composition_vo.rb +300 -0
  521. data/lib/nucleus_api/models/security_country_vo.rb +190 -0
  522. data/lib/nucleus_api/models/security_exclusion.rb +300 -0
  523. data/lib/nucleus_api/models/security_price.rb +313 -0
  524. data/lib/nucleus_api/models/sort.rb +233 -0
  525. data/lib/nucleus_api/models/spending_control.rb +331 -0
  526. data/lib/nucleus_api/models/stage.rb +325 -0
  527. data/lib/nucleus_api/models/stat.rb +203 -0
  528. data/lib/nucleus_api/models/state.rb +202 -0
  529. data/lib/nucleus_api/models/statistic_resource_vo.rb +208 -0
  530. data/lib/nucleus_api/models/token_date_request.rb +233 -0
  531. data/lib/nucleus_api/models/transaction_code.rb +362 -0
  532. data/lib/nucleus_api/models/v_account_asset_size.rb +212 -0
  533. data/lib/nucleus_api/models/v_account_vo.rb +226 -0
  534. data/lib/nucleus_api/models/v_client_goal_view_data.rb +228 -0
  535. data/lib/nucleus_api/models/v_portfolio_vo.rb +208 -0
  536. data/lib/nucleus_api/models/webhook.rb +280 -0
  537. data/lib/nucleus_api/version.rb +15 -0
  538. data/nucleus_api.gemspec +46 -0
  539. data/spec/api/account_api_spec.rb +455 -0
  540. data/spec/api/admin_client_api_spec.rb +100 -0
  541. data/spec/api/aggregation_account_api_spec.rb +399 -0
  542. data/spec/api/allocation_api_spec.rb +225 -0
  543. data/spec/api/application_api_spec.rb +100 -0
  544. data/spec/api/audit_log_api_spec.rb +75 -0
  545. data/spec/api/benchmark_api_spec.rb +115 -0
  546. data/spec/api/budget_api_spec.rb +102 -0
  547. data/spec/api/bulk_api_spec.rb +86 -0
  548. data/spec/api/business_api_spec.rb +153 -0
  549. data/spec/api/card_api_spec.rb +201 -0
  550. data/spec/api/client_api_spec.rb +256 -0
  551. data/spec/api/customer_api_spec.rb +167 -0
  552. data/spec/api/decision_tree_api_spec.rb +242 -0
  553. data/spec/api/document_api_spec.rb +100 -0
  554. data/spec/api/feature_api_spec.rb +165 -0
  555. data/spec/api/financial_statement_api_spec.rb +102 -0
  556. data/spec/api/funding_api_spec.rb +382 -0
  557. data/spec/api/goal_api_spec.rb +225 -0
  558. data/spec/api/household_api_spec.rb +153 -0
  559. data/spec/api/invoice_api_spec.rb +169 -0
  560. data/spec/api/model_api_spec.rb +375 -0
  561. data/spec/api/notification_api_spec.rb +230 -0
  562. data/spec/api/order_api_spec.rb +412 -0
  563. data/spec/api/overflow_api_spec.rb +140 -0
  564. data/spec/api/performance_api_spec.rb +355 -0
  565. data/spec/api/portfolio_api_spec.rb +448 -0
  566. data/spec/api/questionnaire_api_spec.rb +295 -0
  567. data/spec/api/resource_api_spec.rb +148 -0
  568. data/spec/api/risk_profile_api_spec.rb +100 -0
  569. data/spec/api/roundup_api_spec.rb +140 -0
  570. data/spec/api/score_api_spec.rb +100 -0
  571. data/spec/api/securities_api_spec.rb +232 -0
  572. data/spec/api/spending_control_api_spec.rb +100 -0
  573. data/spec/api/utils_api_spec.rb +230 -0
  574. data/spec/api/webhook_api_spec.rb +100 -0
  575. data/spec/api_client_spec.rb +243 -0
  576. data/spec/configuration_spec.rb +42 -0
  577. data/spec/models/account_allocation_mapping_spec.rb +95 -0
  578. data/spec/models/account_map_spec.rb +47 -0
  579. data/spec/models/account_permission_vo_spec.rb +47 -0
  580. data/spec/models/account_portfolio_rebalance_request_spec.rb +119 -0
  581. data/spec/models/account_spec.rb +125 -0
  582. data/spec/models/account_status_spec.rb +89 -0
  583. data/spec/models/account_type_spec.rb +131 -0
  584. data/spec/models/acl_client_permission_vo_spec.rb +57 -0
  585. data/spec/models/admin_client_spec.rb +101 -0
  586. data/spec/models/aggregation_account_balance_spec.rb +101 -0
  587. data/spec/models/aggregation_account_holding_spec.rb +149 -0
  588. data/spec/models/aggregation_account_spec.rb +173 -0
  589. data/spec/models/aggregation_account_transaction_spec.rb +139 -0
  590. data/spec/models/aggregation_accounts_map_spec.rb +47 -0
  591. data/spec/models/allocation_aggregated_vo_spec.rb +71 -0
  592. data/spec/models/allocation_composition_aggregated_vo_spec.rb +107 -0
  593. data/spec/models/allocation_composition_model_holdings_vo_spec.rb +125 -0
  594. data/spec/models/allocation_composition_spec.rb +101 -0
  595. data/spec/models/allocation_node_map_spec.rb +41 -0
  596. data/spec/models/allocation_spec.rb +125 -0
  597. data/spec/models/answer_map_spec.rb +41 -0
  598. data/spec/models/answer_spec.rb +101 -0
  599. data/spec/models/application_spec.rb +83 -0
  600. data/spec/models/audit_log_spec.rb +131 -0
  601. data/spec/models/available_date_double_vo_spec.rb +77 -0
  602. data/spec/models/bank_credit_spec.rb +83 -0
  603. data/spec/models/bank_link_map_spec.rb +47 -0
  604. data/spec/models/bank_link_spec.rb +167 -0
  605. data/spec/models/benchmark_composition_spec.rb +47 -0
  606. data/spec/models/benchmark_spec.rb +95 -0
  607. data/spec/models/brokers_spec.rb +47 -0
  608. data/spec/models/budget_aggregation_account_spec.rb +41 -0
  609. data/spec/models/budget_object_spec.rb +53 -0
  610. data/spec/models/budget_spec.rb +143 -0
  611. data/spec/models/bulk_transaction_spec.rb +71 -0
  612. data/spec/models/bulk_transaction_vo_spec.rb +65 -0
  613. data/spec/models/business_address_spec.rb +83 -0
  614. data/spec/models/business_spec.rb +185 -0
  615. data/spec/models/card_address_spec.rb +77 -0
  616. data/spec/models/card_program_spec.rb +131 -0
  617. data/spec/models/card_spec.rb +202 -0
  618. data/spec/models/cash_spec.rb +53 -0
  619. data/spec/models/categories_map_spec.rb +47 -0
  620. data/spec/models/category_internal_response_vo_spec.rb +53 -0
  621. data/spec/models/category_response_vo_spec.rb +47 -0
  622. data/spec/models/check_images_spec.rb +47 -0
  623. data/spec/models/check_spec.rb +53 -0
  624. data/spec/models/client_account_mapping_spec.rb +53 -0
  625. data/spec/models/client_address_spec.rb +83 -0
  626. data/spec/models/client_relationship_spec.rb +53 -0
  627. data/spec/models/client_response_spec.rb +95 -0
  628. data/spec/models/client_spec.rb +239 -0
  629. data/spec/models/client_status_spec.rb +89 -0
  630. data/spec/models/client_view_goal_data_spec.rb +119 -0
  631. data/spec/models/country_spec.rb +65 -0
  632. data/spec/models/currency_spec.rb +59 -0
  633. data/spec/models/customer_address_spec.rb +77 -0
  634. data/spec/models/customer_revenue_spec.rb +89 -0
  635. data/spec/models/customer_spec.rb +119 -0
  636. data/spec/models/daily_deposit_spec.rb +161 -0
  637. data/spec/models/daily_withdrawal_spec.rb +167 -0
  638. data/spec/models/date_double_vo_spec.rb +53 -0
  639. data/spec/models/decision_tree_co_spec.rb +47 -0
  640. data/spec/models/decision_tree_result_vo_spec.rb +47 -0
  641. data/spec/models/decision_tree_spec.rb +95 -0
  642. data/spec/models/document_spec.rb +173 -0
  643. data/spec/models/employment_spec.rb +59 -0
  644. data/spec/models/external_account_transfer_spec.rb +161 -0
  645. data/spec/models/feature_spec.rb +101 -0
  646. data/spec/models/feature_track_spec.rb +77 -0
  647. data/spec/models/financial_statement_spec.rb +131 -0
  648. data/spec/models/funding_request_map_spec.rb +41 -0
  649. data/spec/models/funding_spec.rb +215 -0
  650. data/spec/models/fx_rate_view_spec.rb +59 -0
  651. data/spec/models/goal_account_mapping_spec.rb +59 -0
  652. data/spec/models/goal_spec.rb +137 -0
  653. data/spec/models/goal_track_accounts_spec.rb +41 -0
  654. data/spec/models/goal_track_spec.rb +149 -0
  655. data/spec/models/household_spec.rb +101 -0
  656. data/spec/models/investment_spec.rb +89 -0
  657. data/spec/models/invoice_payment_spec.rb +83 -0
  658. data/spec/models/invoice_spec.rb +185 -0
  659. data/spec/models/json_node_spec.rb +171 -0
  660. data/spec/models/line_items_spec.rb +83 -0
  661. data/spec/models/location_spec.rb +83 -0
  662. data/spec/models/member_spec.rb +59 -0
  663. data/spec/models/merchant_category_code_spec.rb +59 -0
  664. data/spec/models/merchants_map_spec.rb +47 -0
  665. data/spec/models/model_asset_size_spec.rb +89 -0
  666. data/spec/models/model_comment_spec.rb +83 -0
  667. data/spec/models/model_holding_spec.rb +143 -0
  668. data/spec/models/model_holding_vo_spec.rb +59 -0
  669. data/spec/models/model_spec.rb +167 -0
  670. data/spec/models/model_transaction_spec.rb +95 -0
  671. data/spec/models/mx_merchant_res_spec.rb +77 -0
  672. data/spec/models/node_relationship_spec.rb +101 -0
  673. data/spec/models/node_spec.rb +83 -0
  674. data/spec/models/notification_client_spec.rb +107 -0
  675. data/spec/models/notification_setting_spec.rb +107 -0
  676. data/spec/models/notification_spec.rb +113 -0
  677. data/spec/models/order_bulk_spec.rb +101 -0
  678. data/spec/models/order_reconcile_request_spec.rb +65 -0
  679. data/spec/models/order_reconcile_return_object_spec.rb +65 -0
  680. data/spec/models/order_spec.rb +155 -0
  681. data/spec/models/order_status_spec.rb +77 -0
  682. data/spec/models/order_track_spec.rb +113 -0
  683. data/spec/models/order_vo_clone_spec.rb +113 -0
  684. data/spec/models/overflow_bank_link_map_spec.rb +47 -0
  685. data/spec/models/overflow_settings_spec.rb +95 -0
  686. data/spec/models/overflow_spec.rb +89 -0
  687. data/spec/models/overflow_vo_spec.rb +53 -0
  688. data/spec/models/ownership_spec.rb +65 -0
  689. data/spec/models/page_account_allocation_mapping_spec.rb +89 -0
  690. data/spec/models/page_account_permission_vo_spec.rb +89 -0
  691. data/spec/models/page_account_spec.rb +89 -0
  692. data/spec/models/page_account_status_spec.rb +89 -0
  693. data/spec/models/page_account_type_spec.rb +89 -0
  694. data/spec/models/page_admin_client_spec.rb +89 -0
  695. data/spec/models/page_aggregation_account_balance_spec.rb +89 -0
  696. data/spec/models/page_aggregation_account_holding_spec.rb +89 -0
  697. data/spec/models/page_aggregation_account_spec.rb +89 -0
  698. data/spec/models/page_aggregation_account_transaction_spec.rb +89 -0
  699. data/spec/models/page_allocation_composition_spec.rb +89 -0
  700. data/spec/models/page_allocation_spec.rb +89 -0
  701. data/spec/models/page_answer_spec.rb +89 -0
  702. data/spec/models/page_application_spec.rb +89 -0
  703. data/spec/models/page_audit_log_spec.rb +89 -0
  704. data/spec/models/page_bank_link_spec.rb +89 -0
  705. data/spec/models/page_benchmark_spec.rb +89 -0
  706. data/spec/models/page_budget_spec.rb +89 -0
  707. data/spec/models/page_business_spec.rb +89 -0
  708. data/spec/models/page_card_program_spec.rb +89 -0
  709. data/spec/models/page_card_spec.rb +89 -0
  710. data/spec/models/page_client_response_spec.rb +89 -0
  711. data/spec/models/page_client_spec.rb +89 -0
  712. data/spec/models/page_client_status_spec.rb +89 -0
  713. data/spec/models/page_customer_revenue_spec.rb +89 -0
  714. data/spec/models/page_customer_spec.rb +89 -0
  715. data/spec/models/page_daily_deposit_spec.rb +89 -0
  716. data/spec/models/page_daily_withdrawal_spec.rb +89 -0
  717. data/spec/models/page_decision_tree_spec.rb +89 -0
  718. data/spec/models/page_document_spec.rb +89 -0
  719. data/spec/models/page_external_account_transfer_spec.rb +89 -0
  720. data/spec/models/page_feature_spec.rb +89 -0
  721. data/spec/models/page_feature_track_spec.rb +89 -0
  722. data/spec/models/page_financial_statement_spec.rb +89 -0
  723. data/spec/models/page_funding_spec.rb +89 -0
  724. data/spec/models/page_goal_spec.rb +89 -0
  725. data/spec/models/page_goal_track_spec.rb +89 -0
  726. data/spec/models/page_household_spec.rb +89 -0
  727. data/spec/models/page_invoice_payment_spec.rb +89 -0
  728. data/spec/models/page_invoice_spec.rb +89 -0
  729. data/spec/models/page_model_asset_size_spec.rb +89 -0
  730. data/spec/models/page_model_comment_spec.rb +89 -0
  731. data/spec/models/page_model_holding_spec.rb +89 -0
  732. data/spec/models/page_model_spec.rb +89 -0
  733. data/spec/models/page_model_transaction_spec.rb +89 -0
  734. data/spec/models/page_mx_merchant_res_spec.rb +89 -0
  735. data/spec/models/page_node_relationship_spec.rb +89 -0
  736. data/spec/models/page_node_spec.rb +89 -0
  737. data/spec/models/page_notification_client_spec.rb +89 -0
  738. data/spec/models/page_notification_setting_spec.rb +89 -0
  739. data/spec/models/page_notification_spec.rb +89 -0
  740. data/spec/models/page_order_bulk_spec.rb +89 -0
  741. data/spec/models/page_order_spec.rb +89 -0
  742. data/spec/models/page_order_status_spec.rb +89 -0
  743. data/spec/models/page_order_track_spec.rb +89 -0
  744. data/spec/models/page_overflow_settings_spec.rb +89 -0
  745. data/spec/models/page_overflow_spec.rb +89 -0
  746. data/spec/models/page_portfolio_asset_size_log_spec.rb +89 -0
  747. data/spec/models/page_portfolio_comment_spec.rb +89 -0
  748. data/spec/models/page_portfolio_goal_spec.rb +89 -0
  749. data/spec/models/page_portfolio_holding_log_spec.rb +89 -0
  750. data/spec/models/page_portfolio_spec.rb +89 -0
  751. data/spec/models/page_portfolio_transaction_spec.rb +89 -0
  752. data/spec/models/page_question_spec.rb +89 -0
  753. data/spec/models/page_questionnaire_spec.rb +89 -0
  754. data/spec/models/page_reason_code_spec.rb +89 -0
  755. data/spec/models/page_risk_profile_spec.rb +89 -0
  756. data/spec/models/page_roundup_settings_spec.rb +89 -0
  757. data/spec/models/page_roundup_spec.rb +89 -0
  758. data/spec/models/page_score_spec.rb +89 -0
  759. data/spec/models/page_security_exclusion_spec.rb +89 -0
  760. data/spec/models/page_security_price_spec.rb +89 -0
  761. data/spec/models/page_security_spec.rb +89 -0
  762. data/spec/models/page_spending_control_spec.rb +89 -0
  763. data/spec/models/page_stage_spec.rb +89 -0
  764. data/spec/models/page_transaction_code_spec.rb +89 -0
  765. data/spec/models/page_v_account_asset_size_spec.rb +89 -0
  766. data/spec/models/page_webhook_spec.rb +89 -0
  767. data/spec/models/permission_vo_spec.rb +51 -0
  768. data/spec/models/portfolio_asset_size_log_spec.rb +113 -0
  769. data/spec/models/portfolio_comment_spec.rb +89 -0
  770. data/spec/models/portfolio_goal_map_spec.rb +47 -0
  771. data/spec/models/portfolio_goal_spec.rb +77 -0
  772. data/spec/models/portfolio_holding_agg_spec.rb +77 -0
  773. data/spec/models/portfolio_holding_log_spec.rb +119 -0
  774. data/spec/models/portfolio_spec.rb +125 -0
  775. data/spec/models/portfolio_transaction_spec.rb +215 -0
  776. data/spec/models/question_spec.rb +131 -0
  777. data/spec/models/questionnaire_spec.rb +95 -0
  778. data/spec/models/reason_code_spec.rb +95 -0
  779. data/spec/models/risk_profile_spec.rb +101 -0
  780. data/spec/models/roundup_co_spec.rb +65 -0
  781. data/spec/models/roundup_settings_spec.rb +119 -0
  782. data/spec/models/roundup_spec.rb +83 -0
  783. data/spec/models/score_spec.rb +135 -0
  784. data/spec/models/securities_composition_spec.rb +59 -0
  785. data/spec/models/securities_country_spec.rb +47 -0
  786. data/spec/models/security_composition_vo_spec.rb +119 -0
  787. data/spec/models/security_country_vo_spec.rb +47 -0
  788. data/spec/models/security_exclusion_spec.rb +101 -0
  789. data/spec/models/security_price_spec.rb +113 -0
  790. data/spec/models/security_spec.rb +185 -0
  791. data/spec/models/sort_spec.rb +71 -0
  792. data/spec/models/spending_control_spec.rb +119 -0
  793. data/spec/models/stage_spec.rb +125 -0
  794. data/spec/models/stat_spec.rb +47 -0
  795. data/spec/models/state_spec.rb +53 -0
  796. data/spec/models/statistic_resource_vo_spec.rb +59 -0
  797. data/spec/models/token_date_request_spec.rb +71 -0
  798. data/spec/models/transaction_code_spec.rb +125 -0
  799. data/spec/models/v_account_asset_size_spec.rb +59 -0
  800. data/spec/models/v_account_vo_spec.rb +71 -0
  801. data/spec/models/v_client_goal_view_data_spec.rb +71 -0
  802. data/spec/models/v_portfolio_vo_spec.rb +59 -0
  803. data/spec/models/webhook_spec.rb +87 -0
  804. data/spec/spec_helper.rb +111 -0
  805. metadata +1312 -0
@@ -0,0 +1,1131 @@
1
+ =begin
2
+ #Hydrogen Nucleus API
3
+
4
+ #The Hydrogen Nucleus API
5
+
6
+ OpenAPI spec version: 1.8.0
7
+ Contact: info@hydrogenplatform.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.18
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+
15
+ module NucleusApi
16
+ class PerformanceApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Account Performance
23
+ # Get information on the performance of an account using IRR (Internal Rate of Return). You must provide the unique account_id.
24
+ # @param account_id Account Id -/account
25
+ # @param [Hash] opts the optional parameters
26
+ # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: 'D')
27
+ # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: 'D')
28
+ # @option opts [String] :benchmark_id Client Benchmark or Tenant Benchmark id -/benchmark
29
+ # @option opts [Date] :end_date end date
30
+ # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
31
+ # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0)
32
+ # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
33
+ # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
34
+ # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
35
+ # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
36
+ # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)
37
+ # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
38
+ # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
39
+ # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
40
+ # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000)
41
+ # @option opts [String] :period_type Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: 'D')
42
+ # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
43
+ # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0)
44
+ # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
45
+ # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0)
46
+ # @option opts [Date] :start_date start date
47
+ # @option opts [String] :stat A stat type - /statistics
48
+ # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
49
+ # @return [Object]
50
+ def get_account_performance_using_get(account_id, opts = {})
51
+ data, _status_code, _headers = get_account_performance_using_get_with_http_info(account_id, opts)
52
+ data
53
+ end
54
+
55
+ # Account Performance
56
+ # Get information on the performance of an account using IRR (Internal Rate of Return). You must provide the unique account_id.
57
+ # @param account_id Account Id -/account
58
+ # @param [Hash] opts the optional parameters
59
+ # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: 'D')
60
+ # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: 'D')
61
+ # @option opts [String] :benchmark_id Client Benchmark or Tenant Benchmark id -/benchmark
62
+ # @option opts [Date] :end_date end date
63
+ # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
64
+ # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0)
65
+ # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
66
+ # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
67
+ # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
68
+ # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
69
+ # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)
70
+ # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
71
+ # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
72
+ # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
73
+ # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000)
74
+ # @option opts [String] :period_type Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: 'D')
75
+ # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
76
+ # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0)
77
+ # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
78
+ # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0)
79
+ # @option opts [Date] :start_date start date
80
+ # @option opts [String] :stat A stat type - /statistics
81
+ # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
82
+ # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
83
+ def get_account_performance_using_get_with_http_info(account_id, opts = {})
84
+ if @api_client.config.debugging
85
+ @api_client.config.logger.debug 'Calling API: PerformanceApi.get_account_performance_using_get ...'
86
+ end
87
+ # verify the required parameter 'account_id' is set
88
+ if @api_client.config.client_side_validation && account_id.nil?
89
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling PerformanceApi.get_account_performance_using_get"
90
+ end
91
+ # resource path
92
+ local_var_path = '/account/{account_id}/performance'.sub('{' + 'account_id' + '}', account_id.to_s)
93
+
94
+ # query parameters
95
+ query_params = {}
96
+ query_params[:'active_premium_period'] = opts[:'active_premium_period'] if !opts[:'active_premium_period'].nil?
97
+ query_params[:'annualized_return_period'] = opts[:'annualized_return_period'] if !opts[:'annualized_return_period'].nil?
98
+ query_params[:'benchmark_id'] = opts[:'benchmark_id'] if !opts[:'benchmark_id'].nil?
99
+ query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
100
+ query_params[:'hist_factor'] = opts[:'hist_factor'] if !opts[:'hist_factor'].nil?
101
+ query_params[:'mar_down_side_deviation'] = opts[:'mar_down_side_deviation'] if !opts[:'mar_down_side_deviation'].nil?
102
+ query_params[:'max_percentile_monte_carlo'] = opts[:'max_percentile_monte_carlo'] if !opts[:'max_percentile_monte_carlo'].nil?
103
+ query_params[:'mean_percentile_monte_carlo'] = opts[:'mean_percentile_monte_carlo'] if !opts[:'mean_percentile_monte_carlo'].nil?
104
+ query_params[:'min_percentile_monte_carlo'] = opts[:'min_percentile_monte_carlo'] if !opts[:'min_percentile_monte_carlo'].nil?
105
+ query_params[:'moving_average_n_day'] = opts[:'moving_average_n_day'] if !opts[:'moving_average_n_day'].nil?
106
+ query_params[:'n_day_returns'] = opts[:'n_day_returns'] if !opts[:'n_day_returns'].nil?
107
+ query_params[:'n_path_monte_carlo'] = opts[:'n_path_monte_carlo'] if !opts[:'n_path_monte_carlo'].nil?
108
+ query_params[:'n_rolling_max_drawdown'] = opts[:'n_rolling_max_drawdown'] if !opts[:'n_rolling_max_drawdown'].nil?
109
+ query_params[:'n_rolling_volatility'] = opts[:'n_rolling_volatility'] if !opts[:'n_rolling_volatility'].nil?
110
+ query_params[:'num_sim_monte_carlo'] = opts[:'num_sim_monte_carlo'] if !opts[:'num_sim_monte_carlo'].nil?
111
+ query_params[:'period_type'] = opts[:'period_type'] if !opts[:'period_type'].nil?
112
+ query_params[:'risk_free_alpha'] = opts[:'risk_free_alpha'] if !opts[:'risk_free_alpha'].nil?
113
+ query_params[:'risk_free_sharpe'] = opts[:'risk_free_sharpe'] if !opts[:'risk_free_sharpe'].nil?
114
+ query_params[:'risk_free_sortino'] = opts[:'risk_free_sortino'] if !opts[:'risk_free_sortino'].nil?
115
+ query_params[:'risk_free_treynor'] = opts[:'risk_free_treynor'] if !opts[:'risk_free_treynor'].nil?
116
+ query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
117
+ query_params[:'stat'] = opts[:'stat'] if !opts[:'stat'].nil?
118
+ query_params[:'var_conf_interval'] = opts[:'var_conf_interval'] if !opts[:'var_conf_interval'].nil?
119
+
120
+ # header parameters
121
+ header_params = {}
122
+ # HTTP header 'Accept' (if needed)
123
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
124
+
125
+ # form parameters
126
+ form_params = {}
127
+
128
+ # http body (model)
129
+ post_body = nil
130
+ auth_names = ['oauth2']
131
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
132
+ :header_params => header_params,
133
+ :query_params => query_params,
134
+ :form_params => form_params,
135
+ :body => post_body,
136
+ :auth_names => auth_names,
137
+ :return_type => 'Object')
138
+ if @api_client.config.debugging
139
+ @api_client.config.logger.debug "API called: PerformanceApi#get_account_performance_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
140
+ end
141
+ return data, status_code, headers
142
+ end
143
+ # Allocation Performance
144
+ # Get information on the performance of an allocation using TWR (Time Weighted Return). You must provide the unique allocation_id.
145
+ # @param allocation_id Allocation Id -/allocation
146
+ # @param [Hash] opts the optional parameters
147
+ # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
148
+ # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
149
+ # @option opts [String] :benchmark_id Tenant Benchmark Id -/benchmark
150
+ # @option opts [Date] :end_date end date
151
+ # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
152
+ # @option opts [BOOLEAN] :is_current_weight is_current_weight (default to true)
153
+ # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0)
154
+ # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
155
+ # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
156
+ # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
157
+ # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
158
+ # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)
159
+ # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
160
+ # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
161
+ # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
162
+ # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000)
163
+ # @option opts [String] :period_type Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
164
+ # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
165
+ # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0)
166
+ # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
167
+ # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0)
168
+ # @option opts [Date] :start_date start date
169
+ # @option opts [String] :stat A stat type found under the Statistics banner
170
+ # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
171
+ # @return [Hash<String, Object>]
172
+ def get_allocation_performance_using_get(allocation_id, opts = {})
173
+ data, _status_code, _headers = get_allocation_performance_using_get_with_http_info(allocation_id, opts)
174
+ data
175
+ end
176
+
177
+ # Allocation Performance
178
+ # Get information on the performance of an allocation using TWR (Time Weighted Return). You must provide the unique allocation_id.
179
+ # @param allocation_id Allocation Id -/allocation
180
+ # @param [Hash] opts the optional parameters
181
+ # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
182
+ # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
183
+ # @option opts [String] :benchmark_id Tenant Benchmark Id -/benchmark
184
+ # @option opts [Date] :end_date end date
185
+ # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
186
+ # @option opts [BOOLEAN] :is_current_weight is_current_weight
187
+ # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0)
188
+ # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
189
+ # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
190
+ # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
191
+ # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
192
+ # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)
193
+ # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
194
+ # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
195
+ # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
196
+ # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000)
197
+ # @option opts [String] :period_type Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
198
+ # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
199
+ # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0)
200
+ # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
201
+ # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0)
202
+ # @option opts [Date] :start_date start date
203
+ # @option opts [String] :stat A stat type found under the Statistics banner
204
+ # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
205
+ # @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers
206
+ def get_allocation_performance_using_get_with_http_info(allocation_id, opts = {})
207
+ if @api_client.config.debugging
208
+ @api_client.config.logger.debug 'Calling API: PerformanceApi.get_allocation_performance_using_get ...'
209
+ end
210
+ # verify the required parameter 'allocation_id' is set
211
+ if @api_client.config.client_side_validation && allocation_id.nil?
212
+ fail ArgumentError, "Missing the required parameter 'allocation_id' when calling PerformanceApi.get_allocation_performance_using_get"
213
+ end
214
+ # resource path
215
+ local_var_path = '/allocation/{allocation_id}/performance'.sub('{' + 'allocation_id' + '}', allocation_id.to_s)
216
+
217
+ # query parameters
218
+ query_params = {}
219
+ query_params[:'active_premium_period'] = opts[:'active_premium_period'] if !opts[:'active_premium_period'].nil?
220
+ query_params[:'annualized_return_period'] = opts[:'annualized_return_period'] if !opts[:'annualized_return_period'].nil?
221
+ query_params[:'benchmark_id'] = opts[:'benchmark_id'] if !opts[:'benchmark_id'].nil?
222
+ query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
223
+ query_params[:'hist_factor'] = opts[:'hist_factor'] if !opts[:'hist_factor'].nil?
224
+ query_params[:'is_current_weight'] = opts[:'is_current_weight'] if !opts[:'is_current_weight'].nil?
225
+ query_params[:'mar_down_side_deviation'] = opts[:'mar_down_side_deviation'] if !opts[:'mar_down_side_deviation'].nil?
226
+ query_params[:'max_percentile_monte_carlo'] = opts[:'max_percentile_monte_carlo'] if !opts[:'max_percentile_monte_carlo'].nil?
227
+ query_params[:'mean_percentile_monte_carlo'] = opts[:'mean_percentile_monte_carlo'] if !opts[:'mean_percentile_monte_carlo'].nil?
228
+ query_params[:'min_percentile_monte_carlo'] = opts[:'min_percentile_monte_carlo'] if !opts[:'min_percentile_monte_carlo'].nil?
229
+ query_params[:'moving_average_n_day'] = opts[:'moving_average_n_day'] if !opts[:'moving_average_n_day'].nil?
230
+ query_params[:'n_day_returns'] = opts[:'n_day_returns'] if !opts[:'n_day_returns'].nil?
231
+ query_params[:'n_path_monte_carlo'] = opts[:'n_path_monte_carlo'] if !opts[:'n_path_monte_carlo'].nil?
232
+ query_params[:'n_rolling_max_drawdown'] = opts[:'n_rolling_max_drawdown'] if !opts[:'n_rolling_max_drawdown'].nil?
233
+ query_params[:'n_rolling_volatility'] = opts[:'n_rolling_volatility'] if !opts[:'n_rolling_volatility'].nil?
234
+ query_params[:'num_sim_monte_carlo'] = opts[:'num_sim_monte_carlo'] if !opts[:'num_sim_monte_carlo'].nil?
235
+ query_params[:'period_type'] = opts[:'period_type'] if !opts[:'period_type'].nil?
236
+ query_params[:'risk_free_alpha'] = opts[:'risk_free_alpha'] if !opts[:'risk_free_alpha'].nil?
237
+ query_params[:'risk_free_sharpe'] = opts[:'risk_free_sharpe'] if !opts[:'risk_free_sharpe'].nil?
238
+ query_params[:'risk_free_sortino'] = opts[:'risk_free_sortino'] if !opts[:'risk_free_sortino'].nil?
239
+ query_params[:'risk_free_treynor'] = opts[:'risk_free_treynor'] if !opts[:'risk_free_treynor'].nil?
240
+ query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
241
+ query_params[:'stat'] = opts[:'stat'] if !opts[:'stat'].nil?
242
+ query_params[:'var_conf_interval'] = opts[:'var_conf_interval'] if !opts[:'var_conf_interval'].nil?
243
+
244
+ # header parameters
245
+ header_params = {}
246
+ # HTTP header 'Accept' (if needed)
247
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
248
+
249
+ # form parameters
250
+ form_params = {}
251
+
252
+ # http body (model)
253
+ post_body = nil
254
+ auth_names = ['oauth2']
255
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
256
+ :header_params => header_params,
257
+ :query_params => query_params,
258
+ :form_params => form_params,
259
+ :body => post_body,
260
+ :auth_names => auth_names,
261
+ :return_type => 'Hash<String, Object>')
262
+ if @api_client.config.debugging
263
+ @api_client.config.logger.debug "API called: PerformanceApi#get_allocation_performance_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
264
+ end
265
+ return data, status_code, headers
266
+ end
267
+ # Benchmark Performance
268
+ # Get information on the performance of a benchmark using TWR (Time Weighted Return). You must provide the unique benchmark_id.
269
+ # @param benchmark_id Benchmark Id - /benchmark
270
+ # @param [Hash] opts the optional parameters
271
+ # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
272
+ # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
273
+ # @option opts [String] :comparison_benchmark_id comparison_benchmark_id
274
+ # @option opts [Date] :end_date end date
275
+ # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
276
+ # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0)
277
+ # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
278
+ # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
279
+ # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
280
+ # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
281
+ # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)
282
+ # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
283
+ # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
284
+ # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
285
+ # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000)
286
+ # @option opts [String] :period_type Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
287
+ # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
288
+ # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0)
289
+ # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
290
+ # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0)
291
+ # @option opts [Date] :start_date start date
292
+ # @option opts [String] :stat Stat type - /statistics endpoint
293
+ # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
294
+ # @return [Object]
295
+ def get_benchmark_performance_using_get(benchmark_id, opts = {})
296
+ data, _status_code, _headers = get_benchmark_performance_using_get_with_http_info(benchmark_id, opts)
297
+ data
298
+ end
299
+
300
+ # Benchmark Performance
301
+ # Get information on the performance of a benchmark using TWR (Time Weighted Return). You must provide the unique benchmark_id.
302
+ # @param benchmark_id Benchmark Id - /benchmark
303
+ # @param [Hash] opts the optional parameters
304
+ # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
305
+ # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
306
+ # @option opts [String] :comparison_benchmark_id comparison_benchmark_id
307
+ # @option opts [Date] :end_date end date
308
+ # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
309
+ # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0)
310
+ # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
311
+ # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
312
+ # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
313
+ # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
314
+ # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)
315
+ # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
316
+ # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
317
+ # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
318
+ # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000)
319
+ # @option opts [String] :period_type Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
320
+ # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
321
+ # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0)
322
+ # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
323
+ # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0)
324
+ # @option opts [Date] :start_date start date
325
+ # @option opts [String] :stat Stat type - /statistics endpoint
326
+ # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
327
+ # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
328
+ def get_benchmark_performance_using_get_with_http_info(benchmark_id, opts = {})
329
+ if @api_client.config.debugging
330
+ @api_client.config.logger.debug 'Calling API: PerformanceApi.get_benchmark_performance_using_get ...'
331
+ end
332
+ # verify the required parameter 'benchmark_id' is set
333
+ if @api_client.config.client_side_validation && benchmark_id.nil?
334
+ fail ArgumentError, "Missing the required parameter 'benchmark_id' when calling PerformanceApi.get_benchmark_performance_using_get"
335
+ end
336
+ # resource path
337
+ local_var_path = '/benchmark/{benchmark_id}/performance'.sub('{' + 'benchmark_id' + '}', benchmark_id.to_s)
338
+
339
+ # query parameters
340
+ query_params = {}
341
+ query_params[:'active_premium_period'] = opts[:'active_premium_period'] if !opts[:'active_premium_period'].nil?
342
+ query_params[:'annualized_return_period'] = opts[:'annualized_return_period'] if !opts[:'annualized_return_period'].nil?
343
+ query_params[:'comparison_benchmark_id'] = opts[:'comparison_benchmark_id'] if !opts[:'comparison_benchmark_id'].nil?
344
+ query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
345
+ query_params[:'hist_factor'] = opts[:'hist_factor'] if !opts[:'hist_factor'].nil?
346
+ query_params[:'mar_down_side_deviation'] = opts[:'mar_down_side_deviation'] if !opts[:'mar_down_side_deviation'].nil?
347
+ query_params[:'max_percentile_monte_carlo'] = opts[:'max_percentile_monte_carlo'] if !opts[:'max_percentile_monte_carlo'].nil?
348
+ query_params[:'mean_percentile_monte_carlo'] = opts[:'mean_percentile_monte_carlo'] if !opts[:'mean_percentile_monte_carlo'].nil?
349
+ query_params[:'min_percentile_monte_carlo'] = opts[:'min_percentile_monte_carlo'] if !opts[:'min_percentile_monte_carlo'].nil?
350
+ query_params[:'moving_average_n_day'] = opts[:'moving_average_n_day'] if !opts[:'moving_average_n_day'].nil?
351
+ query_params[:'n_day_returns'] = opts[:'n_day_returns'] if !opts[:'n_day_returns'].nil?
352
+ query_params[:'n_path_monte_carlo'] = opts[:'n_path_monte_carlo'] if !opts[:'n_path_monte_carlo'].nil?
353
+ query_params[:'n_rolling_max_drawdown'] = opts[:'n_rolling_max_drawdown'] if !opts[:'n_rolling_max_drawdown'].nil?
354
+ query_params[:'n_rolling_volatility'] = opts[:'n_rolling_volatility'] if !opts[:'n_rolling_volatility'].nil?
355
+ query_params[:'num_sim_monte_carlo'] = opts[:'num_sim_monte_carlo'] if !opts[:'num_sim_monte_carlo'].nil?
356
+ query_params[:'period_type'] = opts[:'period_type'] if !opts[:'period_type'].nil?
357
+ query_params[:'risk_free_alpha'] = opts[:'risk_free_alpha'] if !opts[:'risk_free_alpha'].nil?
358
+ query_params[:'risk_free_sharpe'] = opts[:'risk_free_sharpe'] if !opts[:'risk_free_sharpe'].nil?
359
+ query_params[:'risk_free_sortino'] = opts[:'risk_free_sortino'] if !opts[:'risk_free_sortino'].nil?
360
+ query_params[:'risk_free_treynor'] = opts[:'risk_free_treynor'] if !opts[:'risk_free_treynor'].nil?
361
+ query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
362
+ query_params[:'stat'] = opts[:'stat'] if !opts[:'stat'].nil?
363
+ query_params[:'var_conf_interval'] = opts[:'var_conf_interval'] if !opts[:'var_conf_interval'].nil?
364
+
365
+ # header parameters
366
+ header_params = {}
367
+ # HTTP header 'Accept' (if needed)
368
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
369
+
370
+ # form parameters
371
+ form_params = {}
372
+
373
+ # http body (model)
374
+ post_body = nil
375
+ auth_names = ['oauth2']
376
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
377
+ :header_params => header_params,
378
+ :query_params => query_params,
379
+ :form_params => form_params,
380
+ :body => post_body,
381
+ :auth_names => auth_names,
382
+ :return_type => 'Object')
383
+ if @api_client.config.debugging
384
+ @api_client.config.logger.debug "API called: PerformanceApi#get_benchmark_performance_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
385
+ end
386
+ return data, status_code, headers
387
+ end
388
+ # Client Performance
389
+ # Get information on the performance of a client using IRR (Internal Rate of Return). You must provide the unique client_id.
390
+ # @param client_id Client Id -/client
391
+ # @param [Hash] opts the optional parameters
392
+ # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
393
+ # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
394
+ # @option opts [String] :benchmark_id Client Benchmark or Tenant Benchmark id -/benchmark
395
+ # @option opts [Date] :end_date end date
396
+ # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
397
+ # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0)
398
+ # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
399
+ # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
400
+ # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
401
+ # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
402
+ # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)
403
+ # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
404
+ # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
405
+ # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
406
+ # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000)
407
+ # @option opts [String] :period_type Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
408
+ # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
409
+ # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0)
410
+ # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
411
+ # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0)
412
+ # @option opts [Date] :start_date start date
413
+ # @option opts [String] :stat A stat type -- /statistics
414
+ # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
415
+ # @return [Object]
416
+ def get_client_performance_using_get(client_id, opts = {})
417
+ data, _status_code, _headers = get_client_performance_using_get_with_http_info(client_id, opts)
418
+ data
419
+ end
420
+
421
+ # Client Performance
422
+ # Get information on the performance of a client using IRR (Internal Rate of Return). You must provide the unique client_id.
423
+ # @param client_id Client Id -/client
424
+ # @param [Hash] opts the optional parameters
425
+ # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
426
+ # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
427
+ # @option opts [String] :benchmark_id Client Benchmark or Tenant Benchmark id -/benchmark
428
+ # @option opts [Date] :end_date end date
429
+ # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
430
+ # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0)
431
+ # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
432
+ # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
433
+ # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
434
+ # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
435
+ # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)
436
+ # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
437
+ # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
438
+ # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
439
+ # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000)
440
+ # @option opts [String] :period_type Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
441
+ # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
442
+ # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0)
443
+ # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
444
+ # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0)
445
+ # @option opts [Date] :start_date start date
446
+ # @option opts [String] :stat A stat type -- /statistics
447
+ # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
448
+ # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
449
+ def get_client_performance_using_get_with_http_info(client_id, opts = {})
450
+ if @api_client.config.debugging
451
+ @api_client.config.logger.debug 'Calling API: PerformanceApi.get_client_performance_using_get ...'
452
+ end
453
+ # verify the required parameter 'client_id' is set
454
+ if @api_client.config.client_side_validation && client_id.nil?
455
+ fail ArgumentError, "Missing the required parameter 'client_id' when calling PerformanceApi.get_client_performance_using_get"
456
+ end
457
+ # resource path
458
+ local_var_path = '/client/{client_id}/performance'.sub('{' + 'client_id' + '}', client_id.to_s)
459
+
460
+ # query parameters
461
+ query_params = {}
462
+ query_params[:'active_premium_period'] = opts[:'active_premium_period'] if !opts[:'active_premium_period'].nil?
463
+ query_params[:'annualized_return_period'] = opts[:'annualized_return_period'] if !opts[:'annualized_return_period'].nil?
464
+ query_params[:'benchmark_id'] = opts[:'benchmark_id'] if !opts[:'benchmark_id'].nil?
465
+ query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
466
+ query_params[:'hist_factor'] = opts[:'hist_factor'] if !opts[:'hist_factor'].nil?
467
+ query_params[:'mar_down_side_deviation'] = opts[:'mar_down_side_deviation'] if !opts[:'mar_down_side_deviation'].nil?
468
+ query_params[:'max_percentile_monte_carlo'] = opts[:'max_percentile_monte_carlo'] if !opts[:'max_percentile_monte_carlo'].nil?
469
+ query_params[:'mean_percentile_monte_carlo'] = opts[:'mean_percentile_monte_carlo'] if !opts[:'mean_percentile_monte_carlo'].nil?
470
+ query_params[:'min_percentile_monte_carlo'] = opts[:'min_percentile_monte_carlo'] if !opts[:'min_percentile_monte_carlo'].nil?
471
+ query_params[:'moving_average_n_day'] = opts[:'moving_average_n_day'] if !opts[:'moving_average_n_day'].nil?
472
+ query_params[:'n_day_returns'] = opts[:'n_day_returns'] if !opts[:'n_day_returns'].nil?
473
+ query_params[:'n_path_monte_carlo'] = opts[:'n_path_monte_carlo'] if !opts[:'n_path_monte_carlo'].nil?
474
+ query_params[:'n_rolling_max_drawdown'] = opts[:'n_rolling_max_drawdown'] if !opts[:'n_rolling_max_drawdown'].nil?
475
+ query_params[:'n_rolling_volatility'] = opts[:'n_rolling_volatility'] if !opts[:'n_rolling_volatility'].nil?
476
+ query_params[:'num_sim_monte_carlo'] = opts[:'num_sim_monte_carlo'] if !opts[:'num_sim_monte_carlo'].nil?
477
+ query_params[:'period_type'] = opts[:'period_type'] if !opts[:'period_type'].nil?
478
+ query_params[:'risk_free_alpha'] = opts[:'risk_free_alpha'] if !opts[:'risk_free_alpha'].nil?
479
+ query_params[:'risk_free_sharpe'] = opts[:'risk_free_sharpe'] if !opts[:'risk_free_sharpe'].nil?
480
+ query_params[:'risk_free_sortino'] = opts[:'risk_free_sortino'] if !opts[:'risk_free_sortino'].nil?
481
+ query_params[:'risk_free_treynor'] = opts[:'risk_free_treynor'] if !opts[:'risk_free_treynor'].nil?
482
+ query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
483
+ query_params[:'stat'] = opts[:'stat'] if !opts[:'stat'].nil?
484
+ query_params[:'var_conf_interval'] = opts[:'var_conf_interval'] if !opts[:'var_conf_interval'].nil?
485
+
486
+ # header parameters
487
+ header_params = {}
488
+ # HTTP header 'Accept' (if needed)
489
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
490
+
491
+ # form parameters
492
+ form_params = {}
493
+
494
+ # http body (model)
495
+ post_body = nil
496
+ auth_names = ['oauth2']
497
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
498
+ :header_params => header_params,
499
+ :query_params => query_params,
500
+ :form_params => form_params,
501
+ :body => post_body,
502
+ :auth_names => auth_names,
503
+ :return_type => 'Object')
504
+ if @api_client.config.debugging
505
+ @api_client.config.logger.debug "API called: PerformanceApi#get_client_performance_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
506
+ end
507
+ return data, status_code, headers
508
+ end
509
+ # Goal Performance
510
+ # Get information on the performance of a goal using IRR (Internal Rate of Return). You must provide the unique goal_id.
511
+ # @param client_id client_id
512
+ # @param goal_id Goal Id - /account
513
+ # @param [Hash] opts the optional parameters
514
+ # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
515
+ # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
516
+ # @option opts [String] :benchmark_id Client Benchmark or Tenant Benchmark id -/benchmark
517
+ # @option opts [Date] :end_date end date (default to null)
518
+ # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
519
+ # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0)
520
+ # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
521
+ # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
522
+ # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
523
+ # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
524
+ # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)
525
+ # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
526
+ # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
527
+ # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
528
+ # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000)
529
+ # @option opts [String] :period_type Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
530
+ # @option opts [BOOLEAN] :portfolio_goal portfolio_goal (default to false)
531
+ # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
532
+ # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0)
533
+ # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
534
+ # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0)
535
+ # @option opts [Date] :start_date start date (default to null)
536
+ # @option opts [String] :stat A stat type - /statistics
537
+ # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
538
+ # @return [Object]
539
+ def get_goal_performance_using_get(client_id, goal_id, opts = {})
540
+ data, _status_code, _headers = get_goal_performance_using_get_with_http_info(client_id, goal_id, opts)
541
+ data
542
+ end
543
+
544
+ # Goal Performance
545
+ # Get information on the performance of a goal using IRR (Internal Rate of Return). You must provide the unique goal_id.
546
+ # @param client_id client_id
547
+ # @param goal_id Goal Id - /account
548
+ # @param [Hash] opts the optional parameters
549
+ # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
550
+ # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
551
+ # @option opts [String] :benchmark_id Client Benchmark or Tenant Benchmark id -/benchmark
552
+ # @option opts [Date] :end_date end date
553
+ # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
554
+ # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0)
555
+ # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
556
+ # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
557
+ # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
558
+ # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
559
+ # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)
560
+ # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
561
+ # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
562
+ # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
563
+ # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000)
564
+ # @option opts [String] :period_type Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
565
+ # @option opts [BOOLEAN] :portfolio_goal portfolio_goal
566
+ # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
567
+ # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0)
568
+ # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
569
+ # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0)
570
+ # @option opts [Date] :start_date start date
571
+ # @option opts [String] :stat A stat type - /statistics
572
+ # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
573
+ # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
574
+ def get_goal_performance_using_get_with_http_info(client_id, goal_id, opts = {})
575
+ if @api_client.config.debugging
576
+ @api_client.config.logger.debug 'Calling API: PerformanceApi.get_goal_performance_using_get ...'
577
+ end
578
+ # verify the required parameter 'client_id' is set
579
+ if @api_client.config.client_side_validation && client_id.nil?
580
+ fail ArgumentError, "Missing the required parameter 'client_id' when calling PerformanceApi.get_goal_performance_using_get"
581
+ end
582
+ # verify the required parameter 'goal_id' is set
583
+ if @api_client.config.client_side_validation && goal_id.nil?
584
+ fail ArgumentError, "Missing the required parameter 'goal_id' when calling PerformanceApi.get_goal_performance_using_get"
585
+ end
586
+ # resource path
587
+ local_var_path = '/goal/{goal_id}/performance'.sub('{' + 'goal_id' + '}', goal_id.to_s)
588
+
589
+ # query parameters
590
+ query_params = {}
591
+ query_params[:'client_id'] = client_id
592
+ query_params[:'active_premium_period'] = opts[:'active_premium_period'] if !opts[:'active_premium_period'].nil?
593
+ query_params[:'annualized_return_period'] = opts[:'annualized_return_period'] if !opts[:'annualized_return_period'].nil?
594
+ query_params[:'benchmark_id'] = opts[:'benchmark_id'] if !opts[:'benchmark_id'].nil?
595
+ query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
596
+ query_params[:'hist_factor'] = opts[:'hist_factor'] if !opts[:'hist_factor'].nil?
597
+ query_params[:'mar_down_side_deviation'] = opts[:'mar_down_side_deviation'] if !opts[:'mar_down_side_deviation'].nil?
598
+ query_params[:'max_percentile_monte_carlo'] = opts[:'max_percentile_monte_carlo'] if !opts[:'max_percentile_monte_carlo'].nil?
599
+ query_params[:'mean_percentile_monte_carlo'] = opts[:'mean_percentile_monte_carlo'] if !opts[:'mean_percentile_monte_carlo'].nil?
600
+ query_params[:'min_percentile_monte_carlo'] = opts[:'min_percentile_monte_carlo'] if !opts[:'min_percentile_monte_carlo'].nil?
601
+ query_params[:'moving_average_n_day'] = opts[:'moving_average_n_day'] if !opts[:'moving_average_n_day'].nil?
602
+ query_params[:'n_day_returns'] = opts[:'n_day_returns'] if !opts[:'n_day_returns'].nil?
603
+ query_params[:'n_path_monte_carlo'] = opts[:'n_path_monte_carlo'] if !opts[:'n_path_monte_carlo'].nil?
604
+ query_params[:'n_rolling_max_drawdown'] = opts[:'n_rolling_max_drawdown'] if !opts[:'n_rolling_max_drawdown'].nil?
605
+ query_params[:'n_rolling_volatility'] = opts[:'n_rolling_volatility'] if !opts[:'n_rolling_volatility'].nil?
606
+ query_params[:'num_sim_monte_carlo'] = opts[:'num_sim_monte_carlo'] if !opts[:'num_sim_monte_carlo'].nil?
607
+ query_params[:'period_type'] = opts[:'period_type'] if !opts[:'period_type'].nil?
608
+ query_params[:'portfolio_goal'] = opts[:'portfolio_goal'] if !opts[:'portfolio_goal'].nil?
609
+ query_params[:'risk_free_alpha'] = opts[:'risk_free_alpha'] if !opts[:'risk_free_alpha'].nil?
610
+ query_params[:'risk_free_sharpe'] = opts[:'risk_free_sharpe'] if !opts[:'risk_free_sharpe'].nil?
611
+ query_params[:'risk_free_sortino'] = opts[:'risk_free_sortino'] if !opts[:'risk_free_sortino'].nil?
612
+ query_params[:'risk_free_treynor'] = opts[:'risk_free_treynor'] if !opts[:'risk_free_treynor'].nil?
613
+ query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
614
+ query_params[:'stat'] = opts[:'stat'] if !opts[:'stat'].nil?
615
+ query_params[:'var_conf_interval'] = opts[:'var_conf_interval'] if !opts[:'var_conf_interval'].nil?
616
+
617
+ # header parameters
618
+ header_params = {}
619
+ # HTTP header 'Accept' (if needed)
620
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
621
+
622
+ # form parameters
623
+ form_params = {}
624
+
625
+ # http body (model)
626
+ post_body = nil
627
+ auth_names = ['oauth2']
628
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
629
+ :header_params => header_params,
630
+ :query_params => query_params,
631
+ :form_params => form_params,
632
+ :body => post_body,
633
+ :auth_names => auth_names,
634
+ :return_type => 'Object')
635
+ if @api_client.config.debugging
636
+ @api_client.config.logger.debug "API called: PerformanceApi#get_goal_performance_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
637
+ end
638
+ return data, status_code, headers
639
+ end
640
+ # Household Performance
641
+ # Get information on the performance of a Household using IRR (Internal Rate of Return). You must provide the unique household_id.
642
+ # @param household_id Household Id -/household
643
+ # @param [Hash] opts the optional parameters
644
+ # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
645
+ # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
646
+ # @option opts [String] :benchmark_id Client Benchmark or Tenant Benchmark id -/benchmark
647
+ # @option opts [Date] :end_date end date
648
+ # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
649
+ # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0)
650
+ # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
651
+ # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
652
+ # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
653
+ # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
654
+ # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)
655
+ # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
656
+ # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
657
+ # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
658
+ # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000)
659
+ # @option opts [String] :period_type Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
660
+ # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
661
+ # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0)
662
+ # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
663
+ # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0)
664
+ # @option opts [Date] :start_date start date
665
+ # @option opts [String] :stat A stat type -- /statistics
666
+ # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
667
+ # @return [Object]
668
+ def get_household_client_performance_using_get(household_id, opts = {})
669
+ data, _status_code, _headers = get_household_client_performance_using_get_with_http_info(household_id, opts)
670
+ data
671
+ end
672
+
673
+ # Household Performance
674
+ # Get information on the performance of a Household using IRR (Internal Rate of Return). You must provide the unique household_id.
675
+ # @param household_id Household Id -/household
676
+ # @param [Hash] opts the optional parameters
677
+ # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
678
+ # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
679
+ # @option opts [String] :benchmark_id Client Benchmark or Tenant Benchmark id -/benchmark
680
+ # @option opts [Date] :end_date end date
681
+ # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
682
+ # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0)
683
+ # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
684
+ # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
685
+ # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
686
+ # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
687
+ # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)
688
+ # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
689
+ # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
690
+ # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
691
+ # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000)
692
+ # @option opts [String] :period_type Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
693
+ # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
694
+ # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0)
695
+ # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
696
+ # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0)
697
+ # @option opts [Date] :start_date start date
698
+ # @option opts [String] :stat A stat type -- /statistics
699
+ # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
700
+ # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
701
+ def get_household_client_performance_using_get_with_http_info(household_id, opts = {})
702
+ if @api_client.config.debugging
703
+ @api_client.config.logger.debug 'Calling API: PerformanceApi.get_household_client_performance_using_get ...'
704
+ end
705
+ # verify the required parameter 'household_id' is set
706
+ if @api_client.config.client_side_validation && household_id.nil?
707
+ fail ArgumentError, "Missing the required parameter 'household_id' when calling PerformanceApi.get_household_client_performance_using_get"
708
+ end
709
+ # resource path
710
+ local_var_path = '/household/{household_id}/performance'.sub('{' + 'household_id' + '}', household_id.to_s)
711
+
712
+ # query parameters
713
+ query_params = {}
714
+ query_params[:'active_premium_period'] = opts[:'active_premium_period'] if !opts[:'active_premium_period'].nil?
715
+ query_params[:'annualized_return_period'] = opts[:'annualized_return_period'] if !opts[:'annualized_return_period'].nil?
716
+ query_params[:'benchmark_id'] = opts[:'benchmark_id'] if !opts[:'benchmark_id'].nil?
717
+ query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
718
+ query_params[:'hist_factor'] = opts[:'hist_factor'] if !opts[:'hist_factor'].nil?
719
+ query_params[:'mar_down_side_deviation'] = opts[:'mar_down_side_deviation'] if !opts[:'mar_down_side_deviation'].nil?
720
+ query_params[:'max_percentile_monte_carlo'] = opts[:'max_percentile_monte_carlo'] if !opts[:'max_percentile_monte_carlo'].nil?
721
+ query_params[:'mean_percentile_monte_carlo'] = opts[:'mean_percentile_monte_carlo'] if !opts[:'mean_percentile_monte_carlo'].nil?
722
+ query_params[:'min_percentile_monte_carlo'] = opts[:'min_percentile_monte_carlo'] if !opts[:'min_percentile_monte_carlo'].nil?
723
+ query_params[:'moving_average_n_day'] = opts[:'moving_average_n_day'] if !opts[:'moving_average_n_day'].nil?
724
+ query_params[:'n_day_returns'] = opts[:'n_day_returns'] if !opts[:'n_day_returns'].nil?
725
+ query_params[:'n_path_monte_carlo'] = opts[:'n_path_monte_carlo'] if !opts[:'n_path_monte_carlo'].nil?
726
+ query_params[:'n_rolling_max_drawdown'] = opts[:'n_rolling_max_drawdown'] if !opts[:'n_rolling_max_drawdown'].nil?
727
+ query_params[:'n_rolling_volatility'] = opts[:'n_rolling_volatility'] if !opts[:'n_rolling_volatility'].nil?
728
+ query_params[:'num_sim_monte_carlo'] = opts[:'num_sim_monte_carlo'] if !opts[:'num_sim_monte_carlo'].nil?
729
+ query_params[:'period_type'] = opts[:'period_type'] if !opts[:'period_type'].nil?
730
+ query_params[:'risk_free_alpha'] = opts[:'risk_free_alpha'] if !opts[:'risk_free_alpha'].nil?
731
+ query_params[:'risk_free_sharpe'] = opts[:'risk_free_sharpe'] if !opts[:'risk_free_sharpe'].nil?
732
+ query_params[:'risk_free_sortino'] = opts[:'risk_free_sortino'] if !opts[:'risk_free_sortino'].nil?
733
+ query_params[:'risk_free_treynor'] = opts[:'risk_free_treynor'] if !opts[:'risk_free_treynor'].nil?
734
+ query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
735
+ query_params[:'stat'] = opts[:'stat'] if !opts[:'stat'].nil?
736
+ query_params[:'var_conf_interval'] = opts[:'var_conf_interval'] if !opts[:'var_conf_interval'].nil?
737
+
738
+ # header parameters
739
+ header_params = {}
740
+ # HTTP header 'Accept' (if needed)
741
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
742
+
743
+ # form parameters
744
+ form_params = {}
745
+
746
+ # http body (model)
747
+ post_body = nil
748
+ auth_names = ['oauth2']
749
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
750
+ :header_params => header_params,
751
+ :query_params => query_params,
752
+ :form_params => form_params,
753
+ :body => post_body,
754
+ :auth_names => auth_names,
755
+ :return_type => 'Object')
756
+ if @api_client.config.debugging
757
+ @api_client.config.logger.debug "API called: PerformanceApi#get_household_client_performance_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
758
+ end
759
+ return data, status_code, headers
760
+ end
761
+ # Model Performance
762
+ # Get information on the performance of a model using TWR (Time Weighted Return). You must provide the unique model_id.
763
+ # @param model_id Model Id - /model
764
+ # @param [Hash] opts the optional parameters
765
+ # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
766
+ # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
767
+ # @option opts [String] :benchmark_id Tenant Benchmark Id -/benchmark
768
+ # @option opts [Date] :end_date end date
769
+ # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
770
+ # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0)
771
+ # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
772
+ # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
773
+ # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
774
+ # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
775
+ # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)
776
+ # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
777
+ # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
778
+ # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
779
+ # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000)
780
+ # @option opts [String] :period_type Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
781
+ # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
782
+ # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0)
783
+ # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
784
+ # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0)
785
+ # @option opts [Date] :start_date start date
786
+ # @option opts [String] :stat Stat Type
787
+ # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
788
+ # @return [Object]
789
+ def get_model_performance_using_get(model_id, opts = {})
790
+ data, _status_code, _headers = get_model_performance_using_get_with_http_info(model_id, opts)
791
+ data
792
+ end
793
+
794
+ # Model Performance
795
+ # Get information on the performance of a model using TWR (Time Weighted Return). You must provide the unique model_id.
796
+ # @param model_id Model Id - /model
797
+ # @param [Hash] opts the optional parameters
798
+ # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
799
+ # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
800
+ # @option opts [String] :benchmark_id Tenant Benchmark Id -/benchmark
801
+ # @option opts [Date] :end_date end date
802
+ # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
803
+ # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0)
804
+ # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
805
+ # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
806
+ # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
807
+ # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
808
+ # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)
809
+ # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
810
+ # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
811
+ # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
812
+ # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000)
813
+ # @option opts [String] :period_type Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
814
+ # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
815
+ # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0)
816
+ # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
817
+ # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0)
818
+ # @option opts [Date] :start_date start date
819
+ # @option opts [String] :stat Stat Type
820
+ # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
821
+ # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
822
+ def get_model_performance_using_get_with_http_info(model_id, opts = {})
823
+ if @api_client.config.debugging
824
+ @api_client.config.logger.debug 'Calling API: PerformanceApi.get_model_performance_using_get ...'
825
+ end
826
+ # verify the required parameter 'model_id' is set
827
+ if @api_client.config.client_side_validation && model_id.nil?
828
+ fail ArgumentError, "Missing the required parameter 'model_id' when calling PerformanceApi.get_model_performance_using_get"
829
+ end
830
+ # resource path
831
+ local_var_path = '/model/{model_id}/performance'.sub('{' + 'model_id' + '}', model_id.to_s)
832
+
833
+ # query parameters
834
+ query_params = {}
835
+ query_params[:'active_premium_period'] = opts[:'active_premium_period'] if !opts[:'active_premium_period'].nil?
836
+ query_params[:'annualized_return_period'] = opts[:'annualized_return_period'] if !opts[:'annualized_return_period'].nil?
837
+ query_params[:'benchmark_id'] = opts[:'benchmark_id'] if !opts[:'benchmark_id'].nil?
838
+ query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
839
+ query_params[:'hist_factor'] = opts[:'hist_factor'] if !opts[:'hist_factor'].nil?
840
+ query_params[:'mar_down_side_deviation'] = opts[:'mar_down_side_deviation'] if !opts[:'mar_down_side_deviation'].nil?
841
+ query_params[:'max_percentile_monte_carlo'] = opts[:'max_percentile_monte_carlo'] if !opts[:'max_percentile_monte_carlo'].nil?
842
+ query_params[:'mean_percentile_monte_carlo'] = opts[:'mean_percentile_monte_carlo'] if !opts[:'mean_percentile_monte_carlo'].nil?
843
+ query_params[:'min_percentile_monte_carlo'] = opts[:'min_percentile_monte_carlo'] if !opts[:'min_percentile_monte_carlo'].nil?
844
+ query_params[:'moving_average_n_day'] = opts[:'moving_average_n_day'] if !opts[:'moving_average_n_day'].nil?
845
+ query_params[:'n_day_returns'] = opts[:'n_day_returns'] if !opts[:'n_day_returns'].nil?
846
+ query_params[:'n_path_monte_carlo'] = opts[:'n_path_monte_carlo'] if !opts[:'n_path_monte_carlo'].nil?
847
+ query_params[:'n_rolling_max_drawdown'] = opts[:'n_rolling_max_drawdown'] if !opts[:'n_rolling_max_drawdown'].nil?
848
+ query_params[:'n_rolling_volatility'] = opts[:'n_rolling_volatility'] if !opts[:'n_rolling_volatility'].nil?
849
+ query_params[:'num_sim_monte_carlo'] = opts[:'num_sim_monte_carlo'] if !opts[:'num_sim_monte_carlo'].nil?
850
+ query_params[:'period_type'] = opts[:'period_type'] if !opts[:'period_type'].nil?
851
+ query_params[:'risk_free_alpha'] = opts[:'risk_free_alpha'] if !opts[:'risk_free_alpha'].nil?
852
+ query_params[:'risk_free_sharpe'] = opts[:'risk_free_sharpe'] if !opts[:'risk_free_sharpe'].nil?
853
+ query_params[:'risk_free_sortino'] = opts[:'risk_free_sortino'] if !opts[:'risk_free_sortino'].nil?
854
+ query_params[:'risk_free_treynor'] = opts[:'risk_free_treynor'] if !opts[:'risk_free_treynor'].nil?
855
+ query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
856
+ query_params[:'stat'] = opts[:'stat'] if !opts[:'stat'].nil?
857
+ query_params[:'var_conf_interval'] = opts[:'var_conf_interval'] if !opts[:'var_conf_interval'].nil?
858
+
859
+ # header parameters
860
+ header_params = {}
861
+ # HTTP header 'Accept' (if needed)
862
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
863
+
864
+ # form parameters
865
+ form_params = {}
866
+
867
+ # http body (model)
868
+ post_body = nil
869
+ auth_names = ['oauth2']
870
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
871
+ :header_params => header_params,
872
+ :query_params => query_params,
873
+ :form_params => form_params,
874
+ :body => post_body,
875
+ :auth_names => auth_names,
876
+ :return_type => 'Object')
877
+ if @api_client.config.debugging
878
+ @api_client.config.logger.debug "API called: PerformanceApi#get_model_performance_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
879
+ end
880
+ return data, status_code, headers
881
+ end
882
+ # Portfolio Performance
883
+ # Get information on the performance of a portfolio using IRR (Internal Rate of Return). You must provide the unique portfolio_id.
884
+ # @param portfolio_id Portfolio Id -/portoflio
885
+ # @param [Hash] opts the optional parameters
886
+ # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
887
+ # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
888
+ # @option opts [String] :benchmark_id Benchmark Id - benchmarkId or clientBenchmarkId -/benchmark
889
+ # @option opts [Date] :end_date end date
890
+ # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
891
+ # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0)
892
+ # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
893
+ # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
894
+ # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
895
+ # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
896
+ # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)
897
+ # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
898
+ # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
899
+ # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
900
+ # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000)
901
+ # @option opts [String] :period_type Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
902
+ # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
903
+ # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0)
904
+ # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
905
+ # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0)
906
+ # @option opts [Date] :start_date start date
907
+ # @option opts [String] :stat A stat type - /statistics endpoint to get types
908
+ # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
909
+ # @return [Object]
910
+ def get_portfolio_performance_using_get(portfolio_id, opts = {})
911
+ data, _status_code, _headers = get_portfolio_performance_using_get_with_http_info(portfolio_id, opts)
912
+ data
913
+ end
914
+
915
+ # Portfolio Performance
916
+ # Get information on the performance of a portfolio using IRR (Internal Rate of Return). You must provide the unique portfolio_id.
917
+ # @param portfolio_id Portfolio Id -/portoflio
918
+ # @param [Hash] opts the optional parameters
919
+ # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
920
+ # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
921
+ # @option opts [String] :benchmark_id Benchmark Id - benchmarkId or clientBenchmarkId -/benchmark
922
+ # @option opts [Date] :end_date end date
923
+ # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
924
+ # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0)
925
+ # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
926
+ # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
927
+ # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
928
+ # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
929
+ # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)
930
+ # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
931
+ # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
932
+ # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
933
+ # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000)
934
+ # @option opts [String] :period_type Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
935
+ # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
936
+ # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0)
937
+ # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
938
+ # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0)
939
+ # @option opts [Date] :start_date start date
940
+ # @option opts [String] :stat A stat type - /statistics endpoint to get types
941
+ # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
942
+ # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
943
+ def get_portfolio_performance_using_get_with_http_info(portfolio_id, opts = {})
944
+ if @api_client.config.debugging
945
+ @api_client.config.logger.debug 'Calling API: PerformanceApi.get_portfolio_performance_using_get ...'
946
+ end
947
+ # verify the required parameter 'portfolio_id' is set
948
+ if @api_client.config.client_side_validation && portfolio_id.nil?
949
+ fail ArgumentError, "Missing the required parameter 'portfolio_id' when calling PerformanceApi.get_portfolio_performance_using_get"
950
+ end
951
+ # resource path
952
+ local_var_path = '/portfolio/{portfolio_id}/performance'.sub('{' + 'portfolio_id' + '}', portfolio_id.to_s)
953
+
954
+ # query parameters
955
+ query_params = {}
956
+ query_params[:'active_premium_period'] = opts[:'active_premium_period'] if !opts[:'active_premium_period'].nil?
957
+ query_params[:'annualized_return_period'] = opts[:'annualized_return_period'] if !opts[:'annualized_return_period'].nil?
958
+ query_params[:'benchmark_id'] = opts[:'benchmark_id'] if !opts[:'benchmark_id'].nil?
959
+ query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
960
+ query_params[:'hist_factor'] = opts[:'hist_factor'] if !opts[:'hist_factor'].nil?
961
+ query_params[:'mar_down_side_deviation'] = opts[:'mar_down_side_deviation'] if !opts[:'mar_down_side_deviation'].nil?
962
+ query_params[:'max_percentile_monte_carlo'] = opts[:'max_percentile_monte_carlo'] if !opts[:'max_percentile_monte_carlo'].nil?
963
+ query_params[:'mean_percentile_monte_carlo'] = opts[:'mean_percentile_monte_carlo'] if !opts[:'mean_percentile_monte_carlo'].nil?
964
+ query_params[:'min_percentile_monte_carlo'] = opts[:'min_percentile_monte_carlo'] if !opts[:'min_percentile_monte_carlo'].nil?
965
+ query_params[:'moving_average_n_day'] = opts[:'moving_average_n_day'] if !opts[:'moving_average_n_day'].nil?
966
+ query_params[:'n_day_returns'] = opts[:'n_day_returns'] if !opts[:'n_day_returns'].nil?
967
+ query_params[:'n_path_monte_carlo'] = opts[:'n_path_monte_carlo'] if !opts[:'n_path_monte_carlo'].nil?
968
+ query_params[:'n_rolling_max_drawdown'] = opts[:'n_rolling_max_drawdown'] if !opts[:'n_rolling_max_drawdown'].nil?
969
+ query_params[:'n_rolling_volatility'] = opts[:'n_rolling_volatility'] if !opts[:'n_rolling_volatility'].nil?
970
+ query_params[:'num_sim_monte_carlo'] = opts[:'num_sim_monte_carlo'] if !opts[:'num_sim_monte_carlo'].nil?
971
+ query_params[:'period_type'] = opts[:'period_type'] if !opts[:'period_type'].nil?
972
+ query_params[:'risk_free_alpha'] = opts[:'risk_free_alpha'] if !opts[:'risk_free_alpha'].nil?
973
+ query_params[:'risk_free_sharpe'] = opts[:'risk_free_sharpe'] if !opts[:'risk_free_sharpe'].nil?
974
+ query_params[:'risk_free_sortino'] = opts[:'risk_free_sortino'] if !opts[:'risk_free_sortino'].nil?
975
+ query_params[:'risk_free_treynor'] = opts[:'risk_free_treynor'] if !opts[:'risk_free_treynor'].nil?
976
+ query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
977
+ query_params[:'stat'] = opts[:'stat'] if !opts[:'stat'].nil?
978
+ query_params[:'var_conf_interval'] = opts[:'var_conf_interval'] if !opts[:'var_conf_interval'].nil?
979
+
980
+ # header parameters
981
+ header_params = {}
982
+ # HTTP header 'Accept' (if needed)
983
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
984
+
985
+ # form parameters
986
+ form_params = {}
987
+
988
+ # http body (model)
989
+ post_body = nil
990
+ auth_names = ['oauth2']
991
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
992
+ :header_params => header_params,
993
+ :query_params => query_params,
994
+ :form_params => form_params,
995
+ :body => post_body,
996
+ :auth_names => auth_names,
997
+ :return_type => 'Object')
998
+ if @api_client.config.debugging
999
+ @api_client.config.logger.debug "API called: PerformanceApi#get_portfolio_performance_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1000
+ end
1001
+ return data, status_code, headers
1002
+ end
1003
+ # Security Performance
1004
+ # Get performance statistics for a security using TWR (Time Weighted Return). You must provide the unique security_id
1005
+ # @param security_id security_id
1006
+ # @param [Hash] opts the optional parameters
1007
+ # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
1008
+ # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
1009
+ # @option opts [String] :bench_ticker Bench Ticker for security - (default: ^GSPC)
1010
+ # @option opts [String] :benchmark_id benchmark_id
1011
+ # @option opts [Date] :end_date Ending parameter for time window
1012
+ # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
1013
+ # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0)
1014
+ # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
1015
+ # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
1016
+ # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
1017
+ # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
1018
+ # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)
1019
+ # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
1020
+ # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
1021
+ # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
1022
+ # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000)
1023
+ # @option opts [String] :period_type Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
1024
+ # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
1025
+ # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0)
1026
+ # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
1027
+ # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0)
1028
+ # @option opts [Date] :start_date Starting parameter for time window
1029
+ # @option opts [String] :stat A stat type - /statistics endpoint
1030
+ # @option opts [String] :ticker Ticker for security
1031
+ # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
1032
+ # @return [Object]
1033
+ def get_security_performance_using_get(security_id, opts = {})
1034
+ data, _status_code, _headers = get_security_performance_using_get_with_http_info(security_id, opts)
1035
+ data
1036
+ end
1037
+
1038
+ # Security Performance
1039
+ # Get performance statistics for a security using TWR (Time Weighted Return). You must provide the unique security_id
1040
+ # @param security_id security_id
1041
+ # @param [Hash] opts the optional parameters
1042
+ # @option opts [String] :active_premium_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
1043
+ # @option opts [String] :annualized_return_period Q (quarterly), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () - (statId: 19, default: &#39;D&#39;)
1044
+ # @option opts [String] :bench_ticker Bench Ticker for security - (default: ^GSPC)
1045
+ # @option opts [String] :benchmark_id benchmark_id
1046
+ # @option opts [Date] :end_date Ending parameter for time window
1047
+ # @option opts [Float] :hist_factor Histogram factor- (statId: 39, default: 5)
1048
+ # @option opts [Float] :mar_down_side_deviation minimum acceptable return for downside deviation - (statId: 58, default: 0)
1049
+ # @option opts [Float] :max_percentile_monte_carlo max percentile for monte carlo, i.entity. 80 - (statId: 62, default: 95)
1050
+ # @option opts [Float] :mean_percentile_monte_carlo mean percentile for monte carlo i.entity. 50- (statId: 62, default: 50)
1051
+ # @option opts [Float] :min_percentile_monte_carlo min percentile for monte carlo i.entity. 20 - (statId: 62, default: 5)
1052
+ # @option opts [Integer] :moving_average_n_day number of days for moving average n-day - (statId: 18, default: 7)
1053
+ # @option opts [Integer] :n_day_returns number of days for Rolling n-day returns - (statId: 2, default: 7)
1054
+ # @option opts [Integer] :n_path_monte_carlo number of points for a simulation- (statId: 62, default: 100)
1055
+ # @option opts [Integer] :n_rolling_max_drawdown number of days for Rolling n-day max drawdown- (statId: 46, default: 7)
1056
+ # @option opts [Integer] :n_rolling_volatility number of days for Rolling n-day volatility- (statId: 34, default: 7)
1057
+ # @option opts [Integer] :num_sim_monte_carlo number of simulations - (statId: 62, default: 1000)
1058
+ # @option opts [String] :period_type Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () -Carries out stats on either daily, monthly, annually or quarterly dates (default: &#39;D&#39;)
1059
+ # @option opts [Float] :risk_free_alpha risk free val alpha - (statId: 52, default: 0)
1060
+ # @option opts [Float] :risk_free_sharpe risk free val sharpe- (statId: 49, default: 0)
1061
+ # @option opts [Float] :risk_free_sortino risk free val sortino - (statId: 56, default: 0)
1062
+ # @option opts [Float] :risk_free_treynor risk free val treynor- (statId: 51, default: 0)
1063
+ # @option opts [Date] :start_date Starting parameter for time window
1064
+ # @option opts [String] :stat A stat type - /statistics endpoint
1065
+ # @option opts [String] :ticker Ticker for security
1066
+ # @option opts [Float] :var_conf_interval VaR Confidence Interval ( alpha ) i.entity 99, 95, etc - (statId: 40, default: 95)
1067
+ # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
1068
+ def get_security_performance_using_get_with_http_info(security_id, opts = {})
1069
+ if @api_client.config.debugging
1070
+ @api_client.config.logger.debug 'Calling API: PerformanceApi.get_security_performance_using_get ...'
1071
+ end
1072
+ # verify the required parameter 'security_id' is set
1073
+ if @api_client.config.client_side_validation && security_id.nil?
1074
+ fail ArgumentError, "Missing the required parameter 'security_id' when calling PerformanceApi.get_security_performance_using_get"
1075
+ end
1076
+ # resource path
1077
+ local_var_path = '/security/{security_id}/performance'.sub('{' + 'security_id' + '}', security_id.to_s)
1078
+
1079
+ # query parameters
1080
+ query_params = {}
1081
+ query_params[:'active_premium_period'] = opts[:'active_premium_period'] if !opts[:'active_premium_period'].nil?
1082
+ query_params[:'annualized_return_period'] = opts[:'annualized_return_period'] if !opts[:'annualized_return_period'].nil?
1083
+ query_params[:'benchTicker'] = opts[:'bench_ticker'] if !opts[:'bench_ticker'].nil?
1084
+ query_params[:'benchmark_id'] = opts[:'benchmark_id'] if !opts[:'benchmark_id'].nil?
1085
+ query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
1086
+ query_params[:'hist_factor'] = opts[:'hist_factor'] if !opts[:'hist_factor'].nil?
1087
+ query_params[:'mar_down_side_deviation'] = opts[:'mar_down_side_deviation'] if !opts[:'mar_down_side_deviation'].nil?
1088
+ query_params[:'max_percentile_monte_carlo'] = opts[:'max_percentile_monte_carlo'] if !opts[:'max_percentile_monte_carlo'].nil?
1089
+ query_params[:'mean_percentile_monte_carlo'] = opts[:'mean_percentile_monte_carlo'] if !opts[:'mean_percentile_monte_carlo'].nil?
1090
+ query_params[:'min_percentile_monte_carlo'] = opts[:'min_percentile_monte_carlo'] if !opts[:'min_percentile_monte_carlo'].nil?
1091
+ query_params[:'moving_average_n_day'] = opts[:'moving_average_n_day'] if !opts[:'moving_average_n_day'].nil?
1092
+ query_params[:'n_day_returns'] = opts[:'n_day_returns'] if !opts[:'n_day_returns'].nil?
1093
+ query_params[:'n_path_monte_carlo'] = opts[:'n_path_monte_carlo'] if !opts[:'n_path_monte_carlo'].nil?
1094
+ query_params[:'n_rolling_max_drawdown'] = opts[:'n_rolling_max_drawdown'] if !opts[:'n_rolling_max_drawdown'].nil?
1095
+ query_params[:'n_rolling_volatility'] = opts[:'n_rolling_volatility'] if !opts[:'n_rolling_volatility'].nil?
1096
+ query_params[:'num_sim_monte_carlo'] = opts[:'num_sim_monte_carlo'] if !opts[:'num_sim_monte_carlo'].nil?
1097
+ query_params[:'period_type'] = opts[:'period_type'] if !opts[:'period_type'].nil?
1098
+ query_params[:'risk_free_alpha'] = opts[:'risk_free_alpha'] if !opts[:'risk_free_alpha'].nil?
1099
+ query_params[:'risk_free_sharpe'] = opts[:'risk_free_sharpe'] if !opts[:'risk_free_sharpe'].nil?
1100
+ query_params[:'risk_free_sortino'] = opts[:'risk_free_sortino'] if !opts[:'risk_free_sortino'].nil?
1101
+ query_params[:'risk_free_treynor'] = opts[:'risk_free_treynor'] if !opts[:'risk_free_treynor'].nil?
1102
+ query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
1103
+ query_params[:'stat'] = opts[:'stat'] if !opts[:'stat'].nil?
1104
+ query_params[:'ticker'] = opts[:'ticker'] if !opts[:'ticker'].nil?
1105
+ query_params[:'var_conf_interval'] = opts[:'var_conf_interval'] if !opts[:'var_conf_interval'].nil?
1106
+
1107
+ # header parameters
1108
+ header_params = {}
1109
+ # HTTP header 'Accept' (if needed)
1110
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1111
+
1112
+ # form parameters
1113
+ form_params = {}
1114
+
1115
+ # http body (model)
1116
+ post_body = nil
1117
+ auth_names = ['oauth2']
1118
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1119
+ :header_params => header_params,
1120
+ :query_params => query_params,
1121
+ :form_params => form_params,
1122
+ :body => post_body,
1123
+ :auth_names => auth_names,
1124
+ :return_type => 'Object')
1125
+ if @api_client.config.debugging
1126
+ @api_client.config.logger.debug "API called: PerformanceApi#get_security_performance_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1127
+ end
1128
+ return data, status_code, headers
1129
+ end
1130
+ end
1131
+ end