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