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/CardProgram.md DELETED
@@ -1,23 +0,0 @@
1
- # NucleusApi::CardProgram
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **card_network** | **String** | cardNetwork |
7
- **card_processor** | **String** | cardProcessor | [optional]
8
- **card_type** | **String** | cardType |
9
- **client_id** | **String** | clientId | [optional]
10
- **code** | **String** | code | [optional]
11
- **create_date** | **DateTime** | | [optional]
12
- **description** | **String** | description | [optional]
13
- **id** | **String** | | [optional]
14
- **is_active** | **BOOLEAN** | is_active | [optional]
15
- **is_delegated_authority** | **BOOLEAN** | is_delegated_authority | [optional]
16
- **issuing_bank** | **String** | issuingBank |
17
- **metadata** | **Hash<String, String>** | | [optional]
18
- **name** | **String** | name |
19
- **program_manager** | **String** | programManager | [optional]
20
- **secondary_id** | **String** | | [optional]
21
- **update_date** | **DateTime** | | [optional]
22
-
23
-
data/docs/Cash.md DELETED
@@ -1,10 +0,0 @@
1
- # NucleusApi::Cash
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **amount** | **Float** | cashAmount |
7
- **name** | **String** | cashName | [optional]
8
- **transaction_type** | **String** | cashTransactionType |
9
-
10
-
data/docs/CategoriesMap.md DELETED
@@ -1,9 +0,0 @@
1
- # NucleusApi::CategoriesMap
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **amount** | **Integer** | amount |
7
- **category** | **String** | category |
8
-
9
-
data/docs/CategoryInternalResponseVO.md DELETED
@@ -1,10 +0,0 @@
1
- # NucleusApi::CategoryInternalResponseVO
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **category** | **String** | | [optional]
7
- **subcategories** | **Array<String>** | | [optional]
8
- **tenant_name** | **String** | | [optional]
9
-
10
-
data/docs/CategoryResponseVO.md DELETED
@@ -1,9 +0,0 @@
1
- # NucleusApi::CategoryResponseVO
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **categories** | [**Array<CategoryInternalResponseVO>**](CategoryInternalResponseVO.md) | | [optional]
7
- **vendor_name** | **String** | | [optional]
8
-
9
-
data/docs/Check.md DELETED
@@ -1,10 +0,0 @@
1
- # NucleusApi::Check
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **check_amount** | **Float** | checkAmount | [optional]
7
- **check_images** | [**Array<CheckImages>**](CheckImages.md) | checkImages | [optional]
8
- **check_number** | **String** | checkNumber |
9
-
10
-
data/docs/CheckImages.md DELETED
@@ -1,9 +0,0 @@
1
- # NucleusApi::CheckImages
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **image_type** | **String** | imageType | [optional]
7
- **image_url** | **String** | imageUrl |
8
-
9
-
data/docs/Client.md DELETED
@@ -1,39 +0,0 @@
1
- # NucleusApi::Client
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **address** | [**Array<ClientAddress>**](ClientAddress.md) | | [optional]
7
- **business_id** | **String** | business_id | [optional]
8
- **citizenship_status** | **String** | citizenshipStatus | [optional]
9
- **client_type** | **String** | clientTypeId |
10
- **country_of_citizenship** | **Array<String>** | countryOfCitizenship | [optional]
11
- **country_of_residence** | **String** | countryOfResidence | [optional]
12
- **create_date** | **DateTime** | | [optional]
13
- **date_of_birth** | **String** | dateOfBirth | [optional]
14
- **email** | **String** | email | [optional]
15
- **employment** | [**Employment**](Employment.md) | | [optional]
16
- **firm_name** | **String** | firmName | [optional]
17
- **firm_type** | **String** | firmType | [optional]
18
- **first_name** | **String** | firstName | [optional]
19
- **gender** | **String** | gender | [optional]
20
- **hydro_id** | **String** | hydroId | [optional]
21
- **id** | **String** | | [optional]
22
- **identification_number** | **String** | identificationNumber | [optional]
23
- **identification_number_type** | **String** | identificationNumberType | [optional]
24
- **image** | **String** | image | [optional]
25
- **income** | **Integer** | income | [optional]
26
- **is_active** | **BOOLEAN** | isActive | [optional]
27
- **is_verified** | **BOOLEAN** | isVerified | [optional]
28
- **last_name** | **String** | last_name | [optional]
29
- **liquid_net_worth** | **Float** | liquidNetWorth | [optional]
30
- **metadata** | **Hash<String, String>** | metadata | [optional]
31
- **middle_name** | **String** | middleName | [optional]
32
- **phone_number** | **String** | phoneNumber | [optional]
33
- **secondary_id** | **String** | | [optional]
34
- **status** | **String** | status | [optional]
35
- **suffix** | **String** | suffix | [optional]
36
- **title** | **String** | title | [optional]
37
- **total_net_worth** | **Float** | totalNetWorth | [optional]
38
- **update_date** | **DateTime** | | [optional]
39
- **username** | **String** | username |
data/docs/ClientAccountMapping.md DELETED
@@ -1,10 +0,0 @@
1
- # NucleusApi::ClientAccountMapping
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **client_account_association_type** | **String** | clientAccountAssociationType |
7
- **client_id** | **String** | clientId |
8
- **signature_data** | **String** | | [optional]
9
-
10
-
data/docs/ClientAddress.md DELETED
@@ -1,15 +0,0 @@
1
- # NucleusApi::ClientAddress
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **address_line1** | **String** | addressLine1 |
7
- **address_line2** | **String** | addressLine2 | [optional]
8
- **city** | **String** | city |
9
- **country** | **String** | country |
10
- **is_primary** | **BOOLEAN** | is_primary | [optional]
11
- **postalcode** | **String** | postalcode | [optional]
12
- **state** | **String** | state |
13
- **type** | **String** | type |
14
-
15
-
data/docs/ClientApi.md DELETED
@@ -1,1008 +0,0 @@
1
- # NucleusApi::ClientApi
2
-
3
- All URIs are relative to *https://sandbox.hydrogenplatform.com/nucleus/v1*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_client_status_using_post**](ClientApi.md#create_client_status_using_post) | **POST** /client_status | Create an client status
8
- [**create_client_using_post**](ClientApi.md#create_client_using_post) | **POST** /client | Create a client
9
- [**delete_client_status_using_delete**](ClientApi.md#delete_client_status_using_delete) | **DELETE** /client_status/{client_status_id} | Delete an client status
10
- [**delete_client_using_delete**](ClientApi.md#delete_client_using_delete) | **DELETE** /client/{client_id} | Delete a client
11
- [**get_client_account_overview_using_get**](ClientApi.md#get_client_account_overview_using_get) | **GET** /client/{client_id}/account_overview | List all client Account overview
12
- [**get_client_advisor_overview_using_get**](ClientApi.md#get_client_advisor_overview_using_get) | **GET** /client/{client_id}/advisor_overview | Advisor overview
13
- [**get_client_all_using_get**](ClientApi.md#get_client_all_using_get) | **GET** /client | List all clients
14
- [**get_client_asset_size_using_get**](ClientApi.md#get_client_asset_size_using_get) | **GET** /client/{client_id}/asset_size | List all client asset sizes
15
- [**get_client_goal_overview_using_get**](ClientApi.md#get_client_goal_overview_using_get) | **GET** /client/{client_id}/goal_overview | Retrieve client's goal details
16
- [**get_client_holding_using_get**](ClientApi.md#get_client_holding_using_get) | **GET** /client/{client_id}/holding | List all client holdings
17
- [**get_client_status_all_using_get**](ClientApi.md#get_client_status_all_using_get) | **GET** /client_status | List all client statuses
18
- [**get_client_status_using_get**](ClientApi.md#get_client_status_using_get) | **GET** /client_status/{client_status_id} | Retrieve an client status
19
- [**get_client_transaction_all_using_get**](ClientApi.md#get_client_transaction_all_using_get) | **GET** /client/{client_id}/transaction | List all client transactions
20
- [**get_client_using_get**](ClientApi.md#get_client_using_get) | **GET** /client/{client_id} | Retrieve a client
21
- [**update_client_status_using_put**](ClientApi.md#update_client_status_using_put) | **PUT** /client_status/{client_status_id} | Update an client status
22
- [**update_client_using_put**](ClientApi.md#update_client_using_put) | **PUT** /client/{client_id} | Update a client
23
-
24
-
25
- # **create_client_status_using_post**
26
- > ClientStatus create_client_status_using_post(client_status_request)
27
-
28
- Create an client status
29
-
30
- Create an client status record for an client.
31
-
32
- ### Example
33
- ```ruby
34
- # load the gem
35
- require 'nucleus_api'
36
- # Setup authorization
37
- NucleusApi.configure do |config|
38
- # Use one of the below method to generate oauth token
39
- # Creating a token for grant_type=client_credentials
40
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
41
- # Creating a token for grant_type=password
42
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
43
- # Creating a token using client token
44
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
45
- end
46
-
47
- api_instance = NucleusApi::ClientApi.new
48
-
49
- client_status_request = NucleusApi::ClientStatus.new # ClientStatus | clientStatusRequest
50
-
51
-
52
- begin
53
- #Create an client status
54
- result = api_instance.create_client_status_using_post(client_status_request)
55
- p result
56
- rescue NucleusApi::ApiError => e
57
- puts "Exception when calling ClientApi->create_client_status_using_post: #{e}"
58
- end
59
- ```
60
-
61
- ### Parameters
62
-
63
- Name | Type | Description | Notes
64
- ------------- | ------------- | ------------- | -------------
65
- **client_status_request** | [**ClientStatus**](ClientStatus.md)| clientStatusRequest |
66
-
67
- ### Return type
68
-
69
- [**ClientStatus**](ClientStatus.md)
70
-
71
- ### Authorization
72
-
73
- [oauth2](../README.md#oauth2)
74
-
75
- ### HTTP request headers
76
-
77
- - **Content-Type**: application/json
78
- - **Accept**: */*
79
-
80
-
81
-
82
- # **create_client_using_post**
83
- > Client create_client_using_post(client_request)
84
-
85
- Create a client
86
-
87
- Create a new client, or register a new user, with your firm.
88
-
89
- ### Example
90
- ```ruby
91
- # load the gem
92
- require 'nucleus_api'
93
- # Setup authorization
94
- NucleusApi.configure do |config|
95
- # Use one of the below method to generate oauth token
96
- # Creating a token for grant_type=client_credentials
97
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
98
- # Creating a token for grant_type=password
99
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
100
- # Creating a token using client token
101
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
102
- end
103
-
104
- api_instance = NucleusApi::ClientApi.new
105
-
106
- client_request = NucleusApi::Client.new # Client | clientRequest
107
-
108
-
109
- begin
110
- #Create a client
111
- result = api_instance.create_client_using_post(client_request)
112
- p result
113
- rescue NucleusApi::ApiError => e
114
- puts "Exception when calling ClientApi->create_client_using_post: #{e}"
115
- end
116
- ```
117
-
118
- ### Parameters
119
-
120
- Name | Type | Description | Notes
121
- ------------- | ------------- | ------------- | -------------
122
- **client_request** | [**Client**](Client.md)| clientRequest |
123
-
124
- ### Return type
125
-
126
- [**Client**](Client.md)
127
-
128
- ### Authorization
129
-
130
- [oauth2](../README.md#oauth2)
131
-
132
- ### HTTP request headers
133
-
134
- - **Content-Type**: application/json
135
- - **Accept**: */*
136
-
137
-
138
-
139
- # **delete_client_status_using_delete**
140
- > delete_client_status_using_delete(client_status_id)
141
-
142
- Delete an client status
143
-
144
- Permanently delete an client status record from an client’s history.
145
-
146
- ### Example
147
- ```ruby
148
- # load the gem
149
- require 'nucleus_api'
150
- # Setup authorization
151
- NucleusApi.configure do |config|
152
- # Use one of the below method to generate oauth token
153
- # Creating a token for grant_type=client_credentials
154
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
155
- # Creating a token for grant_type=password
156
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
157
- # Creating a token using client token
158
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
159
- end
160
-
161
- api_instance = NucleusApi::ClientApi.new
162
-
163
- client_status_id = 'client_status_id_example' # String | UUID client_status_id
164
-
165
-
166
- begin
167
- #Delete an client status
168
- api_instance.delete_client_status_using_delete(client_status_id)
169
- rescue NucleusApi::ApiError => e
170
- puts "Exception when calling ClientApi->delete_client_status_using_delete: #{e}"
171
- end
172
- ```
173
-
174
- ### Parameters
175
-
176
- Name | Type | Description | Notes
177
- ------------- | ------------- | ------------- | -------------
178
- **client_status_id** | [**String**](.md)| UUID client_status_id |
179
-
180
- ### Return type
181
-
182
- nil (empty response body)
183
-
184
- ### Authorization
185
-
186
- [oauth2](../README.md#oauth2)
187
-
188
- ### HTTP request headers
189
-
190
- - **Content-Type**: Not defined
191
- - **Accept**: */*
192
-
193
-
194
-
195
- # **delete_client_using_delete**
196
- > delete_client_using_delete(client_id)
197
-
198
- Delete a client
199
-
200
- Permanently delete a client registered with your firm. Turns the client's is_active = 0
201
-
202
- ### Example
203
- ```ruby
204
- # load the gem
205
- require 'nucleus_api'
206
- # Setup authorization
207
- NucleusApi.configure do |config|
208
- # Use one of the below method to generate oauth token
209
- # Creating a token for grant_type=client_credentials
210
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
211
- # Creating a token for grant_type=password
212
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
213
- # Creating a token using client token
214
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
215
- end
216
-
217
- api_instance = NucleusApi::ClientApi.new
218
-
219
- client_id = 'client_id_example' # String | UUID client_id
220
-
221
-
222
- begin
223
- #Delete a client
224
- api_instance.delete_client_using_delete(client_id)
225
- rescue NucleusApi::ApiError => e
226
- puts "Exception when calling ClientApi->delete_client_using_delete: #{e}"
227
- end
228
- ```
229
-
230
- ### Parameters
231
-
232
- Name | Type | Description | Notes
233
- ------------- | ------------- | ------------- | -------------
234
- **client_id** | [**String**](.md)| UUID client_id |
235
-
236
- ### Return type
237
-
238
- nil (empty response body)
239
-
240
- ### Authorization
241
-
242
- [oauth2](../README.md#oauth2)
243
-
244
- ### HTTP request headers
245
-
246
- - **Content-Type**: Not defined
247
- - **Accept**: */*
248
-
249
-
250
-
251
- # **get_client_account_overview_using_get**
252
- > Object get_client_account_overview_using_get(client_id, opts)
253
-
254
- List all client Account overview
255
-
256
- ### Example
257
- ```ruby
258
- # load the gem
259
- require 'nucleus_api'
260
- # Setup authorization
261
- NucleusApi.configure do |config|
262
- # Use one of the below method to generate oauth token
263
- # Creating a token for grant_type=client_credentials
264
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
265
- # Creating a token for grant_type=password
266
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
267
- # Creating a token using client token
268
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
269
- end
270
-
271
- api_instance = NucleusApi::ClientApi.new
272
-
273
- client_id = 'client_id_example' # String | UUID client_id
274
-
275
- opts = {
276
- ascending: false, # BOOLEAN | ascending
277
- order_by: 'update_date' # String | order_by
278
- }
279
-
280
- begin
281
- #List all client Account overview
282
- result = api_instance.get_client_account_overview_using_get(client_id, opts)
283
- p result
284
- rescue NucleusApi::ApiError => e
285
- puts "Exception when calling ClientApi->get_client_account_overview_using_get: #{e}"
286
- end
287
- ```
288
-
289
- ### Parameters
290
-
291
- Name | Type | Description | Notes
292
- ------------- | ------------- | ------------- | -------------
293
- **client_id** | [**String**](.md)| UUID client_id |
294
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
295
- **order_by** | **String**| order_by | [optional] [default to update_date]
296
-
297
- ### Return type
298
-
299
- **Object**
300
-
301
- ### Authorization
302
-
303
- [oauth2](../README.md#oauth2)
304
-
305
- ### HTTP request headers
306
-
307
- - **Content-Type**: Not defined
308
- - **Accept**: */*
309
-
310
-
311
-
312
- # **get_client_advisor_overview_using_get**
313
- > Object get_client_advisor_overview_using_get(client_id, opts)
314
-
315
- Advisor overview
316
-
317
- ### Example
318
- ```ruby
319
- # load the gem
320
- require 'nucleus_api'
321
- # Setup authorization
322
- NucleusApi.configure do |config|
323
- # Use one of the below method to generate oauth token
324
- # Creating a token for grant_type=client_credentials
325
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
326
- # Creating a token for grant_type=password
327
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
328
- # Creating a token using client token
329
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
330
- end
331
-
332
- api_instance = NucleusApi::ClientApi.new
333
-
334
- client_id = 'client_id_example' # String | UUID client_id
335
-
336
- opts = {
337
- show_clients: false # BOOLEAN | show_clients
338
- }
339
-
340
- begin
341
- #Advisor overview
342
- result = api_instance.get_client_advisor_overview_using_get(client_id, opts)
343
- p result
344
- rescue NucleusApi::ApiError => e
345
- puts "Exception when calling ClientApi->get_client_advisor_overview_using_get: #{e}"
346
- end
347
- ```
348
-
349
- ### Parameters
350
-
351
- Name | Type | Description | Notes
352
- ------------- | ------------- | ------------- | -------------
353
- **client_id** | [**String**](.md)| UUID client_id |
354
- **show_clients** | **BOOLEAN**| show_clients | [optional] [default to false]
355
-
356
- ### Return type
357
-
358
- **Object**
359
-
360
- ### Authorization
361
-
362
- [oauth2](../README.md#oauth2)
363
-
364
- ### HTTP request headers
365
-
366
- - **Content-Type**: Not defined
367
- - **Accept**: */*
368
-
369
-
370
-
371
- # **get_client_all_using_get**
372
- > PageClient get_client_all_using_get(opts)
373
-
374
- List all clients
375
-
376
- Get details for all clients registered with your firm.
377
-
378
- ### Example
379
- ```ruby
380
- # load the gem
381
- require 'nucleus_api'
382
- # Setup authorization
383
- NucleusApi.configure do |config|
384
- # Use one of the below method to generate oauth token
385
- # Creating a token for grant_type=client_credentials
386
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
387
- # Creating a token for grant_type=password
388
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
389
- # Creating a token using client token
390
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
391
- end
392
-
393
- api_instance = NucleusApi::ClientApi.new
394
-
395
- opts = {
396
- ascending: false, # BOOLEAN | ascending
397
- filter: 'filter_example', # String | filter
398
- order_by: 'update_date', # String | order_by
399
- page: 0, # Integer | page
400
- size: 25 # Integer | size
401
- }
402
-
403
- begin
404
- #List all clients
405
- result = api_instance.get_client_all_using_get(opts)
406
- p result
407
- rescue NucleusApi::ApiError => e
408
- puts "Exception when calling ClientApi->get_client_all_using_get: #{e}"
409
- end
410
- ```
411
-
412
- ### Parameters
413
-
414
- Name | Type | Description | Notes
415
- ------------- | ------------- | ------------- | -------------
416
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
417
- **filter** | **String**| filter | [optional]
418
- **order_by** | **String**| order_by | [optional] [default to update_date]
419
- **page** | **Integer**| page | [optional] [default to 0]
420
- **size** | **Integer**| size | [optional] [default to 25]
421
-
422
- ### Return type
423
-
424
- [**PageClient**](PageClient.md)
425
-
426
- ### Authorization
427
-
428
- [oauth2](../README.md#oauth2)
429
-
430
- ### HTTP request headers
431
-
432
- - **Content-Type**: Not defined
433
- - **Accept**: */*
434
-
435
-
436
-
437
- # **get_client_asset_size_using_get**
438
- > Array<AvailableDateDoubleVO> get_client_asset_size_using_get(client_id, opts)
439
-
440
- List all client asset sizes
441
-
442
- Get a list of asset sizes per date for a client.
443
-
444
- ### Example
445
- ```ruby
446
- # load the gem
447
- require 'nucleus_api'
448
- # Setup authorization
449
- NucleusApi.configure do |config|
450
- # Use one of the below method to generate oauth token
451
- # Creating a token for grant_type=client_credentials
452
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
453
- # Creating a token for grant_type=password
454
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
455
- # Creating a token using client token
456
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
457
- end
458
-
459
- api_instance = NucleusApi::ClientApi.new
460
-
461
- client_id = 'client_id_example' # String | UUID client_id
462
-
463
- opts = {
464
- currency_conversion: 'currency_conversion_example', # String | Currency Code
465
- end_date: Date.parse('null'), # Date | end date
466
- exclude_subledger: false, # BOOLEAN | exclude_subledger
467
- get_latest: true, # BOOLEAN | true or false
468
- sort_type: 'sort_type_example', # String | Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in ()
469
- start_date: Date.parse('null') # Date | start date
470
- }
471
-
472
- begin
473
- #List all client asset sizes
474
- result = api_instance.get_client_asset_size_using_get(client_id, opts)
475
- p result
476
- rescue NucleusApi::ApiError => e
477
- puts "Exception when calling ClientApi->get_client_asset_size_using_get: #{e}"
478
- end
479
- ```
480
-
481
- ### Parameters
482
-
483
- Name | Type | Description | Notes
484
- ------------- | ------------- | ------------- | -------------
485
- **client_id** | [**String**](.md)| UUID client_id |
486
- **currency_conversion** | **String**| Currency Code | [optional]
487
- **end_date** | **Date**| end date | [optional] [default to null]
488
- **exclude_subledger** | **BOOLEAN**| exclude_subledger | [optional] [default to false]
489
- **get_latest** | **BOOLEAN**| true or false | [optional]
490
- **sort_type** | **String**| Quarter (Q), Monthly (M) , Annually (Y), Daily (D) --caps matter, codes in () | [optional]
491
- **start_date** | **Date**| start date | [optional] [default to null]
492
-
493
- ### Return type
494
-
495
- [**Array<AvailableDateDoubleVO>**](AvailableDateDoubleVO.md)
496
-
497
- ### Authorization
498
-
499
- [oauth2](../README.md#oauth2)
500
-
501
- ### HTTP request headers
502
-
503
- - **Content-Type**: Not defined
504
- - **Accept**: */*
505
-
506
-
507
-
508
- # **get_client_goal_overview_using_get**
509
- > VClientGoalViewData get_client_goal_overview_using_get(client_id, opts)
510
-
511
- Retrieve client's goal details
512
-
513
- Retrieve client's goal details
514
-
515
- ### Example
516
- ```ruby
517
- # load the gem
518
- require 'nucleus_api'
519
- # Setup authorization
520
- NucleusApi.configure do |config|
521
- # Use one of the below method to generate oauth token
522
- # Creating a token for grant_type=client_credentials
523
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
524
- # Creating a token for grant_type=password
525
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
526
- # Creating a token using client token
527
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
528
- end
529
-
530
- api_instance = NucleusApi::ClientApi.new
531
-
532
- client_id = 'client_id_example' # String | UUID client_id
533
-
534
- opts = {
535
- portfolio_goal: false # BOOLEAN | portfolio_goal
536
- }
537
-
538
- begin
539
- #Retrieve client's goal details
540
- result = api_instance.get_client_goal_overview_using_get(client_id, opts)
541
- p result
542
- rescue NucleusApi::ApiError => e
543
- puts "Exception when calling ClientApi->get_client_goal_overview_using_get: #{e}"
544
- end
545
- ```
546
-
547
- ### Parameters
548
-
549
- Name | Type | Description | Notes
550
- ------------- | ------------- | ------------- | -------------
551
- **client_id** | [**String**](.md)| UUID client_id |
552
- **portfolio_goal** | **BOOLEAN**| portfolio_goal | [optional] [default to false]
553
-
554
- ### Return type
555
-
556
- [**VClientGoalViewData**](VClientGoalViewData.md)
557
-
558
- ### Authorization
559
-
560
- [oauth2](../README.md#oauth2)
561
-
562
- ### HTTP request headers
563
-
564
- - **Content-Type**: Not defined
565
- - **Accept**: */*
566
-
567
-
568
-
569
- # **get_client_holding_using_get**
570
- > Array<PortfolioHoldingAgg> get_client_holding_using_get(client_id, opts)
571
-
572
- List all client holdings
573
-
574
- Get the information for all the securities that are currently being held by a client registered with your firm.
575
-
576
- ### Example
577
- ```ruby
578
- # load the gem
579
- require 'nucleus_api'
580
- # Setup authorization
581
- NucleusApi.configure do |config|
582
- # Use one of the below method to generate oauth token
583
- # Creating a token for grant_type=client_credentials
584
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
585
- # Creating a token for grant_type=password
586
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
587
- # Creating a token using client token
588
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
589
- end
590
-
591
- api_instance = NucleusApi::ClientApi.new
592
-
593
- client_id = 'client_id_example' # String | UUID client_id
594
-
595
- opts = {
596
- currency_conversion: 'currency_conversion_example', # String | Currency Code
597
- end_date: 'end_date_example', # String | end date - yyyy-mm-dd
598
- get_latest: true, # BOOLEAN | true or false
599
- start_date: 'start_date_example' # String | start date - yyyy-mm-dd
600
- }
601
-
602
- begin
603
- #List all client holdings
604
- result = api_instance.get_client_holding_using_get(client_id, opts)
605
- p result
606
- rescue NucleusApi::ApiError => e
607
- puts "Exception when calling ClientApi->get_client_holding_using_get: #{e}"
608
- end
609
- ```
610
-
611
- ### Parameters
612
-
613
- Name | Type | Description | Notes
614
- ------------- | ------------- | ------------- | -------------
615
- **client_id** | [**String**](.md)| UUID client_id |
616
- **currency_conversion** | **String**| Currency Code | [optional]
617
- **end_date** | **String**| end date - yyyy-mm-dd | [optional]
618
- **get_latest** | **BOOLEAN**| true or false | [optional]
619
- **start_date** | **String**| start date - yyyy-mm-dd | [optional]
620
-
621
- ### Return type
622
-
623
- [**Array<PortfolioHoldingAgg>**](PortfolioHoldingAgg.md)
624
-
625
- ### Authorization
626
-
627
- [oauth2](../README.md#oauth2)
628
-
629
- ### HTTP request headers
630
-
631
- - **Content-Type**: Not defined
632
- - **Accept**: */*
633
-
634
-
635
-
636
- # **get_client_status_all_using_get**
637
- > PageClientStatus get_client_status_all_using_get(opts)
638
-
639
- List all client statuses
640
-
641
- Get the client status history information for all clients.
642
-
643
- ### Example
644
- ```ruby
645
- # load the gem
646
- require 'nucleus_api'
647
- # Setup authorization
648
- NucleusApi.configure do |config|
649
- # Use one of the below method to generate oauth token
650
- # Creating a token for grant_type=client_credentials
651
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
652
- # Creating a token for grant_type=password
653
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
654
- # Creating a token using client token
655
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
656
- end
657
-
658
- api_instance = NucleusApi::ClientApi.new
659
-
660
- opts = {
661
- ascending: false, # BOOLEAN | ascending
662
- filter: 'filter_example', # String | filter
663
- order_by: 'update_date', # String | order_by
664
- page: 0, # Integer | page
665
- size: 25 # Integer | size
666
- }
667
-
668
- begin
669
- #List all client statuses
670
- result = api_instance.get_client_status_all_using_get(opts)
671
- p result
672
- rescue NucleusApi::ApiError => e
673
- puts "Exception when calling ClientApi->get_client_status_all_using_get: #{e}"
674
- end
675
- ```
676
-
677
- ### Parameters
678
-
679
- Name | Type | Description | Notes
680
- ------------- | ------------- | ------------- | -------------
681
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
682
- **filter** | **String**| filter | [optional]
683
- **order_by** | **String**| order_by | [optional] [default to update_date]
684
- **page** | **Integer**| page | [optional] [default to 0]
685
- **size** | **Integer**| size | [optional] [default to 25]
686
-
687
- ### Return type
688
-
689
- [**PageClientStatus**](PageClientStatus.md)
690
-
691
- ### Authorization
692
-
693
- [oauth2](../README.md#oauth2)
694
-
695
- ### HTTP request headers
696
-
697
- - **Content-Type**: Not defined
698
- - **Accept**: */*
699
-
700
-
701
-
702
- # **get_client_status_using_get**
703
- > ClientStatus get_client_status_using_get(client_status_id)
704
-
705
- Retrieve an client status
706
-
707
- Retrieve the information for a specific client status record for an client.
708
-
709
- ### Example
710
- ```ruby
711
- # load the gem
712
- require 'nucleus_api'
713
- # Setup authorization
714
- NucleusApi.configure do |config|
715
- # Use one of the below method to generate oauth token
716
- # Creating a token for grant_type=client_credentials
717
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
718
- # Creating a token for grant_type=password
719
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
720
- # Creating a token using client token
721
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
722
- end
723
-
724
- api_instance = NucleusApi::ClientApi.new
725
-
726
- client_status_id = 'client_status_id_example' # String | UUID client_status_id
727
-
728
-
729
- begin
730
- #Retrieve an client status
731
- result = api_instance.get_client_status_using_get(client_status_id)
732
- p result
733
- rescue NucleusApi::ApiError => e
734
- puts "Exception when calling ClientApi->get_client_status_using_get: #{e}"
735
- end
736
- ```
737
-
738
- ### Parameters
739
-
740
- Name | Type | Description | Notes
741
- ------------- | ------------- | ------------- | -------------
742
- **client_status_id** | [**String**](.md)| UUID client_status_id |
743
-
744
- ### Return type
745
-
746
- [**ClientStatus**](ClientStatus.md)
747
-
748
- ### Authorization
749
-
750
- [oauth2](../README.md#oauth2)
751
-
752
- ### HTTP request headers
753
-
754
- - **Content-Type**: Not defined
755
- - **Accept**: */*
756
-
757
-
758
-
759
- # **get_client_transaction_all_using_get**
760
- > PagePortfolioTransaction get_client_transaction_all_using_get(client_id, opts)
761
-
762
- List all client transactions
763
-
764
- Get the information for all transactions under a client registered with your firm.
765
-
766
- ### Example
767
- ```ruby
768
- # load the gem
769
- require 'nucleus_api'
770
- # Setup authorization
771
- NucleusApi.configure do |config|
772
- # Use one of the below method to generate oauth token
773
- # Creating a token for grant_type=client_credentials
774
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
775
- # Creating a token for grant_type=password
776
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
777
- # Creating a token using client token
778
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
779
- end
780
-
781
- api_instance = NucleusApi::ClientApi.new
782
-
783
- client_id = 'client_id_example' # String | UUID client_id
784
-
785
- opts = {
786
- ascending: false, # BOOLEAN | ascending
787
- currency_conversion: 'currency_conversion_example', # String | currency_conversion
788
- end_date: 'end_date_example', # String | end date - yyyy-mm-dd
789
- order_by: 'update_date', # String | order_by
790
- page: 0, # Integer | page
791
- size: 25, # Integer | size
792
- start_date: 'start_date_example' # String | start date - yyyy-mm-dd
793
- }
794
-
795
- begin
796
- #List all client transactions
797
- result = api_instance.get_client_transaction_all_using_get(client_id, opts)
798
- p result
799
- rescue NucleusApi::ApiError => e
800
- puts "Exception when calling ClientApi->get_client_transaction_all_using_get: #{e}"
801
- end
802
- ```
803
-
804
- ### Parameters
805
-
806
- Name | Type | Description | Notes
807
- ------------- | ------------- | ------------- | -------------
808
- **client_id** | [**String**](.md)| UUID client_id |
809
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
810
- **currency_conversion** | **String**| currency_conversion | [optional]
811
- **end_date** | **String**| end date - yyyy-mm-dd | [optional]
812
- **order_by** | **String**| order_by | [optional] [default to update_date]
813
- **page** | **Integer**| page | [optional] [default to 0]
814
- **size** | **Integer**| size | [optional] [default to 25]
815
- **start_date** | **String**| start date - yyyy-mm-dd | [optional]
816
-
817
- ### Return type
818
-
819
- [**PagePortfolioTransaction**](PagePortfolioTransaction.md)
820
-
821
- ### Authorization
822
-
823
- [oauth2](../README.md#oauth2)
824
-
825
- ### HTTP request headers
826
-
827
- - **Content-Type**: Not defined
828
- - **Accept**: */*
829
-
830
-
831
-
832
- # **get_client_using_get**
833
- > Client get_client_using_get(client_id)
834
-
835
- Retrieve a client
836
-
837
- Retrieve the information for a client registered with your firm.
838
-
839
- ### Example
840
- ```ruby
841
- # load the gem
842
- require 'nucleus_api'
843
- # Setup authorization
844
- NucleusApi.configure do |config|
845
- # Use one of the below method to generate oauth token
846
- # Creating a token for grant_type=client_credentials
847
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
848
- # Creating a token for grant_type=password
849
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
850
- # Creating a token using client token
851
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
852
- end
853
-
854
- api_instance = NucleusApi::ClientApi.new
855
-
856
- client_id = 'client_id_example' # String | UUID client_id
857
-
858
-
859
- begin
860
- #Retrieve a client
861
- result = api_instance.get_client_using_get(client_id)
862
- p result
863
- rescue NucleusApi::ApiError => e
864
- puts "Exception when calling ClientApi->get_client_using_get: #{e}"
865
- end
866
- ```
867
-
868
- ### Parameters
869
-
870
- Name | Type | Description | Notes
871
- ------------- | ------------- | ------------- | -------------
872
- **client_id** | [**String**](.md)| UUID client_id |
873
-
874
- ### Return type
875
-
876
- [**Client**](Client.md)
877
-
878
- ### Authorization
879
-
880
- [oauth2](../README.md#oauth2)
881
-
882
- ### HTTP request headers
883
-
884
- - **Content-Type**: Not defined
885
- - **Accept**: */*
886
-
887
-
888
-
889
- # **update_client_status_using_put**
890
- > ClientStatus update_client_status_using_put(client_status, client_status_id)
891
-
892
- Update an client status
893
-
894
- Update an client status record for an client.
895
-
896
- ### Example
897
- ```ruby
898
- # load the gem
899
- require 'nucleus_api'
900
- # Setup authorization
901
- NucleusApi.configure do |config|
902
- # Use one of the below method to generate oauth token
903
- # Creating a token for grant_type=client_credentials
904
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
905
- # Creating a token for grant_type=password
906
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
907
- # Creating a token using client token
908
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
909
- end
910
-
911
- api_instance = NucleusApi::ClientApi.new
912
-
913
- client_status = nil # Object | client_status
914
-
915
- client_status_id = 'client_status_id_example' # String | UUID client_status_id
916
-
917
-
918
- begin
919
- #Update an client status
920
- result = api_instance.update_client_status_using_put(client_status, client_status_id)
921
- p result
922
- rescue NucleusApi::ApiError => e
923
- puts "Exception when calling ClientApi->update_client_status_using_put: #{e}"
924
- end
925
- ```
926
-
927
- ### Parameters
928
-
929
- Name | Type | Description | Notes
930
- ------------- | ------------- | ------------- | -------------
931
- **client_status** | **Object**| client_status |
932
- **client_status_id** | [**String**](.md)| UUID client_status_id |
933
-
934
- ### Return type
935
-
936
- [**ClientStatus**](ClientStatus.md)
937
-
938
- ### Authorization
939
-
940
- [oauth2](../README.md#oauth2)
941
-
942
- ### HTTP request headers
943
-
944
- - **Content-Type**: application/json
945
- - **Accept**: */*
946
-
947
-
948
-
949
- # **update_client_using_put**
950
- > Client update_client_using_put(client, client_id)
951
-
952
- Update a client
953
-
954
- Update the information for a client registered with your firm.
955
-
956
- ### Example
957
- ```ruby
958
- # load the gem
959
- require 'nucleus_api'
960
- # Setup authorization
961
- NucleusApi.configure do |config|
962
- # Use one of the below method to generate oauth token
963
- # Creating a token for grant_type=client_credentials
964
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
965
- # Creating a token for grant_type=password
966
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
967
- # Creating a token using client token
968
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
969
- end
970
-
971
- api_instance = NucleusApi::ClientApi.new
972
-
973
- client = nil # Object | client
974
-
975
- client_id = 'client_id_example' # String | UUID client_id
976
-
977
-
978
- begin
979
- #Update a client
980
- result = api_instance.update_client_using_put(client, client_id)
981
- p result
982
- rescue NucleusApi::ApiError => e
983
- puts "Exception when calling ClientApi->update_client_using_put: #{e}"
984
- end
985
- ```
986
-
987
- ### Parameters
988
-
989
- Name | Type | Description | Notes
990
- ------------- | ------------- | ------------- | -------------
991
- **client** | **Object**| client |
992
- **client_id** | [**String**](.md)| UUID client_id |
993
-
994
- ### Return type
995
-
996
- [**Client**](Client.md)
997
-
998
- ### Authorization
999
-
1000
- [oauth2](../README.md#oauth2)
1001
-
1002
- ### HTTP request headers
1003
-
1004
- - **Content-Type**: application/json
1005
- - **Accept**: */*
1006
-
1007
-
1008
-