nucleus_api 1.8.0 → 1.9.1

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