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
data/docs/PermissionVO.md DELETED
@@ -1,9 +0,0 @@
1
- # NucleusApi::PermissionVO
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **client_id** | **String** | clientId | [optional]
7
- **permission_type** | **String** | permissionType | [optional]
8
-
9
-
data/docs/Portfolio.md DELETED
@@ -1,22 +0,0 @@
1
- # NucleusApi::Portfolio
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **account_id** | **String** | accountId |
7
- **account_number** | **String** | account_number | [optional]
8
- **create_date** | **DateTime** | | [optional]
9
- **currency_code** | **String** | currency_code | [optional]
10
- **description** | **String** | description | [optional]
11
- **id** | **String** | | [optional]
12
- **is_active** | **BOOLEAN** | is_active | [optional]
13
- **is_subledger** | **BOOLEAN** | is_subledger | [optional]
14
- **metadata** | **Hash<String, String>** | metadata | [optional]
15
- **model_id** | **String** | modelId |
16
- **name** | **String** | name |
17
- **percentage** | **Float** | percentage |
18
- **secondary_id** | **String** | | [optional]
19
- **status** | **String** | status | [optional]
20
- **update_date** | **DateTime** | | [optional]
21
-
22
-
data/docs/PortfolioApi.md DELETED
@@ -1,1902 +0,0 @@
1
- # NucleusApi::PortfolioApi
2
-
3
- All URIs are relative to *https://sandbox.hydrogenplatform.com/nucleus/v1*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_portfolio_asset_size_using_post**](PortfolioApi.md#create_portfolio_asset_size_using_post) | **POST** /portfolio_asset_size | Create a portfolio asset size
8
- [**create_portfolio_comment_using_post**](PortfolioApi.md#create_portfolio_comment_using_post) | **POST** /portfolio_comment | Create a portfolio commentary
9
- [**create_portfolio_goal_using_post**](PortfolioApi.md#create_portfolio_goal_using_post) | **POST** /portfolio_goal | Create an portfolio goal
10
- [**create_portfolio_holding_using_post**](PortfolioApi.md#create_portfolio_holding_using_post) | **POST** /portfolio_holding | Create a portfolio holding
11
- [**create_portfolio_transaction_using_post**](PortfolioApi.md#create_portfolio_transaction_using_post) | **POST** /portfolio_transaction | Create a portfolio transaction
12
- [**create_portfolio_using_post**](PortfolioApi.md#create_portfolio_using_post) | **POST** /portfolio | Create a portfolio
13
- [**delete_portfolio_asset_size_using_delete**](PortfolioApi.md#delete_portfolio_asset_size_using_delete) | **DELETE** /portfolio_asset_size/{portfolio_asset_size_id} | Delete a portfolio asset size
14
- [**delete_portfolio_comment_using_delete**](PortfolioApi.md#delete_portfolio_comment_using_delete) | **DELETE** /portfolio_comment/{portfolio_comment_id} | Delete a portfolio commentary
15
- [**delete_portfolio_goal_using_delete**](PortfolioApi.md#delete_portfolio_goal_using_delete) | **DELETE** /portfolio_goal/{portfolio_goal_id} | Delete an portfolio goal
16
- [**delete_portfolio_holding_using_delete**](PortfolioApi.md#delete_portfolio_holding_using_delete) | **DELETE** /portfolio_holding/{portfolio_holding_id} | Delete a portfolio holding
17
- [**delete_portfolio_transaction_using_delete**](PortfolioApi.md#delete_portfolio_transaction_using_delete) | **DELETE** /portfolio_transaction/{portfolio_transaction_id} | Delete a portfolio transaction
18
- [**delete_portfolio_using_delete**](PortfolioApi.md#delete_portfolio_using_delete) | **DELETE** /portfolio/{portfolio_id} | Delete a portfolio
19
- [**get_portfolio_aggregated_data_using_get**](PortfolioApi.md#get_portfolio_aggregated_data_using_get) | **GET** /portfolio/{portfolio_id}/aggregate_data | Retrieve an portfolio aggregate data
20
- [**get_portfolio_all_using_get**](PortfolioApi.md#get_portfolio_all_using_get) | **GET** /portfolio | List all portfolios
21
- [**get_portfolio_asset_size_all_using_get**](PortfolioApi.md#get_portfolio_asset_size_all_using_get) | **GET** /portfolio_asset_size | Retrieve a portfolio asset size
22
- [**get_portfolio_asset_size_using_get**](PortfolioApi.md#get_portfolio_asset_size_using_get) | **GET** /portfolio_asset_size/{portfolio_asset_size_id} | Retrieve a portfolio asset size
23
- [**get_portfolio_comment_all_using_get**](PortfolioApi.md#get_portfolio_comment_all_using_get) | **GET** /portfolio_comment | List all portfolio commentary
24
- [**get_portfolio_comment_using_get**](PortfolioApi.md#get_portfolio_comment_using_get) | **GET** /portfolio_comment/{portfolio_comment_id} | Retrieve a portfolio commentary
25
- [**get_portfolio_goal_all_using_get**](PortfolioApi.md#get_portfolio_goal_all_using_get) | **GET** /portfolio_goal | List all portfolio goals
26
- [**get_portfolio_goal_using_get**](PortfolioApi.md#get_portfolio_goal_using_get) | **GET** /portfolio_goal/{portfolio_goal_id} | Retrieve an portfolio goal
27
- [**get_portfolio_holding_all_using_get**](PortfolioApi.md#get_portfolio_holding_all_using_get) | **GET** /portfolio_holding | List all portfolio holdings
28
- [**get_portfolio_holding_using_get**](PortfolioApi.md#get_portfolio_holding_using_get) | **GET** /portfolio_holding/{portfolio_holding_id} | Retrieve a portfolio holding
29
- [**get_portfolio_transaction_all_using_get**](PortfolioApi.md#get_portfolio_transaction_all_using_get) | **GET** /portfolio_transaction | List all portfolio transactions
30
- [**get_portfolio_transaction_using_get**](PortfolioApi.md#get_portfolio_transaction_using_get) | **GET** /portfolio_transaction/{portfolio_transaction_id} | Retrieve a portfolio transaction
31
- [**get_portfolio_using_get**](PortfolioApi.md#get_portfolio_using_get) | **GET** /portfolio/{portfolio_id} | Retrieve a portfolio
32
- [**update_portfolio_asset_size_using_put**](PortfolioApi.md#update_portfolio_asset_size_using_put) | **PUT** /portfolio_asset_size/{portfolio_asset_size_id} | Update a portfolio asset size
33
- [**update_portfolio_comment_using_put**](PortfolioApi.md#update_portfolio_comment_using_put) | **PUT** /portfolio_comment/{portfolio_comment_id} | Update a portfolio comment
34
- [**update_portfolio_goal_using_put**](PortfolioApi.md#update_portfolio_goal_using_put) | **PUT** /portfolio_goal/{portfolio_goal_id} | Update an portfolio goal
35
- [**update_portfolio_holding_using_put**](PortfolioApi.md#update_portfolio_holding_using_put) | **PUT** /portfolio_holding/{portfolio_holding_id} | Update a portfolio holding
36
- [**update_portfolio_transaction_using_put**](PortfolioApi.md#update_portfolio_transaction_using_put) | **PUT** /portfolio_transaction/{portfolio_transaction_id} | Update a portfolio transaction
37
- [**update_portfolio_using_put**](PortfolioApi.md#update_portfolio_using_put) | **PUT** /portfolio/{portfolio_id} | Update a portfolio
38
-
39
-
40
- # **create_portfolio_asset_size_using_post**
41
- > PortfolioAssetSizeLog create_portfolio_asset_size_using_post(portfolio_asset_size_log_request)
42
-
43
- Create a portfolio asset size
44
-
45
- Create a new asset size record for a portfolio.
46
-
47
- ### Example
48
- ```ruby
49
- # load the gem
50
- require 'nucleus_api'
51
- # Setup authorization
52
- NucleusApi.configure do |config|
53
- # Use one of the below method to generate oauth token
54
- # Creating a token for grant_type=client_credentials
55
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
56
- # Creating a token for grant_type=password
57
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
58
- # Creating a token using client token
59
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
60
- end
61
-
62
- api_instance = NucleusApi::PortfolioApi.new
63
-
64
- portfolio_asset_size_log_request = NucleusApi::PortfolioAssetSizeLog.new # PortfolioAssetSizeLog | portfolioAssetSizeLogRequest
65
-
66
-
67
- begin
68
- #Create a portfolio asset size
69
- result = api_instance.create_portfolio_asset_size_using_post(portfolio_asset_size_log_request)
70
- p result
71
- rescue NucleusApi::ApiError => e
72
- puts "Exception when calling PortfolioApi->create_portfolio_asset_size_using_post: #{e}"
73
- end
74
- ```
75
-
76
- ### Parameters
77
-
78
- Name | Type | Description | Notes
79
- ------------- | ------------- | ------------- | -------------
80
- **portfolio_asset_size_log_request** | [**PortfolioAssetSizeLog**](PortfolioAssetSizeLog.md)| portfolioAssetSizeLogRequest |
81
-
82
- ### Return type
83
-
84
- [**PortfolioAssetSizeLog**](PortfolioAssetSizeLog.md)
85
-
86
- ### Authorization
87
-
88
- [oauth2](../README.md#oauth2)
89
-
90
- ### HTTP request headers
91
-
92
- - **Content-Type**: application/json
93
- - **Accept**: */*
94
-
95
-
96
-
97
- # **create_portfolio_comment_using_post**
98
- > PortfolioComment create_portfolio_comment_using_post(portfolio_comment)
99
-
100
- Create a portfolio commentary
101
-
102
- Create a new comment for a portfolio defined for your firm.
103
-
104
- ### Example
105
- ```ruby
106
- # load the gem
107
- require 'nucleus_api'
108
- # Setup authorization
109
- NucleusApi.configure do |config|
110
- # Use one of the below method to generate oauth token
111
- # Creating a token for grant_type=client_credentials
112
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
113
- # Creating a token for grant_type=password
114
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
115
- # Creating a token using client token
116
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
117
- end
118
-
119
- api_instance = NucleusApi::PortfolioApi.new
120
-
121
- portfolio_comment = NucleusApi::PortfolioComment.new # PortfolioComment | portfolioComment
122
-
123
-
124
- begin
125
- #Create a portfolio commentary
126
- result = api_instance.create_portfolio_comment_using_post(portfolio_comment)
127
- p result
128
- rescue NucleusApi::ApiError => e
129
- puts "Exception when calling PortfolioApi->create_portfolio_comment_using_post: #{e}"
130
- end
131
- ```
132
-
133
- ### Parameters
134
-
135
- Name | Type | Description | Notes
136
- ------------- | ------------- | ------------- | -------------
137
- **portfolio_comment** | [**PortfolioComment**](PortfolioComment.md)| portfolioComment |
138
-
139
- ### Return type
140
-
141
- [**PortfolioComment**](PortfolioComment.md)
142
-
143
- ### Authorization
144
-
145
- [oauth2](../README.md#oauth2)
146
-
147
- ### HTTP request headers
148
-
149
- - **Content-Type**: application/json
150
- - **Accept**: */*
151
-
152
-
153
-
154
- # **create_portfolio_goal_using_post**
155
- > PortfolioGoal create_portfolio_goal_using_post(portfolio_goal)
156
-
157
- Create an portfolio goal
158
-
159
- Create an portfolio goal.
160
-
161
- ### Example
162
- ```ruby
163
- # load the gem
164
- require 'nucleus_api'
165
- # Setup authorization
166
- NucleusApi.configure do |config|
167
- # Use one of the below method to generate oauth token
168
- # Creating a token for grant_type=client_credentials
169
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
170
- # Creating a token for grant_type=password
171
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
172
- # Creating a token using client token
173
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
174
- end
175
-
176
- api_instance = NucleusApi::PortfolioApi.new
177
-
178
- portfolio_goal = NucleusApi::PortfolioGoal.new # PortfolioGoal | portfolioGoal
179
-
180
-
181
- begin
182
- #Create an portfolio goal
183
- result = api_instance.create_portfolio_goal_using_post(portfolio_goal)
184
- p result
185
- rescue NucleusApi::ApiError => e
186
- puts "Exception when calling PortfolioApi->create_portfolio_goal_using_post: #{e}"
187
- end
188
- ```
189
-
190
- ### Parameters
191
-
192
- Name | Type | Description | Notes
193
- ------------- | ------------- | ------------- | -------------
194
- **portfolio_goal** | [**PortfolioGoal**](PortfolioGoal.md)| portfolioGoal |
195
-
196
- ### Return type
197
-
198
- [**PortfolioGoal**](PortfolioGoal.md)
199
-
200
- ### Authorization
201
-
202
- [oauth2](../README.md#oauth2)
203
-
204
- ### HTTP request headers
205
-
206
- - **Content-Type**: application/json
207
- - **Accept**: */*
208
-
209
-
210
-
211
- # **create_portfolio_holding_using_post**
212
- > PortfolioHoldingLog create_portfolio_holding_using_post(portfolio_holdin_log_request)
213
-
214
- Create a portfolio holding
215
-
216
- Create a new holding record for a portfolio.
217
-
218
- ### Example
219
- ```ruby
220
- # load the gem
221
- require 'nucleus_api'
222
- # Setup authorization
223
- NucleusApi.configure do |config|
224
- # Use one of the below method to generate oauth token
225
- # Creating a token for grant_type=client_credentials
226
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
227
- # Creating a token for grant_type=password
228
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
229
- # Creating a token using client token
230
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
231
- end
232
-
233
- api_instance = NucleusApi::PortfolioApi.new
234
-
235
- portfolio_holdin_log_request = NucleusApi::PortfolioHoldingLog.new # PortfolioHoldingLog | portfolioHoldinLogRequest
236
-
237
-
238
- begin
239
- #Create a portfolio holding
240
- result = api_instance.create_portfolio_holding_using_post(portfolio_holdin_log_request)
241
- p result
242
- rescue NucleusApi::ApiError => e
243
- puts "Exception when calling PortfolioApi->create_portfolio_holding_using_post: #{e}"
244
- end
245
- ```
246
-
247
- ### Parameters
248
-
249
- Name | Type | Description | Notes
250
- ------------- | ------------- | ------------- | -------------
251
- **portfolio_holdin_log_request** | [**PortfolioHoldingLog**](PortfolioHoldingLog.md)| portfolioHoldinLogRequest |
252
-
253
- ### Return type
254
-
255
- [**PortfolioHoldingLog**](PortfolioHoldingLog.md)
256
-
257
- ### Authorization
258
-
259
- [oauth2](../README.md#oauth2)
260
-
261
- ### HTTP request headers
262
-
263
- - **Content-Type**: application/json
264
- - **Accept**: */*
265
-
266
-
267
-
268
- # **create_portfolio_transaction_using_post**
269
- > PortfolioTransaction create_portfolio_transaction_using_post(portfolio_transaction_request)
270
-
271
- Create a portfolio transaction
272
-
273
- Create a new transaction record for a portfolio.
274
-
275
- ### Example
276
- ```ruby
277
- # load the gem
278
- require 'nucleus_api'
279
- # Setup authorization
280
- NucleusApi.configure do |config|
281
- # Use one of the below method to generate oauth token
282
- # Creating a token for grant_type=client_credentials
283
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
284
- # Creating a token for grant_type=password
285
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
286
- # Creating a token using client token
287
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
288
- end
289
-
290
- api_instance = NucleusApi::PortfolioApi.new
291
-
292
- portfolio_transaction_request = NucleusApi::PortfolioTransaction.new # PortfolioTransaction | portfolioTransactionRequest
293
-
294
-
295
- begin
296
- #Create a portfolio transaction
297
- result = api_instance.create_portfolio_transaction_using_post(portfolio_transaction_request)
298
- p result
299
- rescue NucleusApi::ApiError => e
300
- puts "Exception when calling PortfolioApi->create_portfolio_transaction_using_post: #{e}"
301
- end
302
- ```
303
-
304
- ### Parameters
305
-
306
- Name | Type | Description | Notes
307
- ------------- | ------------- | ------------- | -------------
308
- **portfolio_transaction_request** | [**PortfolioTransaction**](PortfolioTransaction.md)| portfolioTransactionRequest |
309
-
310
- ### Return type
311
-
312
- [**PortfolioTransaction**](PortfolioTransaction.md)
313
-
314
- ### Authorization
315
-
316
- [oauth2](../README.md#oauth2)
317
-
318
- ### HTTP request headers
319
-
320
- - **Content-Type**: application/json
321
- - **Accept**: */*
322
-
323
-
324
-
325
- # **create_portfolio_using_post**
326
- > Portfolio create_portfolio_using_post(portfolio_request)
327
-
328
- Create a portfolio
329
-
330
- Create a new portfolio for an account.
331
-
332
- ### Example
333
- ```ruby
334
- # load the gem
335
- require 'nucleus_api'
336
- # Setup authorization
337
- NucleusApi.configure do |config|
338
- # Use one of the below method to generate oauth token
339
- # Creating a token for grant_type=client_credentials
340
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
341
- # Creating a token for grant_type=password
342
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
343
- # Creating a token using client token
344
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
345
- end
346
-
347
- api_instance = NucleusApi::PortfolioApi.new
348
-
349
- portfolio_request = NucleusApi::Portfolio.new # Portfolio | portfolioRequest
350
-
351
-
352
- begin
353
- #Create a portfolio
354
- result = api_instance.create_portfolio_using_post(portfolio_request)
355
- p result
356
- rescue NucleusApi::ApiError => e
357
- puts "Exception when calling PortfolioApi->create_portfolio_using_post: #{e}"
358
- end
359
- ```
360
-
361
- ### Parameters
362
-
363
- Name | Type | Description | Notes
364
- ------------- | ------------- | ------------- | -------------
365
- **portfolio_request** | [**Portfolio**](Portfolio.md)| portfolioRequest |
366
-
367
- ### Return type
368
-
369
- [**Portfolio**](Portfolio.md)
370
-
371
- ### Authorization
372
-
373
- [oauth2](../README.md#oauth2)
374
-
375
- ### HTTP request headers
376
-
377
- - **Content-Type**: application/json
378
- - **Accept**: */*
379
-
380
-
381
-
382
- # **delete_portfolio_asset_size_using_delete**
383
- > delete_portfolio_asset_size_using_delete(portfolio_asset_size_id)
384
-
385
- Delete a portfolio asset size
386
-
387
- Permanently delete a portfolio asset size record for a portfolio.
388
-
389
- ### Example
390
- ```ruby
391
- # load the gem
392
- require 'nucleus_api'
393
- # Setup authorization
394
- NucleusApi.configure do |config|
395
- # Use one of the below method to generate oauth token
396
- # Creating a token for grant_type=client_credentials
397
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
398
- # Creating a token for grant_type=password
399
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
400
- # Creating a token using client token
401
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
402
- end
403
-
404
- api_instance = NucleusApi::PortfolioApi.new
405
-
406
- portfolio_asset_size_id = 'portfolio_asset_size_id_example' # String | UUID portfolio_asset_size_id
407
-
408
-
409
- begin
410
- #Delete a portfolio asset size
411
- api_instance.delete_portfolio_asset_size_using_delete(portfolio_asset_size_id)
412
- rescue NucleusApi::ApiError => e
413
- puts "Exception when calling PortfolioApi->delete_portfolio_asset_size_using_delete: #{e}"
414
- end
415
- ```
416
-
417
- ### Parameters
418
-
419
- Name | Type | Description | Notes
420
- ------------- | ------------- | ------------- | -------------
421
- **portfolio_asset_size_id** | [**String**](.md)| UUID portfolio_asset_size_id |
422
-
423
- ### Return type
424
-
425
- nil (empty response body)
426
-
427
- ### Authorization
428
-
429
- [oauth2](../README.md#oauth2)
430
-
431
- ### HTTP request headers
432
-
433
- - **Content-Type**: Not defined
434
- - **Accept**: */*
435
-
436
-
437
-
438
- # **delete_portfolio_comment_using_delete**
439
- > delete_portfolio_comment_using_delete(portfolio_comment_id)
440
-
441
- Delete a portfolio commentary
442
-
443
- Permanently delete a portfolio comment for a portfolio.
444
-
445
- ### Example
446
- ```ruby
447
- # load the gem
448
- require 'nucleus_api'
449
- # Setup authorization
450
- NucleusApi.configure do |config|
451
- # Use one of the below method to generate oauth token
452
- # Creating a token for grant_type=client_credentials
453
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
454
- # Creating a token for grant_type=password
455
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
456
- # Creating a token using client token
457
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
458
- end
459
-
460
- api_instance = NucleusApi::PortfolioApi.new
461
-
462
- portfolio_comment_id = 'portfolio_comment_id_example' # String | UUID portfolio_comment_id
463
-
464
-
465
- begin
466
- #Delete a portfolio commentary
467
- api_instance.delete_portfolio_comment_using_delete(portfolio_comment_id)
468
- rescue NucleusApi::ApiError => e
469
- puts "Exception when calling PortfolioApi->delete_portfolio_comment_using_delete: #{e}"
470
- end
471
- ```
472
-
473
- ### Parameters
474
-
475
- Name | Type | Description | Notes
476
- ------------- | ------------- | ------------- | -------------
477
- **portfolio_comment_id** | [**String**](.md)| UUID portfolio_comment_id |
478
-
479
- ### Return type
480
-
481
- nil (empty response body)
482
-
483
- ### Authorization
484
-
485
- [oauth2](../README.md#oauth2)
486
-
487
- ### HTTP request headers
488
-
489
- - **Content-Type**: Not defined
490
- - **Accept**: */*
491
-
492
-
493
-
494
- # **delete_portfolio_goal_using_delete**
495
- > delete_portfolio_goal_using_delete(portfolio_goal_id)
496
-
497
- Delete an portfolio goal
498
-
499
- Permanently delete an portfolio-goal mapping.
500
-
501
- ### Example
502
- ```ruby
503
- # load the gem
504
- require 'nucleus_api'
505
- # Setup authorization
506
- NucleusApi.configure do |config|
507
- # Use one of the below method to generate oauth token
508
- # Creating a token for grant_type=client_credentials
509
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
510
- # Creating a token for grant_type=password
511
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
512
- # Creating a token using client token
513
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
514
- end
515
-
516
- api_instance = NucleusApi::PortfolioApi.new
517
-
518
- portfolio_goal_id = 'portfolio_goal_id_example' # String | UUID portfolio_goal_id
519
-
520
-
521
- begin
522
- #Delete an portfolio goal
523
- api_instance.delete_portfolio_goal_using_delete(portfolio_goal_id)
524
- rescue NucleusApi::ApiError => e
525
- puts "Exception when calling PortfolioApi->delete_portfolio_goal_using_delete: #{e}"
526
- end
527
- ```
528
-
529
- ### Parameters
530
-
531
- Name | Type | Description | Notes
532
- ------------- | ------------- | ------------- | -------------
533
- **portfolio_goal_id** | [**String**](.md)| UUID portfolio_goal_id |
534
-
535
- ### Return type
536
-
537
- nil (empty response body)
538
-
539
- ### Authorization
540
-
541
- [oauth2](../README.md#oauth2)
542
-
543
- ### HTTP request headers
544
-
545
- - **Content-Type**: Not defined
546
- - **Accept**: */*
547
-
548
-
549
-
550
- # **delete_portfolio_holding_using_delete**
551
- > delete_portfolio_holding_using_delete(portfolio_holding_id)
552
-
553
- Delete a portfolio holding
554
-
555
- Permanently delete a portfolio holding record for a portfolio.
556
-
557
- ### Example
558
- ```ruby
559
- # load the gem
560
- require 'nucleus_api'
561
- # Setup authorization
562
- NucleusApi.configure do |config|
563
- # Use one of the below method to generate oauth token
564
- # Creating a token for grant_type=client_credentials
565
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
566
- # Creating a token for grant_type=password
567
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
568
- # Creating a token using client token
569
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
570
- end
571
-
572
- api_instance = NucleusApi::PortfolioApi.new
573
-
574
- portfolio_holding_id = 'portfolio_holding_id_example' # String | UUID portfolio_holding_id
575
-
576
-
577
- begin
578
- #Delete a portfolio holding
579
- api_instance.delete_portfolio_holding_using_delete(portfolio_holding_id)
580
- rescue NucleusApi::ApiError => e
581
- puts "Exception when calling PortfolioApi->delete_portfolio_holding_using_delete: #{e}"
582
- end
583
- ```
584
-
585
- ### Parameters
586
-
587
- Name | Type | Description | Notes
588
- ------------- | ------------- | ------------- | -------------
589
- **portfolio_holding_id** | [**String**](.md)| UUID portfolio_holding_id |
590
-
591
- ### Return type
592
-
593
- nil (empty response body)
594
-
595
- ### Authorization
596
-
597
- [oauth2](../README.md#oauth2)
598
-
599
- ### HTTP request headers
600
-
601
- - **Content-Type**: Not defined
602
- - **Accept**: */*
603
-
604
-
605
-
606
- # **delete_portfolio_transaction_using_delete**
607
- > delete_portfolio_transaction_using_delete(portfolio_transaction_id)
608
-
609
- Delete a portfolio transaction
610
-
611
- Permanently delete a portfolio transaction record for a portfolio.
612
-
613
- ### Example
614
- ```ruby
615
- # load the gem
616
- require 'nucleus_api'
617
- # Setup authorization
618
- NucleusApi.configure do |config|
619
- # Use one of the below method to generate oauth token
620
- # Creating a token for grant_type=client_credentials
621
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
622
- # Creating a token for grant_type=password
623
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
624
- # Creating a token using client token
625
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
626
- end
627
-
628
- api_instance = NucleusApi::PortfolioApi.new
629
-
630
- portfolio_transaction_id = 'portfolio_transaction_id_example' # String | UUID portfolio_transaction_id
631
-
632
-
633
- begin
634
- #Delete a portfolio transaction
635
- api_instance.delete_portfolio_transaction_using_delete(portfolio_transaction_id)
636
- rescue NucleusApi::ApiError => e
637
- puts "Exception when calling PortfolioApi->delete_portfolio_transaction_using_delete: #{e}"
638
- end
639
- ```
640
-
641
- ### Parameters
642
-
643
- Name | Type | Description | Notes
644
- ------------- | ------------- | ------------- | -------------
645
- **portfolio_transaction_id** | [**String**](.md)| UUID portfolio_transaction_id |
646
-
647
- ### Return type
648
-
649
- nil (empty response body)
650
-
651
- ### Authorization
652
-
653
- [oauth2](../README.md#oauth2)
654
-
655
- ### HTTP request headers
656
-
657
- - **Content-Type**: Not defined
658
- - **Accept**: */*
659
-
660
-
661
-
662
- # **delete_portfolio_using_delete**
663
- > delete_portfolio_using_delete(portfolio_id)
664
-
665
- Delete a portfolio
666
-
667
- Permanently delete a portfolio for an account.
668
-
669
- ### Example
670
- ```ruby
671
- # load the gem
672
- require 'nucleus_api'
673
- # Setup authorization
674
- NucleusApi.configure do |config|
675
- # Use one of the below method to generate oauth token
676
- # Creating a token for grant_type=client_credentials
677
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
678
- # Creating a token for grant_type=password
679
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
680
- # Creating a token using client token
681
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
682
- end
683
-
684
- api_instance = NucleusApi::PortfolioApi.new
685
-
686
- portfolio_id = 'portfolio_id_example' # String | UUID portfolio_id
687
-
688
-
689
- begin
690
- #Delete a portfolio
691
- api_instance.delete_portfolio_using_delete(portfolio_id)
692
- rescue NucleusApi::ApiError => e
693
- puts "Exception when calling PortfolioApi->delete_portfolio_using_delete: #{e}"
694
- end
695
- ```
696
-
697
- ### Parameters
698
-
699
- Name | Type | Description | Notes
700
- ------------- | ------------- | ------------- | -------------
701
- **portfolio_id** | [**String**](.md)| UUID portfolio_id |
702
-
703
- ### Return type
704
-
705
- nil (empty response body)
706
-
707
- ### Authorization
708
-
709
- [oauth2](../README.md#oauth2)
710
-
711
- ### HTTP request headers
712
-
713
- - **Content-Type**: Not defined
714
- - **Accept**: */*
715
-
716
-
717
-
718
- # **get_portfolio_aggregated_data_using_get**
719
- > Object get_portfolio_aggregated_data_using_get(portfolio_id, opts)
720
-
721
- Retrieve an portfolio aggregate data
722
-
723
- Retrieve the information for a securities associated with a portfolio.
724
-
725
- ### Example
726
- ```ruby
727
- # load the gem
728
- require 'nucleus_api'
729
- # Setup authorization
730
- NucleusApi.configure do |config|
731
- # Use one of the below method to generate oauth token
732
- # Creating a token for grant_type=client_credentials
733
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
734
- # Creating a token for grant_type=password
735
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
736
- # Creating a token using client token
737
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
738
- end
739
-
740
- api_instance = NucleusApi::PortfolioApi.new
741
-
742
- portfolio_id = 'portfolio_id_example' # String | Portfolio Id
743
-
744
- opts = {
745
- show_asset_class: true, # BOOLEAN | true or false
746
- show_category: true, # BOOLEAN | true or false
747
- show_industry: true, # BOOLEAN | true or false
748
- show_sector: true, # BOOLEAN | true or false
749
- show_security_class: true # BOOLEAN | true or false
750
- }
751
-
752
- begin
753
- #Retrieve an portfolio aggregate data
754
- result = api_instance.get_portfolio_aggregated_data_using_get(portfolio_id, opts)
755
- p result
756
- rescue NucleusApi::ApiError => e
757
- puts "Exception when calling PortfolioApi->get_portfolio_aggregated_data_using_get: #{e}"
758
- end
759
- ```
760
-
761
- ### Parameters
762
-
763
- Name | Type | Description | Notes
764
- ------------- | ------------- | ------------- | -------------
765
- **portfolio_id** | [**String**](.md)| Portfolio Id |
766
- **show_asset_class** | **BOOLEAN**| true or false | [optional] [default to true]
767
- **show_category** | **BOOLEAN**| true or false | [optional] [default to true]
768
- **show_industry** | **BOOLEAN**| true or false | [optional] [default to true]
769
- **show_sector** | **BOOLEAN**| true or false | [optional] [default to true]
770
- **show_security_class** | **BOOLEAN**| true or false | [optional] [default to true]
771
-
772
- ### Return type
773
-
774
- **Object**
775
-
776
- ### Authorization
777
-
778
- [oauth2](../README.md#oauth2)
779
-
780
- ### HTTP request headers
781
-
782
- - **Content-Type**: Not defined
783
- - **Accept**: */*
784
-
785
-
786
-
787
- # **get_portfolio_all_using_get**
788
- > PagePortfolio get_portfolio_all_using_get(opts)
789
-
790
- List all portfolios
791
-
792
- Get the information for all portfolios assigned to all of your firm’s accounts.
793
-
794
- ### Example
795
- ```ruby
796
- # load the gem
797
- require 'nucleus_api'
798
- # Setup authorization
799
- NucleusApi.configure do |config|
800
- # Use one of the below method to generate oauth token
801
- # Creating a token for grant_type=client_credentials
802
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
803
- # Creating a token for grant_type=password
804
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
805
- # Creating a token using client token
806
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
807
- end
808
-
809
- api_instance = NucleusApi::PortfolioApi.new
810
-
811
- opts = {
812
- ascending: false, # BOOLEAN | ascending
813
- filter: 'filter_example', # String | filter
814
- order_by: 'update_date', # String | order_by
815
- page: 0, # Integer | page
816
- size: 25 # Integer | size
817
- }
818
-
819
- begin
820
- #List all portfolios
821
- result = api_instance.get_portfolio_all_using_get(opts)
822
- p result
823
- rescue NucleusApi::ApiError => e
824
- puts "Exception when calling PortfolioApi->get_portfolio_all_using_get: #{e}"
825
- end
826
- ```
827
-
828
- ### Parameters
829
-
830
- Name | Type | Description | Notes
831
- ------------- | ------------- | ------------- | -------------
832
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
833
- **filter** | **String**| filter | [optional]
834
- **order_by** | **String**| order_by | [optional] [default to update_date]
835
- **page** | **Integer**| page | [optional] [default to 0]
836
- **size** | **Integer**| size | [optional] [default to 25]
837
-
838
- ### Return type
839
-
840
- [**PagePortfolio**](PagePortfolio.md)
841
-
842
- ### Authorization
843
-
844
- [oauth2](../README.md#oauth2)
845
-
846
- ### HTTP request headers
847
-
848
- - **Content-Type**: Not defined
849
- - **Accept**: */*
850
-
851
-
852
-
853
- # **get_portfolio_asset_size_all_using_get**
854
- > PagePortfolioAssetSizeLog get_portfolio_asset_size_all_using_get(opts)
855
-
856
- Retrieve a portfolio asset size
857
-
858
- Retrieve the information for a portfolio asset size record for a portfolio.
859
-
860
- ### Example
861
- ```ruby
862
- # load the gem
863
- require 'nucleus_api'
864
- # Setup authorization
865
- NucleusApi.configure do |config|
866
- # Use one of the below method to generate oauth token
867
- # Creating a token for grant_type=client_credentials
868
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
869
- # Creating a token for grant_type=password
870
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
871
- # Creating a token using client token
872
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
873
- end
874
-
875
- api_instance = NucleusApi::PortfolioApi.new
876
-
877
- opts = {
878
- ascending: false, # BOOLEAN | ascending
879
- currency_conversion: 'currency_conversion_example', # String | currency_conversion
880
- filter: 'filter_example', # String | filter
881
- order_by: 'update_date', # String | order_by
882
- page: 0, # Integer | page
883
- size: 25 # Integer | size
884
- }
885
-
886
- begin
887
- #Retrieve a portfolio asset size
888
- result = api_instance.get_portfolio_asset_size_all_using_get(opts)
889
- p result
890
- rescue NucleusApi::ApiError => e
891
- puts "Exception when calling PortfolioApi->get_portfolio_asset_size_all_using_get: #{e}"
892
- end
893
- ```
894
-
895
- ### Parameters
896
-
897
- Name | Type | Description | Notes
898
- ------------- | ------------- | ------------- | -------------
899
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
900
- **currency_conversion** | **String**| currency_conversion | [optional]
901
- **filter** | **String**| filter | [optional]
902
- **order_by** | **String**| order_by | [optional] [default to update_date]
903
- **page** | **Integer**| page | [optional] [default to 0]
904
- **size** | **Integer**| size | [optional] [default to 25]
905
-
906
- ### Return type
907
-
908
- [**PagePortfolioAssetSizeLog**](PagePortfolioAssetSizeLog.md)
909
-
910
- ### Authorization
911
-
912
- [oauth2](../README.md#oauth2)
913
-
914
- ### HTTP request headers
915
-
916
- - **Content-Type**: Not defined
917
- - **Accept**: */*
918
-
919
-
920
-
921
- # **get_portfolio_asset_size_using_get**
922
- > PortfolioAssetSizeLog get_portfolio_asset_size_using_get(portfolio_asset_size_id, opts)
923
-
924
- Retrieve a portfolio asset size
925
-
926
- Retrieve the information for a portfolio asset size record for a portfolio.
927
-
928
- ### Example
929
- ```ruby
930
- # load the gem
931
- require 'nucleus_api'
932
- # Setup authorization
933
- NucleusApi.configure do |config|
934
- # Use one of the below method to generate oauth token
935
- # Creating a token for grant_type=client_credentials
936
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
937
- # Creating a token for grant_type=password
938
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
939
- # Creating a token using client token
940
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
941
- end
942
-
943
- api_instance = NucleusApi::PortfolioApi.new
944
-
945
- portfolio_asset_size_id = 'portfolio_asset_size_id_example' # String | portfolio_asset_size_id
946
-
947
- opts = {
948
- currency_conversion: 'currency_conversion_example' # String | currency_conversion
949
- }
950
-
951
- begin
952
- #Retrieve a portfolio asset size
953
- result = api_instance.get_portfolio_asset_size_using_get(portfolio_asset_size_id, opts)
954
- p result
955
- rescue NucleusApi::ApiError => e
956
- puts "Exception when calling PortfolioApi->get_portfolio_asset_size_using_get: #{e}"
957
- end
958
- ```
959
-
960
- ### Parameters
961
-
962
- Name | Type | Description | Notes
963
- ------------- | ------------- | ------------- | -------------
964
- **portfolio_asset_size_id** | [**String**](.md)| portfolio_asset_size_id |
965
- **currency_conversion** | **String**| currency_conversion | [optional]
966
-
967
- ### Return type
968
-
969
- [**PortfolioAssetSizeLog**](PortfolioAssetSizeLog.md)
970
-
971
- ### Authorization
972
-
973
- [oauth2](../README.md#oauth2)
974
-
975
- ### HTTP request headers
976
-
977
- - **Content-Type**: Not defined
978
- - **Accept**: */*
979
-
980
-
981
-
982
- # **get_portfolio_comment_all_using_get**
983
- > PagePortfolioComment get_portfolio_comment_all_using_get(opts)
984
-
985
- List all portfolio commentary
986
-
987
- List all comments for all portfolios defined for your firm.
988
-
989
- ### Example
990
- ```ruby
991
- # load the gem
992
- require 'nucleus_api'
993
- # Setup authorization
994
- NucleusApi.configure do |config|
995
- # Use one of the below method to generate oauth token
996
- # Creating a token for grant_type=client_credentials
997
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
998
- # Creating a token for grant_type=password
999
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1000
- # Creating a token using client token
1001
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1002
- end
1003
-
1004
- api_instance = NucleusApi::PortfolioApi.new
1005
-
1006
- opts = {
1007
- ascending: false, # BOOLEAN | ascending
1008
- filter: 'filter_example', # String | filter
1009
- order_by: 'update_date', # String | order_by
1010
- page: 0, # Integer | page
1011
- size: 25 # Integer | size
1012
- }
1013
-
1014
- begin
1015
- #List all portfolio commentary
1016
- result = api_instance.get_portfolio_comment_all_using_get(opts)
1017
- p result
1018
- rescue NucleusApi::ApiError => e
1019
- puts "Exception when calling PortfolioApi->get_portfolio_comment_all_using_get: #{e}"
1020
- end
1021
- ```
1022
-
1023
- ### Parameters
1024
-
1025
- Name | Type | Description | Notes
1026
- ------------- | ------------- | ------------- | -------------
1027
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
1028
- **filter** | **String**| filter | [optional]
1029
- **order_by** | **String**| order_by | [optional] [default to update_date]
1030
- **page** | **Integer**| page | [optional] [default to 0]
1031
- **size** | **Integer**| size | [optional] [default to 25]
1032
-
1033
- ### Return type
1034
-
1035
- [**PagePortfolioComment**](PagePortfolioComment.md)
1036
-
1037
- ### Authorization
1038
-
1039
- [oauth2](../README.md#oauth2)
1040
-
1041
- ### HTTP request headers
1042
-
1043
- - **Content-Type**: Not defined
1044
- - **Accept**: */*
1045
-
1046
-
1047
-
1048
- # **get_portfolio_comment_using_get**
1049
- > PortfolioComment get_portfolio_comment_using_get(portfolio_comment_id)
1050
-
1051
- Retrieve a portfolio commentary
1052
-
1053
- Retrieve the information for a portfolio comment for a portfolio.
1054
-
1055
- ### Example
1056
- ```ruby
1057
- # load the gem
1058
- require 'nucleus_api'
1059
- # Setup authorization
1060
- NucleusApi.configure do |config|
1061
- # Use one of the below method to generate oauth token
1062
- # Creating a token for grant_type=client_credentials
1063
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1064
- # Creating a token for grant_type=password
1065
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1066
- # Creating a token using client token
1067
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1068
- end
1069
-
1070
- api_instance = NucleusApi::PortfolioApi.new
1071
-
1072
- portfolio_comment_id = 'portfolio_comment_id_example' # String | UUID portfolio_comment_id
1073
-
1074
-
1075
- begin
1076
- #Retrieve a portfolio commentary
1077
- result = api_instance.get_portfolio_comment_using_get(portfolio_comment_id)
1078
- p result
1079
- rescue NucleusApi::ApiError => e
1080
- puts "Exception when calling PortfolioApi->get_portfolio_comment_using_get: #{e}"
1081
- end
1082
- ```
1083
-
1084
- ### Parameters
1085
-
1086
- Name | Type | Description | Notes
1087
- ------------- | ------------- | ------------- | -------------
1088
- **portfolio_comment_id** | [**String**](.md)| UUID portfolio_comment_id |
1089
-
1090
- ### Return type
1091
-
1092
- [**PortfolioComment**](PortfolioComment.md)
1093
-
1094
- ### Authorization
1095
-
1096
- [oauth2](../README.md#oauth2)
1097
-
1098
- ### HTTP request headers
1099
-
1100
- - **Content-Type**: Not defined
1101
- - **Accept**: */*
1102
-
1103
-
1104
-
1105
- # **get_portfolio_goal_all_using_get**
1106
- > PagePortfolioGoal get_portfolio_goal_all_using_get(opts)
1107
-
1108
- List all portfolio goals
1109
-
1110
- Get information for all portfolio-goal mappings defined for your firm.
1111
-
1112
- ### Example
1113
- ```ruby
1114
- # load the gem
1115
- require 'nucleus_api'
1116
- # Setup authorization
1117
- NucleusApi.configure do |config|
1118
- # Use one of the below method to generate oauth token
1119
- # Creating a token for grant_type=client_credentials
1120
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1121
- # Creating a token for grant_type=password
1122
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1123
- # Creating a token using client token
1124
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1125
- end
1126
-
1127
- api_instance = NucleusApi::PortfolioApi.new
1128
-
1129
- opts = {
1130
- ascending: false, # BOOLEAN | ascending
1131
- filter: 'filter_example', # String | filter
1132
- order_by: 'update_date', # String | order_by
1133
- page: 0, # Integer | page
1134
- size: 25 # Integer | size
1135
- }
1136
-
1137
- begin
1138
- #List all portfolio goals
1139
- result = api_instance.get_portfolio_goal_all_using_get(opts)
1140
- p result
1141
- rescue NucleusApi::ApiError => e
1142
- puts "Exception when calling PortfolioApi->get_portfolio_goal_all_using_get: #{e}"
1143
- end
1144
- ```
1145
-
1146
- ### Parameters
1147
-
1148
- Name | Type | Description | Notes
1149
- ------------- | ------------- | ------------- | -------------
1150
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
1151
- **filter** | **String**| filter | [optional]
1152
- **order_by** | **String**| order_by | [optional] [default to update_date]
1153
- **page** | **Integer**| page | [optional] [default to 0]
1154
- **size** | **Integer**| size | [optional] [default to 25]
1155
-
1156
- ### Return type
1157
-
1158
- [**PagePortfolioGoal**](PagePortfolioGoal.md)
1159
-
1160
- ### Authorization
1161
-
1162
- [oauth2](../README.md#oauth2)
1163
-
1164
- ### HTTP request headers
1165
-
1166
- - **Content-Type**: Not defined
1167
- - **Accept**: */*
1168
-
1169
-
1170
-
1171
- # **get_portfolio_goal_using_get**
1172
- > PortfolioGoal get_portfolio_goal_using_get(portfolio_goal_id)
1173
-
1174
- Retrieve an portfolio goal
1175
-
1176
- Retrieve the information for a specific portfolio-goal mapping.
1177
-
1178
- ### Example
1179
- ```ruby
1180
- # load the gem
1181
- require 'nucleus_api'
1182
- # Setup authorization
1183
- NucleusApi.configure do |config|
1184
- # Use one of the below method to generate oauth token
1185
- # Creating a token for grant_type=client_credentials
1186
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1187
- # Creating a token for grant_type=password
1188
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1189
- # Creating a token using client token
1190
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1191
- end
1192
-
1193
- api_instance = NucleusApi::PortfolioApi.new
1194
-
1195
- portfolio_goal_id = 'portfolio_goal_id_example' # String | UUID portfolio_goal_id
1196
-
1197
-
1198
- begin
1199
- #Retrieve an portfolio goal
1200
- result = api_instance.get_portfolio_goal_using_get(portfolio_goal_id)
1201
- p result
1202
- rescue NucleusApi::ApiError => e
1203
- puts "Exception when calling PortfolioApi->get_portfolio_goal_using_get: #{e}"
1204
- end
1205
- ```
1206
-
1207
- ### Parameters
1208
-
1209
- Name | Type | Description | Notes
1210
- ------------- | ------------- | ------------- | -------------
1211
- **portfolio_goal_id** | [**String**](.md)| UUID portfolio_goal_id |
1212
-
1213
- ### Return type
1214
-
1215
- [**PortfolioGoal**](PortfolioGoal.md)
1216
-
1217
- ### Authorization
1218
-
1219
- [oauth2](../README.md#oauth2)
1220
-
1221
- ### HTTP request headers
1222
-
1223
- - **Content-Type**: Not defined
1224
- - **Accept**: */*
1225
-
1226
-
1227
-
1228
- # **get_portfolio_holding_all_using_get**
1229
- > PagePortfolioHoldingLog get_portfolio_holding_all_using_get(opts)
1230
-
1231
- List all portfolio holdings
1232
-
1233
- Get the information for all holding records for all portfolios defined for your firm.
1234
-
1235
- ### Example
1236
- ```ruby
1237
- # load the gem
1238
- require 'nucleus_api'
1239
- # Setup authorization
1240
- NucleusApi.configure do |config|
1241
- # Use one of the below method to generate oauth token
1242
- # Creating a token for grant_type=client_credentials
1243
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1244
- # Creating a token for grant_type=password
1245
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1246
- # Creating a token using client token
1247
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1248
- end
1249
-
1250
- api_instance = NucleusApi::PortfolioApi.new
1251
-
1252
- opts = {
1253
- ascending: false, # BOOLEAN | ascending
1254
- currency_conversion: 'currency_conversion_example', # String | currency_conversion
1255
- filter: 'filter_example', # String | filter
1256
- order_by: 'update_date', # String | order_by
1257
- page: 0, # Integer | page
1258
- size: 25 # Integer | size
1259
- }
1260
-
1261
- begin
1262
- #List all portfolio holdings
1263
- result = api_instance.get_portfolio_holding_all_using_get(opts)
1264
- p result
1265
- rescue NucleusApi::ApiError => e
1266
- puts "Exception when calling PortfolioApi->get_portfolio_holding_all_using_get: #{e}"
1267
- end
1268
- ```
1269
-
1270
- ### Parameters
1271
-
1272
- Name | Type | Description | Notes
1273
- ------------- | ------------- | ------------- | -------------
1274
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
1275
- **currency_conversion** | **String**| currency_conversion | [optional]
1276
- **filter** | **String**| filter | [optional]
1277
- **order_by** | **String**| order_by | [optional] [default to update_date]
1278
- **page** | **Integer**| page | [optional] [default to 0]
1279
- **size** | **Integer**| size | [optional] [default to 25]
1280
-
1281
- ### Return type
1282
-
1283
- [**PagePortfolioHoldingLog**](PagePortfolioHoldingLog.md)
1284
-
1285
- ### Authorization
1286
-
1287
- [oauth2](../README.md#oauth2)
1288
-
1289
- ### HTTP request headers
1290
-
1291
- - **Content-Type**: Not defined
1292
- - **Accept**: */*
1293
-
1294
-
1295
-
1296
- # **get_portfolio_holding_using_get**
1297
- > PortfolioHoldingLog get_portfolio_holding_using_get(portfolio_holding_id, opts)
1298
-
1299
- Retrieve a portfolio holding
1300
-
1301
- Retrieve the information for a portfolio holding record for a portfolio.
1302
-
1303
- ### Example
1304
- ```ruby
1305
- # load the gem
1306
- require 'nucleus_api'
1307
- # Setup authorization
1308
- NucleusApi.configure do |config|
1309
- # Use one of the below method to generate oauth token
1310
- # Creating a token for grant_type=client_credentials
1311
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1312
- # Creating a token for grant_type=password
1313
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1314
- # Creating a token using client token
1315
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1316
- end
1317
-
1318
- api_instance = NucleusApi::PortfolioApi.new
1319
-
1320
- portfolio_holding_id = 'portfolio_holding_id_example' # String | UUID portfolio_holding_id
1321
-
1322
- opts = {
1323
- currency_conversion: 'currency_conversion_example' # String | USD
1324
- }
1325
-
1326
- begin
1327
- #Retrieve a portfolio holding
1328
- result = api_instance.get_portfolio_holding_using_get(portfolio_holding_id, opts)
1329
- p result
1330
- rescue NucleusApi::ApiError => e
1331
- puts "Exception when calling PortfolioApi->get_portfolio_holding_using_get: #{e}"
1332
- end
1333
- ```
1334
-
1335
- ### Parameters
1336
-
1337
- Name | Type | Description | Notes
1338
- ------------- | ------------- | ------------- | -------------
1339
- **portfolio_holding_id** | [**String**](.md)| UUID portfolio_holding_id |
1340
- **currency_conversion** | **String**| USD | [optional]
1341
-
1342
- ### Return type
1343
-
1344
- [**PortfolioHoldingLog**](PortfolioHoldingLog.md)
1345
-
1346
- ### Authorization
1347
-
1348
- [oauth2](../README.md#oauth2)
1349
-
1350
- ### HTTP request headers
1351
-
1352
- - **Content-Type**: Not defined
1353
- - **Accept**: */*
1354
-
1355
-
1356
-
1357
- # **get_portfolio_transaction_all_using_get**
1358
- > PagePortfolioTransaction get_portfolio_transaction_all_using_get(opts)
1359
-
1360
- List all portfolio transactions
1361
-
1362
- Get the information for all transaction records for all portfolios defined for your firm.
1363
-
1364
- ### Example
1365
- ```ruby
1366
- # load the gem
1367
- require 'nucleus_api'
1368
- # Setup authorization
1369
- NucleusApi.configure do |config|
1370
- # Use one of the below method to generate oauth token
1371
- # Creating a token for grant_type=client_credentials
1372
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1373
- # Creating a token for grant_type=password
1374
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1375
- # Creating a token using client token
1376
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1377
- end
1378
-
1379
- api_instance = NucleusApi::PortfolioApi.new
1380
-
1381
- opts = {
1382
- ascending: false, # BOOLEAN | ascending
1383
- currency_conversion: 'currency_conversion_example', # String | currency_conversion
1384
- filter: 'filter_example', # String | filter
1385
- order_by: 'update_date', # String | order_by
1386
- page: 0, # Integer | page
1387
- size: 25 # Integer | size
1388
- }
1389
-
1390
- begin
1391
- #List all portfolio transactions
1392
- result = api_instance.get_portfolio_transaction_all_using_get(opts)
1393
- p result
1394
- rescue NucleusApi::ApiError => e
1395
- puts "Exception when calling PortfolioApi->get_portfolio_transaction_all_using_get: #{e}"
1396
- end
1397
- ```
1398
-
1399
- ### Parameters
1400
-
1401
- Name | Type | Description | Notes
1402
- ------------- | ------------- | ------------- | -------------
1403
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
1404
- **currency_conversion** | **String**| currency_conversion | [optional]
1405
- **filter** | **String**| filter | [optional]
1406
- **order_by** | **String**| order_by | [optional] [default to update_date]
1407
- **page** | **Integer**| page | [optional] [default to 0]
1408
- **size** | **Integer**| size | [optional] [default to 25]
1409
-
1410
- ### Return type
1411
-
1412
- [**PagePortfolioTransaction**](PagePortfolioTransaction.md)
1413
-
1414
- ### Authorization
1415
-
1416
- [oauth2](../README.md#oauth2)
1417
-
1418
- ### HTTP request headers
1419
-
1420
- - **Content-Type**: Not defined
1421
- - **Accept**: */*
1422
-
1423
-
1424
-
1425
- # **get_portfolio_transaction_using_get**
1426
- > PortfolioTransaction get_portfolio_transaction_using_get(portfolio_transaction_id, opts)
1427
-
1428
- Retrieve a portfolio transaction
1429
-
1430
- Retrieve the information for a portfolio transaction record for a portfolio.
1431
-
1432
- ### Example
1433
- ```ruby
1434
- # load the gem
1435
- require 'nucleus_api'
1436
- # Setup authorization
1437
- NucleusApi.configure do |config|
1438
- # Use one of the below method to generate oauth token
1439
- # Creating a token for grant_type=client_credentials
1440
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1441
- # Creating a token for grant_type=password
1442
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1443
- # Creating a token using client token
1444
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1445
- end
1446
-
1447
- api_instance = NucleusApi::PortfolioApi.new
1448
-
1449
- portfolio_transaction_id = 'portfolio_transaction_id_example' # String | UUID portfolio_transaction_id
1450
-
1451
- opts = {
1452
- currency_conversion: 'currency_conversion_example' # String | USD
1453
- }
1454
-
1455
- begin
1456
- #Retrieve a portfolio transaction
1457
- result = api_instance.get_portfolio_transaction_using_get(portfolio_transaction_id, opts)
1458
- p result
1459
- rescue NucleusApi::ApiError => e
1460
- puts "Exception when calling PortfolioApi->get_portfolio_transaction_using_get: #{e}"
1461
- end
1462
- ```
1463
-
1464
- ### Parameters
1465
-
1466
- Name | Type | Description | Notes
1467
- ------------- | ------------- | ------------- | -------------
1468
- **portfolio_transaction_id** | [**String**](.md)| UUID portfolio_transaction_id |
1469
- **currency_conversion** | **String**| USD | [optional]
1470
-
1471
- ### Return type
1472
-
1473
- [**PortfolioTransaction**](PortfolioTransaction.md)
1474
-
1475
- ### Authorization
1476
-
1477
- [oauth2](../README.md#oauth2)
1478
-
1479
- ### HTTP request headers
1480
-
1481
- - **Content-Type**: Not defined
1482
- - **Accept**: */*
1483
-
1484
-
1485
-
1486
- # **get_portfolio_using_get**
1487
- > Portfolio get_portfolio_using_get(portfolio_id)
1488
-
1489
- Retrieve a portfolio
1490
-
1491
- Retrieve a portfolio for an account.
1492
-
1493
- ### Example
1494
- ```ruby
1495
- # load the gem
1496
- require 'nucleus_api'
1497
- # Setup authorization
1498
- NucleusApi.configure do |config|
1499
- # Use one of the below method to generate oauth token
1500
- # Creating a token for grant_type=client_credentials
1501
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1502
- # Creating a token for grant_type=password
1503
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1504
- # Creating a token using client token
1505
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1506
- end
1507
-
1508
- api_instance = NucleusApi::PortfolioApi.new
1509
-
1510
- portfolio_id = 'portfolio_id_example' # String | UUID portfolio_id
1511
-
1512
-
1513
- begin
1514
- #Retrieve a portfolio
1515
- result = api_instance.get_portfolio_using_get(portfolio_id)
1516
- p result
1517
- rescue NucleusApi::ApiError => e
1518
- puts "Exception when calling PortfolioApi->get_portfolio_using_get: #{e}"
1519
- end
1520
- ```
1521
-
1522
- ### Parameters
1523
-
1524
- Name | Type | Description | Notes
1525
- ------------- | ------------- | ------------- | -------------
1526
- **portfolio_id** | [**String**](.md)| UUID portfolio_id |
1527
-
1528
- ### Return type
1529
-
1530
- [**Portfolio**](Portfolio.md)
1531
-
1532
- ### Authorization
1533
-
1534
- [oauth2](../README.md#oauth2)
1535
-
1536
- ### HTTP request headers
1537
-
1538
- - **Content-Type**: Not defined
1539
- - **Accept**: */*
1540
-
1541
-
1542
-
1543
- # **update_portfolio_asset_size_using_put**
1544
- > PortfolioAssetSizeLog update_portfolio_asset_size_using_put(portfolio_asset_size, portfolio_asset_size_id)
1545
-
1546
- Update a portfolio asset size
1547
-
1548
- Update the information for a portfolio asset size record for a portfolio.
1549
-
1550
- ### Example
1551
- ```ruby
1552
- # load the gem
1553
- require 'nucleus_api'
1554
- # Setup authorization
1555
- NucleusApi.configure do |config|
1556
- # Use one of the below method to generate oauth token
1557
- # Creating a token for grant_type=client_credentials
1558
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1559
- # Creating a token for grant_type=password
1560
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1561
- # Creating a token using client token
1562
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1563
- end
1564
-
1565
- api_instance = NucleusApi::PortfolioApi.new
1566
-
1567
- portfolio_asset_size = nil # Object | portfolio_asset_size
1568
-
1569
- portfolio_asset_size_id = 'portfolio_asset_size_id_example' # String | UUID portfolio_asset_size_id
1570
-
1571
-
1572
- begin
1573
- #Update a portfolio asset size
1574
- result = api_instance.update_portfolio_asset_size_using_put(portfolio_asset_size, portfolio_asset_size_id)
1575
- p result
1576
- rescue NucleusApi::ApiError => e
1577
- puts "Exception when calling PortfolioApi->update_portfolio_asset_size_using_put: #{e}"
1578
- end
1579
- ```
1580
-
1581
- ### Parameters
1582
-
1583
- Name | Type | Description | Notes
1584
- ------------- | ------------- | ------------- | -------------
1585
- **portfolio_asset_size** | **Object**| portfolio_asset_size |
1586
- **portfolio_asset_size_id** | [**String**](.md)| UUID portfolio_asset_size_id |
1587
-
1588
- ### Return type
1589
-
1590
- [**PortfolioAssetSizeLog**](PortfolioAssetSizeLog.md)
1591
-
1592
- ### Authorization
1593
-
1594
- [oauth2](../README.md#oauth2)
1595
-
1596
- ### HTTP request headers
1597
-
1598
- - **Content-Type**: application/json
1599
- - **Accept**: */*
1600
-
1601
-
1602
-
1603
- # **update_portfolio_comment_using_put**
1604
- > PortfolioComment update_portfolio_comment_using_put(portfolio_comment, portfolio_comment_id)
1605
-
1606
- Update a portfolio comment
1607
-
1608
- Update the information for a portfolio comment for a portfolio.
1609
-
1610
- ### Example
1611
- ```ruby
1612
- # load the gem
1613
- require 'nucleus_api'
1614
- # Setup authorization
1615
- NucleusApi.configure do |config|
1616
- # Use one of the below method to generate oauth token
1617
- # Creating a token for grant_type=client_credentials
1618
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1619
- # Creating a token for grant_type=password
1620
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1621
- # Creating a token using client token
1622
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1623
- end
1624
-
1625
- api_instance = NucleusApi::PortfolioApi.new
1626
-
1627
- portfolio_comment = nil # Object | portfolio_comment
1628
-
1629
- portfolio_comment_id = 'portfolio_comment_id_example' # String | UUID portfolio_comment_id
1630
-
1631
-
1632
- begin
1633
- #Update a portfolio comment
1634
- result = api_instance.update_portfolio_comment_using_put(portfolio_comment, portfolio_comment_id)
1635
- p result
1636
- rescue NucleusApi::ApiError => e
1637
- puts "Exception when calling PortfolioApi->update_portfolio_comment_using_put: #{e}"
1638
- end
1639
- ```
1640
-
1641
- ### Parameters
1642
-
1643
- Name | Type | Description | Notes
1644
- ------------- | ------------- | ------------- | -------------
1645
- **portfolio_comment** | **Object**| portfolio_comment |
1646
- **portfolio_comment_id** | [**String**](.md)| UUID portfolio_comment_id |
1647
-
1648
- ### Return type
1649
-
1650
- [**PortfolioComment**](PortfolioComment.md)
1651
-
1652
- ### Authorization
1653
-
1654
- [oauth2](../README.md#oauth2)
1655
-
1656
- ### HTTP request headers
1657
-
1658
- - **Content-Type**: application/json
1659
- - **Accept**: */*
1660
-
1661
-
1662
-
1663
- # **update_portfolio_goal_using_put**
1664
- > PortfolioGoal update_portfolio_goal_using_put(portfolio_goal, portfolio_goal_id)
1665
-
1666
- Update an portfolio goal
1667
-
1668
- Update the information for an portfolio-goal mapping.
1669
-
1670
- ### Example
1671
- ```ruby
1672
- # load the gem
1673
- require 'nucleus_api'
1674
- # Setup authorization
1675
- NucleusApi.configure do |config|
1676
- # Use one of the below method to generate oauth token
1677
- # Creating a token for grant_type=client_credentials
1678
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1679
- # Creating a token for grant_type=password
1680
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1681
- # Creating a token using client token
1682
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1683
- end
1684
-
1685
- api_instance = NucleusApi::PortfolioApi.new
1686
-
1687
- portfolio_goal = nil # Object | portfolio_goal
1688
-
1689
- portfolio_goal_id = 'portfolio_goal_id_example' # String | UUID portfolio_goal_id
1690
-
1691
-
1692
- begin
1693
- #Update an portfolio goal
1694
- result = api_instance.update_portfolio_goal_using_put(portfolio_goal, portfolio_goal_id)
1695
- p result
1696
- rescue NucleusApi::ApiError => e
1697
- puts "Exception when calling PortfolioApi->update_portfolio_goal_using_put: #{e}"
1698
- end
1699
- ```
1700
-
1701
- ### Parameters
1702
-
1703
- Name | Type | Description | Notes
1704
- ------------- | ------------- | ------------- | -------------
1705
- **portfolio_goal** | **Object**| portfolio_goal |
1706
- **portfolio_goal_id** | [**String**](.md)| UUID portfolio_goal_id |
1707
-
1708
- ### Return type
1709
-
1710
- [**PortfolioGoal**](PortfolioGoal.md)
1711
-
1712
- ### Authorization
1713
-
1714
- [oauth2](../README.md#oauth2)
1715
-
1716
- ### HTTP request headers
1717
-
1718
- - **Content-Type**: application/json
1719
- - **Accept**: */*
1720
-
1721
-
1722
-
1723
- # **update_portfolio_holding_using_put**
1724
- > PortfolioHoldingLog update_portfolio_holding_using_put(portfolio_holding, portfolio_holding_id)
1725
-
1726
- Update a portfolio holding
1727
-
1728
- Update the information for a portfolio holding record for a portfolio.
1729
-
1730
- ### Example
1731
- ```ruby
1732
- # load the gem
1733
- require 'nucleus_api'
1734
- # Setup authorization
1735
- NucleusApi.configure do |config|
1736
- # Use one of the below method to generate oauth token
1737
- # Creating a token for grant_type=client_credentials
1738
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1739
- # Creating a token for grant_type=password
1740
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1741
- # Creating a token using client token
1742
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1743
- end
1744
-
1745
- api_instance = NucleusApi::PortfolioApi.new
1746
-
1747
- portfolio_holding = nil # Object | portfolio_holding
1748
-
1749
- portfolio_holding_id = 'portfolio_holding_id_example' # String | UUID portfolio_holding_id
1750
-
1751
-
1752
- begin
1753
- #Update a portfolio holding
1754
- result = api_instance.update_portfolio_holding_using_put(portfolio_holding, portfolio_holding_id)
1755
- p result
1756
- rescue NucleusApi::ApiError => e
1757
- puts "Exception when calling PortfolioApi->update_portfolio_holding_using_put: #{e}"
1758
- end
1759
- ```
1760
-
1761
- ### Parameters
1762
-
1763
- Name | Type | Description | Notes
1764
- ------------- | ------------- | ------------- | -------------
1765
- **portfolio_holding** | **Object**| portfolio_holding |
1766
- **portfolio_holding_id** | [**String**](.md)| UUID portfolio_holding_id |
1767
-
1768
- ### Return type
1769
-
1770
- [**PortfolioHoldingLog**](PortfolioHoldingLog.md)
1771
-
1772
- ### Authorization
1773
-
1774
- [oauth2](../README.md#oauth2)
1775
-
1776
- ### HTTP request headers
1777
-
1778
- - **Content-Type**: application/json
1779
- - **Accept**: */*
1780
-
1781
-
1782
-
1783
- # **update_portfolio_transaction_using_put**
1784
- > PortfolioTransaction update_portfolio_transaction_using_put(portfolio_transaction, portfolio_transaction_id)
1785
-
1786
- Update a portfolio transaction
1787
-
1788
- Update the information for a portfolio transaction record for a portfolio.
1789
-
1790
- ### Example
1791
- ```ruby
1792
- # load the gem
1793
- require 'nucleus_api'
1794
- # Setup authorization
1795
- NucleusApi.configure do |config|
1796
- # Use one of the below method to generate oauth token
1797
- # Creating a token for grant_type=client_credentials
1798
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1799
- # Creating a token for grant_type=password
1800
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1801
- # Creating a token using client token
1802
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1803
- end
1804
-
1805
- api_instance = NucleusApi::PortfolioApi.new
1806
-
1807
- portfolio_transaction = nil # Object | portfolio_transaction
1808
-
1809
- portfolio_transaction_id = 'portfolio_transaction_id_example' # String | UUID portfolio_transaction_id
1810
-
1811
-
1812
- begin
1813
- #Update a portfolio transaction
1814
- result = api_instance.update_portfolio_transaction_using_put(portfolio_transaction, portfolio_transaction_id)
1815
- p result
1816
- rescue NucleusApi::ApiError => e
1817
- puts "Exception when calling PortfolioApi->update_portfolio_transaction_using_put: #{e}"
1818
- end
1819
- ```
1820
-
1821
- ### Parameters
1822
-
1823
- Name | Type | Description | Notes
1824
- ------------- | ------------- | ------------- | -------------
1825
- **portfolio_transaction** | **Object**| portfolio_transaction |
1826
- **portfolio_transaction_id** | [**String**](.md)| UUID portfolio_transaction_id |
1827
-
1828
- ### Return type
1829
-
1830
- [**PortfolioTransaction**](PortfolioTransaction.md)
1831
-
1832
- ### Authorization
1833
-
1834
- [oauth2](../README.md#oauth2)
1835
-
1836
- ### HTTP request headers
1837
-
1838
- - **Content-Type**: application/json
1839
- - **Accept**: */*
1840
-
1841
-
1842
-
1843
- # **update_portfolio_using_put**
1844
- > Portfolio update_portfolio_using_put(portfolio, portfolio_id)
1845
-
1846
- Update a portfolio
1847
-
1848
- Update a portfolio for an account.
1849
-
1850
- ### Example
1851
- ```ruby
1852
- # load the gem
1853
- require 'nucleus_api'
1854
- # Setup authorization
1855
- NucleusApi.configure do |config|
1856
- # Use one of the below method to generate oauth token
1857
- # Creating a token for grant_type=client_credentials
1858
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1859
- # Creating a token for grant_type=password
1860
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1861
- # Creating a token using client token
1862
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1863
- end
1864
-
1865
- api_instance = NucleusApi::PortfolioApi.new
1866
-
1867
- portfolio = nil # Object | portfolio
1868
-
1869
- portfolio_id = 'portfolio_id_example' # String | UUID portfolio_id
1870
-
1871
-
1872
- begin
1873
- #Update a portfolio
1874
- result = api_instance.update_portfolio_using_put(portfolio, portfolio_id)
1875
- p result
1876
- rescue NucleusApi::ApiError => e
1877
- puts "Exception when calling PortfolioApi->update_portfolio_using_put: #{e}"
1878
- end
1879
- ```
1880
-
1881
- ### Parameters
1882
-
1883
- Name | Type | Description | Notes
1884
- ------------- | ------------- | ------------- | -------------
1885
- **portfolio** | **Object**| portfolio |
1886
- **portfolio_id** | [**String**](.md)| UUID portfolio_id |
1887
-
1888
- ### Return type
1889
-
1890
- [**Portfolio**](Portfolio.md)
1891
-
1892
- ### Authorization
1893
-
1894
- [oauth2](../README.md#oauth2)
1895
-
1896
- ### HTTP request headers
1897
-
1898
- - **Content-Type**: application/json
1899
- - **Accept**: */*
1900
-
1901
-
1902
-