nucleus_api 1.8.0 → 1.9.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (820) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +28 -737
  3. data/lib/nucleus_api.rb +23 -21
  4. data/lib/nucleus_api/api/account_api.rb +73 -112
  5. data/lib/nucleus_api/api/admin_client_api.rb +85 -40
  6. data/lib/nucleus_api/api/aggregation_account_api.rb +85 -30
  7. data/lib/nucleus_api/api/allocation_api.rb +16 -16
  8. data/lib/nucleus_api/api/benchmark_api.rb +9 -9
  9. data/lib/nucleus_api/api/budget_api.rb +7 -7
  10. data/lib/nucleus_api/api/bulk_api.rb +6 -6
  11. data/lib/nucleus_api/api/business_api.rb +32 -14
  12. data/lib/nucleus_api/api/card_api.rb +159 -14
  13. data/lib/nucleus_api/api/client_api.rb +318 -22
  14. data/lib/nucleus_api/api/{customer_api.rb → contact_api.rb} +176 -176
  15. data/lib/nucleus_api/api/decision_tree_api.rb +29 -31
  16. data/lib/nucleus_api/api/document_api.rb +7 -7
  17. data/lib/nucleus_api/api/financial_statement_api.rb +7 -7
  18. data/lib/nucleus_api/api/funding_api.rb +139 -423
  19. data/lib/nucleus_api/api/goal_api.rb +37 -19
  20. data/lib/nucleus_api/api/household_api.rb +32 -14
  21. data/lib/nucleus_api/api/invoice_api.rb +14 -14
  22. data/lib/nucleus_api/api/model_api.rb +31 -31
  23. data/lib/nucleus_api/api/order_api.rb +31 -31
  24. data/lib/nucleus_api/api/overflow_api.rb +10 -10
  25. data/lib/nucleus_api/api/portfolio_api.rb +97 -33
  26. data/lib/nucleus_api/api/questionnaire_api.rb +17 -295
  27. data/lib/nucleus_api/api/resource_api.rb +394 -50
  28. data/lib/nucleus_api/api/risk_profile_api.rb +7 -7
  29. data/lib/nucleus_api/api/roundup_api.rb +10 -10
  30. data/lib/nucleus_api/api/score_api.rb +7 -7
  31. data/lib/nucleus_api/api/securities_api.rb +17 -17
  32. data/lib/nucleus_api/api/spending_control_api.rb +7 -7
  33. data/lib/nucleus_api/api/utils_api.rb +1895 -60
  34. data/lib/nucleus_api/api/webhook_api.rb +7 -7
  35. data/lib/nucleus_api/api_client.rb +17 -54
  36. data/lib/nucleus_api/api_error.rb +2 -2
  37. data/lib/nucleus_api/configuration.rb +4 -19
  38. data/lib/nucleus_api/models/account.rb +8 -6
  39. data/lib/nucleus_api/models/account_allocation_mapping.rb +8 -7
  40. data/lib/nucleus_api/models/account_map.rb +8 -7
  41. data/lib/nucleus_api/models/account_permission_vo.rb +8 -7
  42. data/lib/nucleus_api/models/account_portfolio_rebalance_request.rb +8 -7
  43. data/lib/nucleus_api/models/account_status.rb +8 -12
  44. data/lib/nucleus_api/models/account_type.rb +8 -7
  45. data/lib/nucleus_api/models/acl_client_permission_vo.rb +8 -7
  46. data/lib/nucleus_api/models/admin_client.rb +27 -9
  47. data/lib/nucleus_api/models/aggregation_account.rb +139 -18
  48. data/lib/nucleus_api/models/aggregation_account_balance.rb +8 -7
  49. data/lib/nucleus_api/models/aggregation_account_holding.rb +10 -17
  50. data/lib/nucleus_api/models/aggregation_account_transaction.rb +6 -52
  51. data/lib/nucleus_api/models/aggregation_accounts_map.rb +8 -7
  52. data/lib/nucleus_api/models/allocation.rb +8 -7
  53. data/lib/nucleus_api/models/allocation_aggregated_vo.rb +8 -7
  54. data/lib/nucleus_api/models/allocation_composition.rb +8 -7
  55. data/lib/nucleus_api/models/allocation_composition_aggregated_vo.rb +8 -7
  56. data/lib/nucleus_api/models/allocation_composition_model_holdings_vo.rb +8 -7
  57. data/lib/nucleus_api/models/allocation_node_map.rb +8 -7
  58. data/lib/nucleus_api/models/answer.rb +36 -8
  59. data/lib/nucleus_api/models/answer_map.rb +8 -7
  60. data/lib/nucleus_api/models/application.rb +8 -7
  61. data/lib/nucleus_api/models/audit_log.rb +8 -7
  62. data/lib/nucleus_api/models/available_date_double_vo.rb +8 -7
  63. data/lib/nucleus_api/models/balances.rb +224 -0
  64. data/lib/nucleus_api/models/bank_credit.rb +29 -8
  65. data/lib/nucleus_api/models/bank_link.rb +42 -21
  66. data/lib/nucleus_api/models/bank_link_map.rb +8 -7
  67. data/lib/nucleus_api/models/benchmark.rb +8 -7
  68. data/lib/nucleus_api/models/benchmark_composition.rb +8 -7
  69. data/lib/nucleus_api/models/brokers.rb +8 -7
  70. data/lib/nucleus_api/models/budget.rb +19 -8
  71. data/lib/nucleus_api/models/budget_aggregation_account.rb +8 -7
  72. data/lib/nucleus_api/models/budget_object.rb +8 -7
  73. data/lib/nucleus_api/models/bulk_transaction.rb +8 -7
  74. data/lib/nucleus_api/models/bulk_transaction_vo.rb +8 -7
  75. data/lib/nucleus_api/models/business.rb +8 -8
  76. data/lib/nucleus_api/models/business_address.rb +8 -7
  77. data/lib/nucleus_api/models/business_details_vo.rb +236 -0
  78. data/lib/nucleus_api/models/card.rb +31 -23
  79. data/lib/nucleus_api/models/card_address.rb +8 -7
  80. data/lib/nucleus_api/models/{category_internal_response_vo.rb → card_balance_vo.rb} +42 -29
  81. data/lib/nucleus_api/models/card_details_vo.rb +284 -0
  82. data/lib/nucleus_api/models/card_program.rb +8 -7
  83. data/lib/nucleus_api/models/cash.rb +8 -7
  84. data/lib/nucleus_api/models/categories_map.rb +8 -7
  85. data/lib/nucleus_api/models/check.rb +8 -7
  86. data/lib/nucleus_api/models/check_images.rb +8 -7
  87. data/lib/nucleus_api/models/client.rb +8 -7
  88. data/lib/nucleus_api/models/client_account_mapping.rb +8 -7
  89. data/lib/nucleus_api/models/client_address.rb +8 -7
  90. data/lib/nucleus_api/models/client_business_card_vo.rb +218 -0
  91. data/lib/nucleus_api/models/{v_account_asset_size.rb → client_business_total_card_balance_vo.rb} +32 -40
  92. data/lib/nucleus_api/models/client_card_vo.rb +244 -0
  93. data/lib/nucleus_api/models/{category_response_vo.rb → client_credentials.rb} +31 -23
  94. data/lib/nucleus_api/models/client_relationship.rb +8 -7
  95. data/lib/nucleus_api/models/client_response.rb +8 -7
  96. data/lib/nucleus_api/models/client_status.rb +8 -12
  97. data/lib/nucleus_api/models/client_view_goal_data.rb +8 -7
  98. data/lib/nucleus_api/models/{customer.rb → contact.rb} +48 -9
  99. data/lib/nucleus_api/models/{customer_address.rb → contact_address.rb} +10 -9
  100. data/lib/nucleus_api/models/country.rb +29 -11
  101. data/lib/nucleus_api/models/currency.rb +8 -7
  102. data/lib/nucleus_api/models/customer_revenue.rb +36 -23
  103. data/lib/nucleus_api/models/date_double_vo.rb +8 -7
  104. data/lib/nucleus_api/models/decision_tree.rb +8 -7
  105. data/lib/nucleus_api/models/decision_tree_co.rb +8 -7
  106. data/lib/nucleus_api/models/decision_tree_result_vo.rb +8 -7
  107. data/lib/nucleus_api/models/document.rb +6 -8
  108. data/lib/nucleus_api/models/employment.rb +8 -7
  109. data/lib/nucleus_api/models/external_account_transfer.rb +8 -7
  110. data/lib/nucleus_api/models/feature.rb +8 -7
  111. data/lib/nucleus_api/models/feature_track.rb +8 -7
  112. data/lib/nucleus_api/models/financial_statement.rb +19 -8
  113. data/lib/nucleus_api/models/funding.rb +21 -8
  114. data/lib/nucleus_api/models/funding_request_map.rb +8 -7
  115. data/lib/nucleus_api/models/{daily_deposit.rb → funding_transaction.rb} +43 -47
  116. data/lib/nucleus_api/models/fx_rate.rb +234 -0
  117. data/lib/nucleus_api/models/fx_rate_view.rb +8 -7
  118. data/lib/nucleus_api/models/goal.rb +8 -7
  119. data/lib/nucleus_api/models/goal_account_mapping.rb +8 -7
  120. data/lib/nucleus_api/models/goal_track.rb +8 -7
  121. data/lib/nucleus_api/models/goal_track_accounts.rb +8 -7
  122. data/lib/nucleus_api/models/household.rb +8 -7
  123. data/lib/nucleus_api/models/institution.rb +256 -0
  124. data/lib/nucleus_api/models/investment.rb +8 -12
  125. data/lib/nucleus_api/models/invoice.rb +44 -23
  126. data/lib/nucleus_api/models/invoice_payment.rb +21 -8
  127. data/lib/nucleus_api/models/json_node.rb +10 -241
  128. data/lib/nucleus_api/models/line_items.rb +8 -7
  129. data/lib/nucleus_api/models/location.rb +8 -7
  130. data/lib/nucleus_api/models/member.rb +8 -7
  131. data/lib/nucleus_api/models/merchant_category_code.rb +27 -11
  132. data/lib/nucleus_api/models/merchants_map.rb +8 -7
  133. data/lib/nucleus_api/models/model.rb +8 -7
  134. data/lib/nucleus_api/models/model_asset_size.rb +8 -7
  135. data/lib/nucleus_api/models/model_comment.rb +8 -7
  136. data/lib/nucleus_api/models/model_holding.rb +8 -7
  137. data/lib/nucleus_api/models/model_holding_vo.rb +8 -7
  138. data/lib/nucleus_api/models/model_transaction.rb +8 -7
  139. data/lib/nucleus_api/models/mx_merchant_res.rb +21 -20
  140. data/lib/nucleus_api/models/node.rb +8 -7
  141. data/lib/nucleus_api/models/node_relationship.rb +8 -7
  142. data/lib/nucleus_api/models/notification.rb +8 -7
  143. data/lib/nucleus_api/models/notification_client.rb +8 -7
  144. data/lib/nucleus_api/models/notification_setting.rb +8 -7
  145. data/lib/nucleus_api/models/order.rb +8 -7
  146. data/lib/nucleus_api/models/order_bulk.rb +8 -7
  147. data/lib/nucleus_api/models/order_reconcile_request.rb +8 -7
  148. data/lib/nucleus_api/models/order_reconcile_return_object.rb +8 -7
  149. data/lib/nucleus_api/models/order_status.rb +8 -7
  150. data/lib/nucleus_api/models/order_track.rb +8 -7
  151. data/lib/nucleus_api/models/order_vo_clone.rb +8 -7
  152. data/lib/nucleus_api/models/overflow.rb +8 -7
  153. data/lib/nucleus_api/models/overflow_bank_link_map.rb +22 -11
  154. data/lib/nucleus_api/models/overflow_settings.rb +8 -7
  155. data/lib/nucleus_api/models/overflow_vo.rb +8 -7
  156. data/lib/nucleus_api/models/ownership.rb +8 -7
  157. data/lib/nucleus_api/models/page_account.rb +8 -7
  158. data/lib/nucleus_api/models/page_account_allocation_mapping.rb +8 -7
  159. data/lib/nucleus_api/models/page_account_permission_vo.rb +8 -7
  160. data/lib/nucleus_api/models/page_account_status.rb +8 -7
  161. data/lib/nucleus_api/models/page_account_type.rb +8 -7
  162. data/lib/nucleus_api/models/page_admin_client.rb +8 -7
  163. data/lib/nucleus_api/models/page_aggregation_account.rb +8 -7
  164. data/lib/nucleus_api/models/page_aggregation_account_balance.rb +8 -7
  165. data/lib/nucleus_api/models/page_aggregation_account_holding.rb +8 -7
  166. data/lib/nucleus_api/models/page_aggregation_account_transaction.rb +8 -7
  167. data/lib/nucleus_api/models/page_allocation.rb +8 -7
  168. data/lib/nucleus_api/models/page_allocation_composition.rb +8 -7
  169. data/lib/nucleus_api/models/page_answer.rb +8 -7
  170. data/lib/nucleus_api/models/page_application.rb +8 -7
  171. data/lib/nucleus_api/models/page_audit_log.rb +8 -7
  172. data/lib/nucleus_api/models/page_bank_link.rb +8 -7
  173. data/lib/nucleus_api/models/page_benchmark.rb +8 -7
  174. data/lib/nucleus_api/models/page_budget.rb +8 -7
  175. data/lib/nucleus_api/models/page_business.rb +8 -7
  176. data/lib/nucleus_api/models/page_card.rb +8 -7
  177. data/lib/nucleus_api/models/page_card_program.rb +8 -7
  178. data/lib/nucleus_api/models/page_client.rb +8 -7
  179. data/lib/nucleus_api/models/page_client_business_card_vo.rb +259 -0
  180. data/lib/nucleus_api/models/page_client_response.rb +8 -7
  181. data/lib/nucleus_api/models/page_client_status.rb +8 -7
  182. data/lib/nucleus_api/models/{page_customer.rb → page_contact.rb} +10 -9
  183. data/lib/nucleus_api/models/page_customer_revenue.rb +8 -7
  184. data/lib/nucleus_api/models/page_decision_tree.rb +8 -7
  185. data/lib/nucleus_api/models/page_document.rb +8 -7
  186. data/lib/nucleus_api/models/page_external_account_transfer.rb +8 -7
  187. data/lib/nucleus_api/models/page_feature.rb +8 -7
  188. data/lib/nucleus_api/models/page_feature_track.rb +8 -7
  189. data/lib/nucleus_api/models/page_financial_statement.rb +8 -7
  190. data/lib/nucleus_api/models/page_funding.rb +8 -7
  191. data/lib/nucleus_api/models/{page_v_account_asset_size.rb → page_funding_transaction.rb} +10 -9
  192. data/lib/nucleus_api/models/page_goal.rb +8 -7
  193. data/lib/nucleus_api/models/page_goal_track.rb +8 -7
  194. data/lib/nucleus_api/models/page_household.rb +8 -7
  195. data/lib/nucleus_api/models/{page_daily_deposit.rb → page_institution.rb} +10 -9
  196. data/lib/nucleus_api/models/page_invoice.rb +8 -7
  197. data/lib/nucleus_api/models/page_invoice_payment.rb +8 -7
  198. data/lib/nucleus_api/models/page_model.rb +8 -7
  199. data/lib/nucleus_api/models/page_model_asset_size.rb +8 -7
  200. data/lib/nucleus_api/models/page_model_comment.rb +8 -7
  201. data/lib/nucleus_api/models/page_model_holding.rb +8 -7
  202. data/lib/nucleus_api/models/page_model_transaction.rb +8 -7
  203. data/lib/nucleus_api/models/page_mx_merchant_res.rb +27 -8
  204. data/lib/nucleus_api/models/page_node.rb +8 -7
  205. data/lib/nucleus_api/models/page_node_relationship.rb +8 -7
  206. data/lib/nucleus_api/models/page_notification.rb +8 -7
  207. data/lib/nucleus_api/models/page_notification_client.rb +8 -7
  208. data/lib/nucleus_api/models/page_notification_setting.rb +8 -7
  209. data/lib/nucleus_api/models/page_order.rb +8 -7
  210. data/lib/nucleus_api/models/page_order_bulk.rb +8 -7
  211. data/lib/nucleus_api/models/page_order_status.rb +8 -7
  212. data/lib/nucleus_api/models/page_order_track.rb +8 -7
  213. data/lib/nucleus_api/models/page_overflow.rb +8 -7
  214. data/lib/nucleus_api/models/page_overflow_settings.rb +8 -7
  215. data/lib/nucleus_api/models/page_portfolio.rb +8 -7
  216. data/lib/nucleus_api/models/page_portfolio_asset_size_log.rb +8 -7
  217. data/lib/nucleus_api/models/page_portfolio_comment.rb +8 -7
  218. data/lib/nucleus_api/models/page_portfolio_goal.rb +8 -7
  219. data/lib/nucleus_api/models/{page_daily_withdrawal.rb → page_portfolio_holding_agg.rb} +10 -9
  220. data/lib/nucleus_api/models/page_portfolio_holding_log.rb +8 -7
  221. data/lib/nucleus_api/models/page_portfolio_transaction.rb +8 -7
  222. data/lib/nucleus_api/models/page_question.rb +8 -7
  223. data/lib/nucleus_api/models/page_questionnaire.rb +8 -7
  224. data/lib/nucleus_api/models/page_reason_code.rb +8 -7
  225. data/lib/nucleus_api/models/page_risk_profile.rb +8 -7
  226. data/lib/nucleus_api/models/page_roundup.rb +8 -7
  227. data/lib/nucleus_api/models/page_roundup_settings.rb +8 -7
  228. data/lib/nucleus_api/models/page_score.rb +8 -7
  229. data/lib/nucleus_api/models/page_security.rb +8 -7
  230. data/lib/nucleus_api/models/page_security_exclusion.rb +8 -7
  231. data/lib/nucleus_api/models/page_security_price.rb +8 -7
  232. data/lib/nucleus_api/models/page_spending_control.rb +8 -7
  233. data/lib/nucleus_api/models/page_stage.rb +8 -7
  234. data/lib/nucleus_api/models/page_transaction_code.rb +8 -7
  235. data/lib/nucleus_api/models/page_webhook.rb +8 -7
  236. data/lib/nucleus_api/models/pageable.rb +227 -0
  237. data/lib/nucleus_api/models/permission_vo.rb +8 -7
  238. data/lib/nucleus_api/models/portfolio.rb +8 -12
  239. data/lib/nucleus_api/models/portfolio_asset_size_log.rb +8 -7
  240. data/lib/nucleus_api/models/portfolio_comment.rb +8 -7
  241. data/lib/nucleus_api/models/portfolio_goal.rb +8 -7
  242. data/lib/nucleus_api/models/portfolio_goal_map.rb +8 -7
  243. data/lib/nucleus_api/models/portfolio_holding_agg.rb +8 -7
  244. data/lib/nucleus_api/models/portfolio_holding_log.rb +8 -7
  245. data/lib/nucleus_api/models/portfolio_transaction.rb +49 -8
  246. data/lib/nucleus_api/models/question.rb +36 -8
  247. data/lib/nucleus_api/models/questionnaire.rb +21 -8
  248. data/lib/nucleus_api/models/reason_code.rb +8 -7
  249. data/lib/nucleus_api/models/risk_profile.rb +8 -7
  250. data/lib/nucleus_api/models/roundup.rb +8 -7
  251. data/lib/nucleus_api/models/roundup_co.rb +8 -7
  252. data/lib/nucleus_api/models/roundup_settings.rb +8 -7
  253. data/lib/nucleus_api/models/score.rb +8 -7
  254. data/lib/nucleus_api/models/securities_composition.rb +8 -7
  255. data/lib/nucleus_api/models/securities_country.rb +8 -7
  256. data/lib/nucleus_api/models/security.rb +8 -7
  257. data/lib/nucleus_api/models/security_composition_vo.rb +8 -7
  258. data/lib/nucleus_api/models/security_country_vo.rb +8 -7
  259. data/lib/nucleus_api/models/security_exclusion.rb +8 -7
  260. data/lib/nucleus_api/models/security_price.rb +8 -7
  261. data/lib/nucleus_api/models/sort.rb +8 -7
  262. data/lib/nucleus_api/models/spending_control.rb +20 -8
  263. data/lib/nucleus_api/models/stage.rb +29 -8
  264. data/lib/nucleus_api/models/stat.rb +8 -7
  265. data/lib/nucleus_api/models/state.rb +8 -7
  266. data/lib/nucleus_api/models/statistic_resource_vo.rb +8 -7
  267. data/lib/nucleus_api/models/token_date_request.rb +8 -7
  268. data/lib/nucleus_api/models/transaction_code.rb +17 -66
  269. data/lib/nucleus_api/models/v_account_vo.rb +8 -7
  270. data/lib/nucleus_api/models/v_client_goal_view_data.rb +8 -7
  271. data/lib/nucleus_api/models/v_portfolio_vo.rb +8 -7
  272. data/lib/nucleus_api/models/webhook.rb +6 -8
  273. data/lib/nucleus_api/version.rb +3 -3
  274. data/nucleus_api.gemspec +2 -2
  275. data/spec/api/account_api_spec.rb +14 -24
  276. data/spec/api/admin_client_api_spec.rb +23 -16
  277. data/spec/api/aggregation_account_api_spec.rb +15 -2
  278. data/spec/api/allocation_api_spec.rb +2 -2
  279. data/spec/api/benchmark_api_spec.rb +5 -5
  280. data/spec/api/budget_api_spec.rb +2 -2
  281. data/spec/api/bulk_api_spec.rb +2 -2
  282. data/spec/api/business_api_spec.rb +12 -6
  283. data/spec/api/card_api_spec.rb +40 -2
  284. data/spec/api/client_api_spec.rb +77 -6
  285. data/spec/api/{customer_api_spec.rb → contact_api_spec.rb} +49 -49
  286. data/spec/api/decision_tree_api_spec.rb +7 -7
  287. data/spec/api/document_api_spec.rb +2 -2
  288. data/spec/api/financial_statement_api_spec.rb +2 -2
  289. data/spec/api/funding_api_spec.rb +43 -110
  290. data/spec/api/goal_api_spec.rb +12 -6
  291. data/spec/api/household_api_spec.rb +12 -6
  292. data/spec/api/invoice_api_spec.rb +3 -3
  293. data/spec/api/model_api_spec.rb +3 -3
  294. data/spec/api/order_api_spec.rb +2 -2
  295. data/spec/api/overflow_api_spec.rb +2 -2
  296. data/spec/api/portfolio_api_spec.rb +18 -2
  297. data/spec/api/questionnaire_api_spec.rb +2 -67
  298. data/spec/api/resource_api_spec.rb +97 -16
  299. data/spec/api/risk_profile_api_spec.rb +2 -2
  300. data/spec/api/roundup_api_spec.rb +2 -2
  301. data/spec/api/score_api_spec.rb +2 -2
  302. data/spec/api/securities_api_spec.rb +2 -2
  303. data/spec/api/spending_control_api_spec.rb +2 -2
  304. data/spec/api/utils_api_spec.rb +432 -2
  305. data/spec/api/webhook_api_spec.rb +2 -2
  306. data/spec/api_client_spec.rb +2 -2
  307. data/spec/configuration_spec.rb +5 -5
  308. data/spec/models/account_allocation_mapping_spec.rb +2 -2
  309. data/spec/models/account_map_spec.rb +2 -2
  310. data/spec/models/account_permission_vo_spec.rb +2 -2
  311. data/spec/models/account_portfolio_rebalance_request_spec.rb +2 -2
  312. data/spec/models/account_spec.rb +5 -5
  313. data/spec/models/account_status_spec.rb +2 -2
  314. data/spec/models/account_type_spec.rb +2 -2
  315. data/spec/models/acl_client_permission_vo_spec.rb +2 -2
  316. data/spec/models/admin_client_spec.rb +14 -2
  317. data/spec/models/aggregation_account_balance_spec.rb +2 -2
  318. data/spec/models/aggregation_account_holding_spec.rb +2 -2
  319. data/spec/models/aggregation_account_spec.rb +80 -2
  320. data/spec/models/aggregation_account_transaction_spec.rb +5 -13
  321. data/spec/models/aggregation_accounts_map_spec.rb +2 -2
  322. data/spec/models/allocation_aggregated_vo_spec.rb +2 -2
  323. data/spec/models/allocation_composition_aggregated_vo_spec.rb +2 -2
  324. data/spec/models/allocation_composition_model_holdings_vo_spec.rb +2 -2
  325. data/spec/models/allocation_composition_spec.rb +2 -2
  326. data/spec/models/allocation_node_map_spec.rb +2 -2
  327. data/spec/models/allocation_spec.rb +2 -2
  328. data/spec/models/answer_map_spec.rb +2 -2
  329. data/spec/models/answer_spec.rb +20 -2
  330. data/spec/models/application_spec.rb +2 -2
  331. data/spec/models/audit_log_spec.rb +2 -2
  332. data/spec/models/available_date_double_vo_spec.rb +2 -2
  333. data/spec/models/balances_spec.rb +65 -0
  334. data/spec/models/bank_credit_spec.rb +14 -2
  335. data/spec/models/bank_link_map_spec.rb +2 -2
  336. data/spec/models/bank_link_spec.rb +20 -8
  337. data/spec/models/benchmark_composition_spec.rb +2 -2
  338. data/spec/models/benchmark_spec.rb +2 -2
  339. data/spec/models/brokers_spec.rb +2 -2
  340. data/spec/models/budget_aggregation_account_spec.rb +2 -2
  341. data/spec/models/budget_object_spec.rb +2 -2
  342. data/spec/models/budget_spec.rb +8 -2
  343. data/spec/models/bulk_transaction_spec.rb +2 -2
  344. data/spec/models/bulk_transaction_vo_spec.rb +2 -2
  345. data/spec/models/business_address_spec.rb +2 -2
  346. data/spec/models/business_details_vo_spec.rb +71 -0
  347. data/spec/models/business_spec.rb +2 -2
  348. data/spec/models/card_address_spec.rb +2 -2
  349. data/spec/models/card_balance_vo_spec.rb +59 -0
  350. data/spec/models/card_details_vo_spec.rb +101 -0
  351. data/spec/models/card_program_spec.rb +2 -2
  352. data/spec/models/card_spec.rb +15 -2
  353. data/spec/models/cash_spec.rb +2 -2
  354. data/spec/models/categories_map_spec.rb +2 -2
  355. data/spec/models/check_images_spec.rb +2 -2
  356. data/spec/models/check_spec.rb +2 -2
  357. data/spec/models/client_account_mapping_spec.rb +2 -2
  358. data/spec/models/client_address_spec.rb +2 -2
  359. data/spec/models/client_business_card_vo_spec.rb +59 -0
  360. data/spec/models/client_business_total_card_balance_vo_spec.rb +53 -0
  361. data/spec/models/client_card_vo_spec.rb +77 -0
  362. data/spec/models/{category_internal_response_vo_spec.rb → client_credentials_spec.rb} +11 -11
  363. data/spec/models/client_relationship_spec.rb +2 -2
  364. data/spec/models/client_response_spec.rb +2 -2
  365. data/spec/models/client_spec.rb +2 -2
  366. data/spec/models/client_status_spec.rb +2 -2
  367. data/spec/models/client_view_goal_data_spec.rb +2 -2
  368. data/spec/models/{customer_address_spec.rb → contact_address_spec.rb} +8 -8
  369. data/spec/models/{customer_spec.rb → contact_spec.rb} +32 -8
  370. data/spec/models/country_spec.rb +8 -2
  371. data/spec/models/currency_spec.rb +2 -2
  372. data/spec/models/customer_revenue_spec.rb +11 -5
  373. data/spec/models/date_double_vo_spec.rb +2 -2
  374. data/spec/models/decision_tree_co_spec.rb +2 -2
  375. data/spec/models/decision_tree_result_vo_spec.rb +2 -2
  376. data/spec/models/decision_tree_spec.rb +2 -2
  377. data/spec/models/document_spec.rb +2 -2
  378. data/spec/models/employment_spec.rb +2 -2
  379. data/spec/models/external_account_transfer_spec.rb +2 -2
  380. data/spec/models/feature_spec.rb +2 -2
  381. data/spec/models/feature_track_spec.rb +2 -2
  382. data/spec/models/financial_statement_spec.rb +8 -2
  383. data/spec/models/funding_request_map_spec.rb +2 -2
  384. data/spec/models/funding_spec.rb +11 -5
  385. data/spec/models/{daily_deposit_spec.rb → funding_transaction_spec.rb} +12 -18
  386. data/spec/models/{v_account_asset_size_spec.rb → fx_rate_spec.rb} +12 -12
  387. data/spec/models/fx_rate_view_spec.rb +2 -2
  388. data/spec/models/goal_account_mapping_spec.rb +2 -2
  389. data/spec/models/goal_spec.rb +2 -2
  390. data/spec/models/goal_track_accounts_spec.rb +2 -2
  391. data/spec/models/goal_track_spec.rb +2 -2
  392. data/spec/models/household_spec.rb +2 -2
  393. data/spec/models/institution_spec.rb +83 -0
  394. data/spec/models/investment_spec.rb +2 -2
  395. data/spec/models/invoice_payment_spec.rb +8 -2
  396. data/spec/models/invoice_spec.rb +17 -5
  397. data/spec/models/json_node_spec.rb +2 -138
  398. data/spec/models/line_items_spec.rb +2 -2
  399. data/spec/models/location_spec.rb +2 -2
  400. data/spec/models/member_spec.rb +2 -2
  401. data/spec/models/merchant_category_code_spec.rb +8 -2
  402. data/spec/models/merchants_map_spec.rb +2 -2
  403. data/spec/models/model_asset_size_spec.rb +2 -2
  404. data/spec/models/model_comment_spec.rb +2 -2
  405. data/spec/models/model_holding_spec.rb +2 -2
  406. data/spec/models/model_holding_vo_spec.rb +2 -2
  407. data/spec/models/model_spec.rb +2 -2
  408. data/spec/models/model_transaction_spec.rb +2 -2
  409. data/spec/models/mx_merchant_res_spec.rb +4 -4
  410. data/spec/models/node_relationship_spec.rb +2 -2
  411. data/spec/models/node_spec.rb +2 -2
  412. data/spec/models/notification_client_spec.rb +2 -2
  413. data/spec/models/notification_setting_spec.rb +2 -2
  414. data/spec/models/notification_spec.rb +2 -2
  415. data/spec/models/order_bulk_spec.rb +2 -2
  416. data/spec/models/order_reconcile_request_spec.rb +2 -2
  417. data/spec/models/order_reconcile_return_object_spec.rb +2 -2
  418. data/spec/models/order_spec.rb +2 -2
  419. data/spec/models/order_status_spec.rb +2 -2
  420. data/spec/models/order_track_spec.rb +2 -2
  421. data/spec/models/order_vo_clone_spec.rb +2 -2
  422. data/spec/models/overflow_bank_link_map_spec.rb +8 -2
  423. data/spec/models/overflow_settings_spec.rb +2 -2
  424. data/spec/models/overflow_spec.rb +2 -2
  425. data/spec/models/overflow_vo_spec.rb +2 -2
  426. data/spec/models/ownership_spec.rb +2 -2
  427. data/spec/models/page_account_allocation_mapping_spec.rb +2 -2
  428. data/spec/models/page_account_permission_vo_spec.rb +2 -2
  429. data/spec/models/page_account_spec.rb +2 -2
  430. data/spec/models/page_account_status_spec.rb +2 -2
  431. data/spec/models/page_account_type_spec.rb +2 -2
  432. data/spec/models/page_admin_client_spec.rb +2 -2
  433. data/spec/models/page_aggregation_account_balance_spec.rb +2 -2
  434. data/spec/models/page_aggregation_account_holding_spec.rb +2 -2
  435. data/spec/models/page_aggregation_account_spec.rb +2 -2
  436. data/spec/models/page_aggregation_account_transaction_spec.rb +2 -2
  437. data/spec/models/page_allocation_composition_spec.rb +2 -2
  438. data/spec/models/page_allocation_spec.rb +2 -2
  439. data/spec/models/page_answer_spec.rb +2 -2
  440. data/spec/models/page_application_spec.rb +2 -2
  441. data/spec/models/page_audit_log_spec.rb +2 -2
  442. data/spec/models/page_bank_link_spec.rb +2 -2
  443. data/spec/models/page_benchmark_spec.rb +2 -2
  444. data/spec/models/page_budget_spec.rb +2 -2
  445. data/spec/models/page_business_spec.rb +2 -2
  446. data/spec/models/page_card_program_spec.rb +2 -2
  447. data/spec/models/page_card_spec.rb +2 -2
  448. data/spec/models/page_client_business_card_vo_spec.rb +89 -0
  449. data/spec/models/page_client_response_spec.rb +2 -2
  450. data/spec/models/page_client_spec.rb +2 -2
  451. data/spec/models/page_client_status_spec.rb +2 -2
  452. data/spec/models/{page_customer_spec.rb → page_contact_spec.rb} +8 -8
  453. data/spec/models/page_customer_revenue_spec.rb +2 -2
  454. data/spec/models/page_decision_tree_spec.rb +2 -2
  455. data/spec/models/page_document_spec.rb +2 -2
  456. data/spec/models/page_external_account_transfer_spec.rb +2 -2
  457. data/spec/models/page_feature_spec.rb +2 -2
  458. data/spec/models/page_feature_track_spec.rb +2 -2
  459. data/spec/models/page_financial_statement_spec.rb +2 -2
  460. data/spec/models/page_funding_spec.rb +2 -2
  461. data/spec/models/{page_v_account_asset_size_spec.rb → page_funding_transaction_spec.rb} +8 -8
  462. data/spec/models/page_goal_spec.rb +2 -2
  463. data/spec/models/page_goal_track_spec.rb +2 -2
  464. data/spec/models/page_household_spec.rb +2 -2
  465. data/spec/models/{page_daily_deposit_spec.rb → page_institution_spec.rb} +8 -8
  466. data/spec/models/page_invoice_payment_spec.rb +2 -2
  467. data/spec/models/page_invoice_spec.rb +2 -2
  468. data/spec/models/page_model_asset_size_spec.rb +2 -2
  469. data/spec/models/page_model_comment_spec.rb +2 -2
  470. data/spec/models/page_model_holding_spec.rb +2 -2
  471. data/spec/models/page_model_spec.rb +2 -2
  472. data/spec/models/page_model_transaction_spec.rb +2 -2
  473. data/spec/models/page_mx_merchant_res_spec.rb +14 -2
  474. data/spec/models/page_node_relationship_spec.rb +2 -2
  475. data/spec/models/page_node_spec.rb +2 -2
  476. data/spec/models/page_notification_client_spec.rb +2 -2
  477. data/spec/models/page_notification_setting_spec.rb +2 -2
  478. data/spec/models/page_notification_spec.rb +2 -2
  479. data/spec/models/page_order_bulk_spec.rb +2 -2
  480. data/spec/models/page_order_spec.rb +2 -2
  481. data/spec/models/page_order_status_spec.rb +2 -2
  482. data/spec/models/page_order_track_spec.rb +2 -2
  483. data/spec/models/page_overflow_settings_spec.rb +2 -2
  484. data/spec/models/page_overflow_spec.rb +2 -2
  485. data/spec/models/page_portfolio_asset_size_log_spec.rb +2 -2
  486. data/spec/models/page_portfolio_comment_spec.rb +2 -2
  487. data/spec/models/page_portfolio_goal_spec.rb +2 -2
  488. data/spec/models/{page_daily_withdrawal_spec.rb → page_portfolio_holding_agg_spec.rb} +8 -8
  489. data/spec/models/page_portfolio_holding_log_spec.rb +2 -2
  490. data/spec/models/page_portfolio_spec.rb +2 -2
  491. data/spec/models/page_portfolio_transaction_spec.rb +2 -2
  492. data/spec/models/page_question_spec.rb +2 -2
  493. data/spec/models/page_questionnaire_spec.rb +2 -2
  494. data/spec/models/page_reason_code_spec.rb +2 -2
  495. data/spec/models/page_risk_profile_spec.rb +2 -2
  496. data/spec/models/page_roundup_settings_spec.rb +2 -2
  497. data/spec/models/page_roundup_spec.rb +2 -2
  498. data/spec/models/page_score_spec.rb +2 -2
  499. data/spec/models/page_security_exclusion_spec.rb +2 -2
  500. data/spec/models/page_security_price_spec.rb +2 -2
  501. data/spec/models/page_security_spec.rb +2 -2
  502. data/spec/models/page_spending_control_spec.rb +2 -2
  503. data/spec/models/page_stage_spec.rb +2 -2
  504. data/spec/models/page_transaction_code_spec.rb +2 -2
  505. data/spec/models/page_webhook_spec.rb +2 -2
  506. data/spec/models/pageable_spec.rb +71 -0
  507. data/spec/models/permission_vo_spec.rb +2 -2
  508. data/spec/models/portfolio_asset_size_log_spec.rb +2 -2
  509. data/spec/models/portfolio_comment_spec.rb +2 -2
  510. data/spec/models/portfolio_goal_map_spec.rb +2 -2
  511. data/spec/models/portfolio_goal_spec.rb +2 -2
  512. data/spec/models/portfolio_holding_agg_spec.rb +2 -2
  513. data/spec/models/portfolio_holding_log_spec.rb +2 -2
  514. data/spec/models/portfolio_spec.rb +2 -2
  515. data/spec/models/portfolio_transaction_spec.rb +26 -2
  516. data/spec/models/question_spec.rb +20 -2
  517. data/spec/models/questionnaire_spec.rb +8 -2
  518. data/spec/models/reason_code_spec.rb +2 -2
  519. data/spec/models/risk_profile_spec.rb +2 -2
  520. data/spec/models/roundup_co_spec.rb +2 -2
  521. data/spec/models/roundup_settings_spec.rb +2 -2
  522. data/spec/models/roundup_spec.rb +2 -2
  523. data/spec/models/score_spec.rb +2 -2
  524. data/spec/models/securities_composition_spec.rb +2 -2
  525. data/spec/models/securities_country_spec.rb +2 -2
  526. data/spec/models/security_composition_vo_spec.rb +2 -2
  527. data/spec/models/security_country_vo_spec.rb +2 -2
  528. data/spec/models/security_exclusion_spec.rb +2 -2
  529. data/spec/models/security_price_spec.rb +2 -2
  530. data/spec/models/security_spec.rb +2 -2
  531. data/spec/models/sort_spec.rb +2 -2
  532. data/spec/models/spending_control_spec.rb +8 -2
  533. data/spec/models/stage_spec.rb +14 -2
  534. data/spec/models/stat_spec.rb +2 -2
  535. data/spec/models/state_spec.rb +2 -2
  536. data/spec/models/statistic_resource_vo_spec.rb +2 -2
  537. data/spec/models/token_date_request_spec.rb +2 -2
  538. data/spec/models/transaction_code_spec.rb +11 -17
  539. data/spec/models/v_account_vo_spec.rb +2 -2
  540. data/spec/models/v_client_goal_view_data_spec.rb +2 -2
  541. data/spec/models/v_portfolio_vo_spec.rb +2 -2
  542. data/spec/models/webhook_spec.rb +2 -2
  543. data/spec/spec_helper.rb +2 -2
  544. metadata +62 -316
  545. data/docs/Account.md +0 -22
  546. data/docs/AccountAllocationMapping.md +0 -17
  547. data/docs/AccountApi.md +0 -1919
  548. data/docs/AccountMap.md +0 -9
  549. data/docs/AccountPermissionVO.md +0 -9
  550. data/docs/AccountPortfolioRebalanceRequest.md +0 -21
  551. data/docs/AccountStatus.md +0 -16
  552. data/docs/AccountType.md +0 -23
  553. data/docs/AclClientPermissionVO.md +0 -10
  554. data/docs/AdminClient.md +0 -18
  555. data/docs/AdminClientApi.md +0 -309
  556. data/docs/AggregationAccount.md +0 -30
  557. data/docs/AggregationAccountApi.md +0 -1702
  558. data/docs/AggregationAccountBalance.md +0 -18
  559. data/docs/AggregationAccountHolding.md +0 -26
  560. data/docs/AggregationAccountTransaction.md +0 -23
  561. data/docs/AggregationAccountsMap.md +0 -9
  562. data/docs/Allocation.md +0 -22
  563. data/docs/AllocationAggregatedVO.md +0 -13
  564. data/docs/AllocationApi.md +0 -872
  565. data/docs/AllocationComposition.md +0 -18
  566. data/docs/AllocationCompositionAggregatedVO.md +0 -19
  567. data/docs/AllocationCompositionModelHoldingsVO.md +0 -22
  568. data/docs/AllocationNodeMap.md +0 -8
  569. data/docs/Answer.md +0 -18
  570. data/docs/AnswerMap.md +0 -8
  571. data/docs/Application.md +0 -15
  572. data/docs/ApplicationApi.md +0 -309
  573. data/docs/AuditLog.md +0 -23
  574. data/docs/AuditLogApi.md +0 -191
  575. data/docs/AvailableDateDoubleVO.md +0 -14
  576. data/docs/BankCredit.md +0 -15
  577. data/docs/BankLink.md +0 -29
  578. data/docs/BankLinkMap.md +0 -9
  579. data/docs/Benchmark.md +0 -17
  580. data/docs/BenchmarkApi.md +0 -375
  581. data/docs/BenchmarkComposition.md +0 -9
  582. data/docs/Brokers.md +0 -9
  583. data/docs/Budget.md +0 -25
  584. data/docs/BudgetAggregationAccount.md +0 -8
  585. data/docs/BudgetApi.md +0 -315
  586. data/docs/BudgetObject.md +0 -10
  587. data/docs/BulkApi.md +0 -249
  588. data/docs/BulkTransaction.md +0 -13
  589. data/docs/BulkTransactionVO.md +0 -12
  590. data/docs/Business.md +0 -32
  591. data/docs/BusinessAddress.md +0 -15
  592. data/docs/BusinessApi.md +0 -523
  593. data/docs/Card.md +0 -35
  594. data/docs/CardAddress.md +0 -14
  595. data/docs/CardApi.md +0 -754
  596. data/docs/CardProgram.md +0 -23
  597. data/docs/Cash.md +0 -10
  598. data/docs/CategoriesMap.md +0 -9
  599. data/docs/CategoryInternalResponseVO.md +0 -10
  600. data/docs/CategoryResponseVO.md +0 -9
  601. data/docs/Check.md +0 -10
  602. data/docs/CheckImages.md +0 -9
  603. data/docs/Client.md +0 -39
  604. data/docs/ClientAccountMapping.md +0 -10
  605. data/docs/ClientAddress.md +0 -15
  606. data/docs/ClientApi.md +0 -1008
  607. data/docs/ClientRelationship.md +0 -10
  608. data/docs/ClientResponse.md +0 -17
  609. data/docs/ClientStatus.md +0 -16
  610. data/docs/ClientViewGoalData.md +0 -21
  611. data/docs/Country.md +0 -12
  612. data/docs/Currency.md +0 -11
  613. data/docs/Customer.md +0 -21
  614. data/docs/CustomerAddress.md +0 -14
  615. data/docs/CustomerApi.md +0 -616
  616. data/docs/CustomerRevenue.md +0 -16
  617. data/docs/DailyDeposit.md +0 -28
  618. data/docs/DailyWithdrawal.md +0 -29
  619. data/docs/DateDoubleVO.md +0 -10
  620. data/docs/DecisionTree.md +0 -17
  621. data/docs/DecisionTreeApi.md +0 -971
  622. data/docs/DecisionTreeCO.md +0 -9
  623. data/docs/DecisionTreeResultVO.md +0 -9
  624. data/docs/Document.md +0 -30
  625. data/docs/DocumentApi.md +0 -309
  626. data/docs/Employment.md +0 -11
  627. data/docs/ExternalAccountTransfer.md +0 -28
  628. data/docs/Feature.md +0 -18
  629. data/docs/FeatureApi.md +0 -610
  630. data/docs/FeatureTrack.md +0 -14
  631. data/docs/FinancialStatement.md +0 -23
  632. data/docs/FinancialStatementApi.md +0 -315
  633. data/docs/Funding.md +0 -37
  634. data/docs/FundingApi.md +0 -1601
  635. data/docs/FundingRequestMap.md +0 -8
  636. data/docs/FxRateView.md +0 -11
  637. data/docs/Goal.md +0 -24
  638. data/docs/GoalAccountMapping.md +0 -11
  639. data/docs/GoalApi.md +0 -841
  640. data/docs/GoalTrack.md +0 -26
  641. data/docs/GoalTrackAccounts.md +0 -8
  642. data/docs/Household.md +0 -18
  643. data/docs/HouseholdApi.md +0 -523
  644. data/docs/Investment.md +0 -16
  645. data/docs/Invoice.md +0 -32
  646. data/docs/InvoiceApi.md +0 -622
  647. data/docs/InvoicePayment.md +0 -15
  648. data/docs/JsonNode.md +0 -29
  649. data/docs/LineItems.md +0 -15
  650. data/docs/Location.md +0 -15
  651. data/docs/MXMerchantRes.md +0 -14
  652. data/docs/Member.md +0 -11
  653. data/docs/MerchantCategoryCode.md +0 -11
  654. data/docs/MerchantsMap.md +0 -9
  655. data/docs/Model.md +0 -29
  656. data/docs/ModelApi.md +0 -1580
  657. data/docs/ModelAssetSize.md +0 -16
  658. data/docs/ModelComment.md +0 -15
  659. data/docs/ModelHolding.md +0 -25
  660. data/docs/ModelHoldingVO.md +0 -11
  661. data/docs/ModelTransaction.md +0 -17
  662. data/docs/Node.md +0 -15
  663. data/docs/NodeRelationship.md +0 -18
  664. data/docs/Notification.md +0 -20
  665. data/docs/NotificationApi.md +0 -911
  666. data/docs/NotificationClient.md +0 -19
  667. data/docs/NotificationSetting.md +0 -19
  668. data/docs/Order.md +0 -27
  669. data/docs/OrderApi.md +0 -1764
  670. data/docs/OrderBulk.md +0 -18
  671. data/docs/OrderReconcileRequest.md +0 -12
  672. data/docs/OrderReconcileReturnObject.md +0 -12
  673. data/docs/OrderStatus.md +0 -14
  674. data/docs/OrderTrack.md +0 -20
  675. data/docs/OrderVoClone.md +0 -20
  676. data/docs/Overflow.md +0 -16
  677. data/docs/OverflowApi.md +0 -492
  678. data/docs/OverflowBankLinkMap.md +0 -9
  679. data/docs/OverflowSettings.md +0 -17
  680. data/docs/OverflowVO.md +0 -10
  681. data/docs/Ownership.md +0 -12
  682. data/docs/PageAccount.md +0 -16
  683. data/docs/PageAccountAllocationMapping.md +0 -16
  684. data/docs/PageAccountPermissionVO.md +0 -16
  685. data/docs/PageAccountStatus.md +0 -16
  686. data/docs/PageAccountType.md +0 -16
  687. data/docs/PageAdminClient.md +0 -16
  688. data/docs/PageAggregationAccount.md +0 -16
  689. data/docs/PageAggregationAccountBalance.md +0 -16
  690. data/docs/PageAggregationAccountHolding.md +0 -16
  691. data/docs/PageAggregationAccountTransaction.md +0 -16
  692. data/docs/PageAllocation.md +0 -16
  693. data/docs/PageAllocationComposition.md +0 -16
  694. data/docs/PageAnswer.md +0 -16
  695. data/docs/PageApplication.md +0 -16
  696. data/docs/PageAuditLog.md +0 -16
  697. data/docs/PageBankLink.md +0 -16
  698. data/docs/PageBenchmark.md +0 -16
  699. data/docs/PageBudget.md +0 -16
  700. data/docs/PageBusiness.md +0 -16
  701. data/docs/PageCard.md +0 -16
  702. data/docs/PageCardProgram.md +0 -16
  703. data/docs/PageClient.md +0 -16
  704. data/docs/PageClientResponse.md +0 -16
  705. data/docs/PageClientStatus.md +0 -16
  706. data/docs/PageCustomer.md +0 -16
  707. data/docs/PageCustomerRevenue.md +0 -16
  708. data/docs/PageDailyDeposit.md +0 -16
  709. data/docs/PageDailyWithdrawal.md +0 -16
  710. data/docs/PageDecisionTree.md +0 -16
  711. data/docs/PageDocument.md +0 -16
  712. data/docs/PageExternalAccountTransfer.md +0 -16
  713. data/docs/PageFeature.md +0 -16
  714. data/docs/PageFeatureTrack.md +0 -16
  715. data/docs/PageFinancialStatement.md +0 -16
  716. data/docs/PageFunding.md +0 -16
  717. data/docs/PageGoal.md +0 -16
  718. data/docs/PageGoalTrack.md +0 -16
  719. data/docs/PageHousehold.md +0 -16
  720. data/docs/PageInvoice.md +0 -16
  721. data/docs/PageInvoicePayment.md +0 -16
  722. data/docs/PageMXMerchantRes.md +0 -16
  723. data/docs/PageModel.md +0 -16
  724. data/docs/PageModelAssetSize.md +0 -16
  725. data/docs/PageModelComment.md +0 -16
  726. data/docs/PageModelHolding.md +0 -16
  727. data/docs/PageModelTransaction.md +0 -16
  728. data/docs/PageNode.md +0 -16
  729. data/docs/PageNodeRelationship.md +0 -16
  730. data/docs/PageNotification.md +0 -16
  731. data/docs/PageNotificationClient.md +0 -16
  732. data/docs/PageNotificationSetting.md +0 -16
  733. data/docs/PageOrder.md +0 -16
  734. data/docs/PageOrderBulk.md +0 -16
  735. data/docs/PageOrderStatus.md +0 -16
  736. data/docs/PageOrderTrack.md +0 -16
  737. data/docs/PageOverflow.md +0 -16
  738. data/docs/PageOverflowSettings.md +0 -16
  739. data/docs/PagePortfolio.md +0 -16
  740. data/docs/PagePortfolioAssetSizeLog.md +0 -16
  741. data/docs/PagePortfolioComment.md +0 -16
  742. data/docs/PagePortfolioGoal.md +0 -16
  743. data/docs/PagePortfolioHoldingLog.md +0 -16
  744. data/docs/PagePortfolioTransaction.md +0 -16
  745. data/docs/PageQuestion.md +0 -16
  746. data/docs/PageQuestionnaire.md +0 -16
  747. data/docs/PageReasonCode.md +0 -16
  748. data/docs/PageRiskProfile.md +0 -16
  749. data/docs/PageRoundup.md +0 -16
  750. data/docs/PageRoundupSettings.md +0 -16
  751. data/docs/PageScore.md +0 -16
  752. data/docs/PageSecurity.md +0 -16
  753. data/docs/PageSecurityExclusion.md +0 -16
  754. data/docs/PageSecurityPrice.md +0 -16
  755. data/docs/PageSpendingControl.md +0 -16
  756. data/docs/PageStage.md +0 -16
  757. data/docs/PageTransactionCode.md +0 -16
  758. data/docs/PageVAccountAssetSize.md +0 -16
  759. data/docs/PageWebhook.md +0 -16
  760. data/docs/PerformanceApi.md +0 -973
  761. data/docs/PermissionVO.md +0 -9
  762. data/docs/Portfolio.md +0 -22
  763. data/docs/PortfolioApi.md +0 -1902
  764. data/docs/PortfolioAssetSizeLog.md +0 -20
  765. data/docs/PortfolioComment.md +0 -16
  766. data/docs/PortfolioGoal.md +0 -14
  767. data/docs/PortfolioGoalMap.md +0 -9
  768. data/docs/PortfolioHoldingAgg.md +0 -14
  769. data/docs/PortfolioHoldingLog.md +0 -21
  770. data/docs/PortfolioTransaction.md +0 -37
  771. data/docs/Question.md +0 -23
  772. data/docs/Questionnaire.md +0 -17
  773. data/docs/QuestionnaireApi.md +0 -1212
  774. data/docs/ReasonCode.md +0 -17
  775. data/docs/ResourceApi.md +0 -534
  776. data/docs/RiskProfile.md +0 -18
  777. data/docs/RiskProfileApi.md +0 -309
  778. data/docs/Roundup.md +0 -15
  779. data/docs/RoundupApi.md +0 -492
  780. data/docs/RoundupCO.md +0 -12
  781. data/docs/RoundupSettings.md +0 -21
  782. data/docs/Score.md +0 -23
  783. data/docs/ScoreApi.md +0 -309
  784. data/docs/SecuritiesApi.md +0 -917
  785. data/docs/SecuritiesComposition.md +0 -11
  786. data/docs/SecuritiesCountry.md +0 -9
  787. data/docs/Security.md +0 -32
  788. data/docs/SecurityCompositionVO.md +0 -21
  789. data/docs/SecurityCountryVO.md +0 -9
  790. data/docs/SecurityExclusion.md +0 -18
  791. data/docs/SecurityPrice.md +0 -20
  792. data/docs/Sort.md +0 -13
  793. data/docs/SpendingControl.md +0 -21
  794. data/docs/SpendingControlApi.md +0 -309
  795. data/docs/Stage.md +0 -22
  796. data/docs/Stat.md +0 -9
  797. data/docs/State.md +0 -10
  798. data/docs/StatisticResourceVO.md +0 -11
  799. data/docs/TokenDateRequest.md +0 -13
  800. data/docs/TransactionCode.md +0 -20
  801. data/docs/UtilsApi.md +0 -911
  802. data/docs/VAccountAssetSize.md +0 -11
  803. data/docs/VAccountVO.md +0 -13
  804. data/docs/VClientGoalViewData.md +0 -13
  805. data/docs/VPortfolioVO.md +0 -11
  806. data/docs/Webhook.md +0 -15
  807. data/docs/WebhookApi.md +0 -309
  808. data/lib/nucleus_api/api/application_api.rb +0 -301
  809. data/lib/nucleus_api/api/audit_log_api.rb +0 -190
  810. data/lib/nucleus_api/api/feature_api.rb +0 -579
  811. data/lib/nucleus_api/api/notification_api.rb +0 -857
  812. data/lib/nucleus_api/api/performance_api.rb +0 -1131
  813. data/lib/nucleus_api/models/daily_withdrawal.rb +0 -405
  814. data/spec/api/application_api_spec.rb +0 -100
  815. data/spec/api/audit_log_api_spec.rb +0 -75
  816. data/spec/api/feature_api_spec.rb +0 -165
  817. data/spec/api/notification_api_spec.rb +0 -230
  818. data/spec/api/performance_api_spec.rb +0 -355
  819. data/spec/models/category_response_vo_spec.rb +0 -47
  820. data/spec/models/daily_withdrawal_spec.rb +0 -167
@@ -1,1131 +0,0 @@
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