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/InvoicePayment.md DELETED
@@ -1,15 +0,0 @@
1
- # NucleusApi::InvoicePayment
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **create_date** | **DateTime** | | [optional]
7
- **currency_code** | **String** | currency_code |
8
- **id** | **String** | | [optional]
9
- **invoice_id** | **String** | invoiceId |
10
- **payment_amount** | **Float** | paymentAmount |
11
- **payment_date** | **DateTime** | paymentDate |
12
- **secondary_id** | **String** | | [optional]
13
- **update_date** | **DateTime** | | [optional]
14
-
15
-
data/docs/JsonNode.md DELETED
@@ -1,29 +0,0 @@
1
- # NucleusApi::JsonNode
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **array** | **BOOLEAN** | | [optional]
7
- **big_decimal** | **BOOLEAN** | | [optional]
8
- **big_integer** | **BOOLEAN** | | [optional]
9
- **binary** | **BOOLEAN** | | [optional]
10
- **boolean** | **BOOLEAN** | | [optional]
11
- **container_node** | **BOOLEAN** | | [optional]
12
- **double** | **BOOLEAN** | | [optional]
13
- **empty** | **BOOLEAN** | | [optional]
14
- **float** | **BOOLEAN** | | [optional]
15
- **floating_point_number** | **BOOLEAN** | | [optional]
16
- **int** | **BOOLEAN** | | [optional]
17
- **integral_number** | **BOOLEAN** | | [optional]
18
- **long** | **BOOLEAN** | | [optional]
19
- **missing_node** | **BOOLEAN** | | [optional]
20
- **node_type** | **String** | | [optional]
21
- **null** | **BOOLEAN** | | [optional]
22
- **number** | **BOOLEAN** | | [optional]
23
- **object** | **BOOLEAN** | | [optional]
24
- **pojo** | **BOOLEAN** | | [optional]
25
- **short** | **BOOLEAN** | | [optional]
26
- **textual** | **BOOLEAN** | | [optional]
27
- **value_node** | **BOOLEAN** | | [optional]
28
-
29
-
data/docs/LineItems.md DELETED
@@ -1,15 +0,0 @@
1
- # NucleusApi::LineItems
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **amount** | **Float** | amount |
7
- **currency_code** | **String** | currency_code |
8
- **description** | **String** | description |
9
- **line_item_id** | **String** | lineItemId | [optional]
10
- **quantity** | **Float** | quantity |
11
- **rate** | **Float** | rate |
12
- **subtotal** | **Float** | subtotal | [optional]
13
- **tax** | **Float** | tax | [optional]
14
-
15
-
data/docs/Location.md DELETED
@@ -1,15 +0,0 @@
1
- # NucleusApi::Location
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **address_line1** | **String** | addressLine1 | [optional]
7
- **address_line2** | **String** | addressLine2 | [optional]
8
- **city** | **String** | city | [optional]
9
- **country** | **String** | country | [optional]
10
- **latitude** | **Float** | latitude | [optional]
11
- **longitude** | **Float** | longitude | [optional]
12
- **postalcode** | **String** | postalcode | [optional]
13
- **state** | **String** | state | [optional]
14
-
15
-
data/docs/MXMerchantRes.md DELETED
@@ -1,14 +0,0 @@
1
- # NucleusApi::MXMerchantRes
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **created_at** | **DateTime** | | [optional]
7
- **guid** | **String** | | [optional]
8
- **id** | **String** | | [optional]
9
- **logo_url** | **String** | | [optional]
10
- **name** | **String** | | [optional]
11
- **updated_at** | **DateTime** | | [optional]
12
- **website_url** | **String** | | [optional]
13
-
14
-
data/docs/Member.md DELETED
@@ -1,11 +0,0 @@
1
- # NucleusApi::Member
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **client_id** | **String** | clientId |
7
- **client_relationships** | [**Array<ClientRelationship>**](ClientRelationship.md) | | [optional]
8
- **household** | [**Household**](Household.md) | | [optional]
9
- **is_primary** | **BOOLEAN** | isPrimary | [optional]
10
-
11
-
data/docs/MerchantCategoryCode.md DELETED
@@ -1,11 +0,0 @@
1
- # NucleusApi::MerchantCategoryCode
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **category** | **String** | category | [optional]
7
- **description** | **String** | description | [optional]
8
- **mcc** | **Integer** | mcc | [optional]
9
- **subcategory** | **String** | subcategory | [optional]
10
-
11
-
data/docs/MerchantsMap.md DELETED
@@ -1,9 +0,0 @@
1
- # NucleusApi::MerchantsMap
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **amount** | **Integer** | amount |
7
- **merchant** | **String** | merchant |
8
-
9
-
data/docs/Model.md DELETED
@@ -1,29 +0,0 @@
1
- # NucleusApi::Model
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **benchmark_id** | **String** | benchmarkId | [optional]
7
- **cash_sec** | **String** | cashSec | [optional]
8
- **category** | **String** | category | [optional]
9
- **client_id** | **String** | clientId | [optional]
10
- **create_date** | **DateTime** | | [optional]
11
- **currency_code** | **String** | currency_code | [optional]
12
- **default_drift_factor** | **Float** | defaultDriftFactor | [optional]
13
- **description** | **String** | description | [optional]
14
- **downside** | **BOOLEAN** | downside | [optional]
15
- **drift_rebal** | **BOOLEAN** | driftRebal | [optional]
16
- **id** | **String** | | [optional]
17
- **is_active** | **BOOLEAN** | isActive | [optional]
18
- **metadata** | **Hash<String, String>** | | [optional]
19
- **name** | **String** | name |
20
- **node_map** | [**Array<AllocationNodeMap>**](AllocationNodeMap.md) | | [optional]
21
- **period_rebal** | **BOOLEAN** | periodRebal | [optional]
22
- **rebalance_period** | **Integer** | rebalancePeriod | [optional]
23
- **safe_sec** | **String** | safeSec | [optional]
24
- **sec_rotation** | **BOOLEAN** | secRotation | [optional]
25
- **secondary_id** | **String** | | [optional]
26
- **tax_efficiency_id** | **Integer** | taxEfficiencyId | [optional]
27
- **update_date** | **DateTime** | | [optional]
28
-
29
-
data/docs/ModelApi.md DELETED
@@ -1,1580 +0,0 @@
1
- # NucleusApi::ModelApi
2
-
3
- All URIs are relative to *https://sandbox.hydrogenplatform.com/nucleus/v1*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_model_asset_size_using_post**](ModelApi.md#create_model_asset_size_using_post) | **POST** /model_asset_size | Create a model asset size
8
- [**create_model_change_using_post**](ModelApi.md#create_model_change_using_post) | **POST** /model/{model_id}/model_change | Change a model composition
9
- [**create_model_comment_using_post**](ModelApi.md#create_model_comment_using_post) | **POST** /model_comment | Create a model commentary
10
- [**create_model_holding_using_post**](ModelApi.md#create_model_holding_using_post) | **POST** /model_holding | Create a model holding
11
- [**create_model_transaction_using_post**](ModelApi.md#create_model_transaction_using_post) | **POST** /model_transaction | Create a model transaction
12
- [**create_model_using_post**](ModelApi.md#create_model_using_post) | **POST** /model | Create a model
13
- [**delete_model_asset_size_using_delete**](ModelApi.md#delete_model_asset_size_using_delete) | **DELETE** /model_asset_size/{model_asset_size_id} | Delete a model asset size
14
- [**delete_model_comment_using_delete**](ModelApi.md#delete_model_comment_using_delete) | **DELETE** /model_comment/{model_comment_id} | Delete a model commentary
15
- [**delete_model_holding_using_delete**](ModelApi.md#delete_model_holding_using_delete) | **DELETE** /model_holding/{model_holding_id} | Delete a model holding
16
- [**delete_model_transaction_using_delete**](ModelApi.md#delete_model_transaction_using_delete) | **DELETE** /model_transaction/{model_transaction_id} | Delete a model transaction
17
- [**delete_model_using_delete**](ModelApi.md#delete_model_using_delete) | **DELETE** /model/{model_id} | Delete a model
18
- [**get_model_all_using_get**](ModelApi.md#get_model_all_using_get) | **GET** /model | List all models
19
- [**get_model_asset_size_all_using_get**](ModelApi.md#get_model_asset_size_all_using_get) | **GET** /model_asset_size | List all model asset sizes
20
- [**get_model_asset_size_using_get**](ModelApi.md#get_model_asset_size_using_get) | **GET** /model_asset_size/{model_asset_size_id} | Retrieve a model asset size
21
- [**get_model_comment_all_using_get**](ModelApi.md#get_model_comment_all_using_get) | **GET** /model_comment | List all model commentaries
22
- [**get_model_comment_using_get**](ModelApi.md#get_model_comment_using_get) | **GET** /model_comment/{model_comment_id} | Retrieve a model commentary
23
- [**get_model_holding_all_using_get**](ModelApi.md#get_model_holding_all_using_get) | **GET** /model_holding | List all model holdings
24
- [**get_model_holding_using_get**](ModelApi.md#get_model_holding_using_get) | **GET** /model_holding/{model_holding_id} | Retrieve a model holding
25
- [**get_model_transaction_all_using_get**](ModelApi.md#get_model_transaction_all_using_get) | **GET** /model_transaction | List all model transactions
26
- [**get_model_transaction_using_get**](ModelApi.md#get_model_transaction_using_get) | **GET** /model_transaction/{model_transaction_id} | Retrieve a model transaction
27
- [**get_model_using_get**](ModelApi.md#get_model_using_get) | **GET** /model/{model_id} | Retrieve a model
28
- [**update_model_asset_size_using_put**](ModelApi.md#update_model_asset_size_using_put) | **PUT** /model_asset_size/{model_asset_size_id} | Update a model asset size
29
- [**update_model_comment_using_put**](ModelApi.md#update_model_comment_using_put) | **PUT** /model_comment/{model_comment_id} | Update a model commentary
30
- [**update_model_holding_using_put**](ModelApi.md#update_model_holding_using_put) | **PUT** /model_holding/{model_holding_id} | Update a model holding
31
- [**update_model_transaction_using_put**](ModelApi.md#update_model_transaction_using_put) | **PUT** /model_transaction/{model_transaction_id} | Update a model transaction
32
- [**update_model_using_put**](ModelApi.md#update_model_using_put) | **PUT** /model/{model_id} | Update a model
33
-
34
-
35
- # **create_model_asset_size_using_post**
36
- > ModelAssetSize create_model_asset_size_using_post(req)
37
-
38
- Create a model asset size
39
-
40
- Create a new asset size record for a model.
41
-
42
- ### Example
43
- ```ruby
44
- # load the gem
45
- require 'nucleus_api'
46
- # Setup authorization
47
- NucleusApi.configure do |config|
48
- # Use one of the below method to generate oauth token
49
- # Creating a token for grant_type=client_credentials
50
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
51
- # Creating a token for grant_type=password
52
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
53
- # Creating a token using client token
54
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
55
- end
56
-
57
- api_instance = NucleusApi::ModelApi.new
58
-
59
- req = NucleusApi::ModelAssetSize.new # ModelAssetSize | req
60
-
61
-
62
- begin
63
- #Create a model asset size
64
- result = api_instance.create_model_asset_size_using_post(req)
65
- p result
66
- rescue NucleusApi::ApiError => e
67
- puts "Exception when calling ModelApi->create_model_asset_size_using_post: #{e}"
68
- end
69
- ```
70
-
71
- ### Parameters
72
-
73
- Name | Type | Description | Notes
74
- ------------- | ------------- | ------------- | -------------
75
- **req** | [**ModelAssetSize**](ModelAssetSize.md)| req |
76
-
77
- ### Return type
78
-
79
- [**ModelAssetSize**](ModelAssetSize.md)
80
-
81
- ### Authorization
82
-
83
- [oauth2](../README.md#oauth2)
84
-
85
- ### HTTP request headers
86
-
87
- - **Content-Type**: application/json
88
- - **Accept**: */*
89
-
90
-
91
-
92
- # **create_model_change_using_post**
93
- > Array<ModelTransaction> create_model_change_using_post(change_request, model_id)
94
-
95
- Change a model composition
96
-
97
- Model composition changes represent a change in a model’s holdings.
98
-
99
- ### Example
100
- ```ruby
101
- # load the gem
102
- require 'nucleus_api'
103
- # Setup authorization
104
- NucleusApi.configure do |config|
105
- # Use one of the below method to generate oauth token
106
- # Creating a token for grant_type=client_credentials
107
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
108
- # Creating a token for grant_type=password
109
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
110
- # Creating a token using client token
111
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
112
- end
113
-
114
- api_instance = NucleusApi::ModelApi.new
115
-
116
- change_request = NucleusApi::OrderReconcileRequest.new # OrderReconcileRequest | changeRequest
117
-
118
- model_id = 'model_id_example' # String | UUID model_id
119
-
120
-
121
- begin
122
- #Change a model composition
123
- result = api_instance.create_model_change_using_post(change_request, model_id)
124
- p result
125
- rescue NucleusApi::ApiError => e
126
- puts "Exception when calling ModelApi->create_model_change_using_post: #{e}"
127
- end
128
- ```
129
-
130
- ### Parameters
131
-
132
- Name | Type | Description | Notes
133
- ------------- | ------------- | ------------- | -------------
134
- **change_request** | [**OrderReconcileRequest**](OrderReconcileRequest.md)| changeRequest |
135
- **model_id** | [**String**](.md)| UUID model_id |
136
-
137
- ### Return type
138
-
139
- [**Array<ModelTransaction>**](ModelTransaction.md)
140
-
141
- ### Authorization
142
-
143
- [oauth2](../README.md#oauth2)
144
-
145
- ### HTTP request headers
146
-
147
- - **Content-Type**: application/json
148
- - **Accept**: */*
149
-
150
-
151
-
152
- # **create_model_comment_using_post**
153
- > Integer create_model_comment_using_post(model_comment_request)
154
-
155
- Create a model commentary
156
-
157
- Create a new comment for a model available for your firm.
158
-
159
- ### Example
160
- ```ruby
161
- # load the gem
162
- require 'nucleus_api'
163
- # Setup authorization
164
- NucleusApi.configure do |config|
165
- # Use one of the below method to generate oauth token
166
- # Creating a token for grant_type=client_credentials
167
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
168
- # Creating a token for grant_type=password
169
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
170
- # Creating a token using client token
171
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
172
- end
173
-
174
- api_instance = NucleusApi::ModelApi.new
175
-
176
- model_comment_request = NucleusApi::ModelComment.new # ModelComment | modelCommentRequest
177
-
178
-
179
- begin
180
- #Create a model commentary
181
- result = api_instance.create_model_comment_using_post(model_comment_request)
182
- p result
183
- rescue NucleusApi::ApiError => e
184
- puts "Exception when calling ModelApi->create_model_comment_using_post: #{e}"
185
- end
186
- ```
187
-
188
- ### Parameters
189
-
190
- Name | Type | Description | Notes
191
- ------------- | ------------- | ------------- | -------------
192
- **model_comment_request** | [**ModelComment**](ModelComment.md)| modelCommentRequest |
193
-
194
- ### Return type
195
-
196
- **Integer**
197
-
198
- ### Authorization
199
-
200
- [oauth2](../README.md#oauth2)
201
-
202
- ### HTTP request headers
203
-
204
- - **Content-Type**: application/json
205
- - **Accept**: */*
206
-
207
-
208
-
209
- # **create_model_holding_using_post**
210
- > ModelHolding create_model_holding_using_post(model_holding_request)
211
-
212
- Create a model holding
213
-
214
- Create a new model holding record for a specific model and date.
215
-
216
- ### Example
217
- ```ruby
218
- # load the gem
219
- require 'nucleus_api'
220
- # Setup authorization
221
- NucleusApi.configure do |config|
222
- # Use one of the below method to generate oauth token
223
- # Creating a token for grant_type=client_credentials
224
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
225
- # Creating a token for grant_type=password
226
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
227
- # Creating a token using client token
228
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
229
- end
230
-
231
- api_instance = NucleusApi::ModelApi.new
232
-
233
- model_holding_request = NucleusApi::ModelHolding.new # ModelHolding | modelHoldingRequest
234
-
235
-
236
- begin
237
- #Create a model holding
238
- result = api_instance.create_model_holding_using_post(model_holding_request)
239
- p result
240
- rescue NucleusApi::ApiError => e
241
- puts "Exception when calling ModelApi->create_model_holding_using_post: #{e}"
242
- end
243
- ```
244
-
245
- ### Parameters
246
-
247
- Name | Type | Description | Notes
248
- ------------- | ------------- | ------------- | -------------
249
- **model_holding_request** | [**ModelHolding**](ModelHolding.md)| modelHoldingRequest |
250
-
251
- ### Return type
252
-
253
- [**ModelHolding**](ModelHolding.md)
254
-
255
- ### Authorization
256
-
257
- [oauth2](../README.md#oauth2)
258
-
259
- ### HTTP request headers
260
-
261
- - **Content-Type**: application/json
262
- - **Accept**: */*
263
-
264
-
265
-
266
- # **create_model_transaction_using_post**
267
- > ModelTransaction create_model_transaction_using_post(model_transaction_request)
268
-
269
- Create a model transaction
270
-
271
- Create a new transaction record for a security under a model for a specific date.
272
-
273
- ### Example
274
- ```ruby
275
- # load the gem
276
- require 'nucleus_api'
277
- # Setup authorization
278
- NucleusApi.configure do |config|
279
- # Use one of the below method to generate oauth token
280
- # Creating a token for grant_type=client_credentials
281
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
282
- # Creating a token for grant_type=password
283
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
284
- # Creating a token using client token
285
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
286
- end
287
-
288
- api_instance = NucleusApi::ModelApi.new
289
-
290
- model_transaction_request = NucleusApi::ModelTransaction.new # ModelTransaction | modelTransactionRequest
291
-
292
-
293
- begin
294
- #Create a model transaction
295
- result = api_instance.create_model_transaction_using_post(model_transaction_request)
296
- p result
297
- rescue NucleusApi::ApiError => e
298
- puts "Exception when calling ModelApi->create_model_transaction_using_post: #{e}"
299
- end
300
- ```
301
-
302
- ### Parameters
303
-
304
- Name | Type | Description | Notes
305
- ------------- | ------------- | ------------- | -------------
306
- **model_transaction_request** | [**ModelTransaction**](ModelTransaction.md)| modelTransactionRequest |
307
-
308
- ### Return type
309
-
310
- [**ModelTransaction**](ModelTransaction.md)
311
-
312
- ### Authorization
313
-
314
- [oauth2](../README.md#oauth2)
315
-
316
- ### HTTP request headers
317
-
318
- - **Content-Type**: application/json
319
- - **Accept**: */*
320
-
321
-
322
-
323
- # **create_model_using_post**
324
- > Model create_model_using_post(model_info_request)
325
-
326
- Create a model
327
-
328
- Create a new model for your firm to which a portfolios can later subscribe.
329
-
330
- ### Example
331
- ```ruby
332
- # load the gem
333
- require 'nucleus_api'
334
- # Setup authorization
335
- NucleusApi.configure do |config|
336
- # Use one of the below method to generate oauth token
337
- # Creating a token for grant_type=client_credentials
338
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
339
- # Creating a token for grant_type=password
340
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
341
- # Creating a token using client token
342
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
343
- end
344
-
345
- api_instance = NucleusApi::ModelApi.new
346
-
347
- model_info_request = NucleusApi::Model.new # Model | modelInfoRequest
348
-
349
-
350
- begin
351
- #Create a model
352
- result = api_instance.create_model_using_post(model_info_request)
353
- p result
354
- rescue NucleusApi::ApiError => e
355
- puts "Exception when calling ModelApi->create_model_using_post: #{e}"
356
- end
357
- ```
358
-
359
- ### Parameters
360
-
361
- Name | Type | Description | Notes
362
- ------------- | ------------- | ------------- | -------------
363
- **model_info_request** | [**Model**](Model.md)| modelInfoRequest |
364
-
365
- ### Return type
366
-
367
- [**Model**](Model.md)
368
-
369
- ### Authorization
370
-
371
- [oauth2](../README.md#oauth2)
372
-
373
- ### HTTP request headers
374
-
375
- - **Content-Type**: application/json
376
- - **Accept**: */*
377
-
378
-
379
-
380
- # **delete_model_asset_size_using_delete**
381
- > delete_model_asset_size_using_delete(model_asset_size_id)
382
-
383
- Delete a model asset size
384
-
385
- Permanently delete a model asset size record for a model.
386
-
387
- ### Example
388
- ```ruby
389
- # load the gem
390
- require 'nucleus_api'
391
- # Setup authorization
392
- NucleusApi.configure do |config|
393
- # Use one of the below method to generate oauth token
394
- # Creating a token for grant_type=client_credentials
395
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
396
- # Creating a token for grant_type=password
397
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
398
- # Creating a token using client token
399
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
400
- end
401
-
402
- api_instance = NucleusApi::ModelApi.new
403
-
404
- model_asset_size_id = 'model_asset_size_id_example' # String | UUID model_asset_size_id
405
-
406
-
407
- begin
408
- #Delete a model asset size
409
- api_instance.delete_model_asset_size_using_delete(model_asset_size_id)
410
- rescue NucleusApi::ApiError => e
411
- puts "Exception when calling ModelApi->delete_model_asset_size_using_delete: #{e}"
412
- end
413
- ```
414
-
415
- ### Parameters
416
-
417
- Name | Type | Description | Notes
418
- ------------- | ------------- | ------------- | -------------
419
- **model_asset_size_id** | [**String**](.md)| UUID model_asset_size_id |
420
-
421
- ### Return type
422
-
423
- nil (empty response body)
424
-
425
- ### Authorization
426
-
427
- [oauth2](../README.md#oauth2)
428
-
429
- ### HTTP request headers
430
-
431
- - **Content-Type**: Not defined
432
- - **Accept**: */*
433
-
434
-
435
-
436
- # **delete_model_comment_using_delete**
437
- > delete_model_comment_using_delete(model_comment_id)
438
-
439
- Delete a model commentary
440
-
441
- Permanently delete a model comment for a model
442
-
443
- ### Example
444
- ```ruby
445
- # load the gem
446
- require 'nucleus_api'
447
- # Setup authorization
448
- NucleusApi.configure do |config|
449
- # Use one of the below method to generate oauth token
450
- # Creating a token for grant_type=client_credentials
451
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
452
- # Creating a token for grant_type=password
453
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
454
- # Creating a token using client token
455
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
456
- end
457
-
458
- api_instance = NucleusApi::ModelApi.new
459
-
460
- model_comment_id = 'model_comment_id_example' # String | UUID model_comment_id
461
-
462
-
463
- begin
464
- #Delete a model commentary
465
- api_instance.delete_model_comment_using_delete(model_comment_id)
466
- rescue NucleusApi::ApiError => e
467
- puts "Exception when calling ModelApi->delete_model_comment_using_delete: #{e}"
468
- end
469
- ```
470
-
471
- ### Parameters
472
-
473
- Name | Type | Description | Notes
474
- ------------- | ------------- | ------------- | -------------
475
- **model_comment_id** | [**String**](.md)| UUID model_comment_id |
476
-
477
- ### Return type
478
-
479
- nil (empty response body)
480
-
481
- ### Authorization
482
-
483
- [oauth2](../README.md#oauth2)
484
-
485
- ### HTTP request headers
486
-
487
- - **Content-Type**: Not defined
488
- - **Accept**: */*
489
-
490
-
491
-
492
- # **delete_model_holding_using_delete**
493
- > delete_model_holding_using_delete(model_holding_id)
494
-
495
- Delete a model holding
496
-
497
- Permanently delete a model holding record for a model.
498
-
499
- ### Example
500
- ```ruby
501
- # load the gem
502
- require 'nucleus_api'
503
- # Setup authorization
504
- NucleusApi.configure do |config|
505
- # Use one of the below method to generate oauth token
506
- # Creating a token for grant_type=client_credentials
507
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
508
- # Creating a token for grant_type=password
509
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
510
- # Creating a token using client token
511
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
512
- end
513
-
514
- api_instance = NucleusApi::ModelApi.new
515
-
516
- model_holding_id = 'model_holding_id_example' # String | UUID model_holding_id
517
-
518
-
519
- begin
520
- #Delete a model holding
521
- api_instance.delete_model_holding_using_delete(model_holding_id)
522
- rescue NucleusApi::ApiError => e
523
- puts "Exception when calling ModelApi->delete_model_holding_using_delete: #{e}"
524
- end
525
- ```
526
-
527
- ### Parameters
528
-
529
- Name | Type | Description | Notes
530
- ------------- | ------------- | ------------- | -------------
531
- **model_holding_id** | [**String**](.md)| UUID model_holding_id |
532
-
533
- ### Return type
534
-
535
- nil (empty response body)
536
-
537
- ### Authorization
538
-
539
- [oauth2](../README.md#oauth2)
540
-
541
- ### HTTP request headers
542
-
543
- - **Content-Type**: Not defined
544
- - **Accept**: */*
545
-
546
-
547
-
548
- # **delete_model_transaction_using_delete**
549
- > delete_model_transaction_using_delete(model_transaction_id)
550
-
551
- Delete a model transaction
552
-
553
- Permanently delete a model transaction for a model.
554
-
555
- ### Example
556
- ```ruby
557
- # load the gem
558
- require 'nucleus_api'
559
- # Setup authorization
560
- NucleusApi.configure do |config|
561
- # Use one of the below method to generate oauth token
562
- # Creating a token for grant_type=client_credentials
563
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
564
- # Creating a token for grant_type=password
565
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
566
- # Creating a token using client token
567
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
568
- end
569
-
570
- api_instance = NucleusApi::ModelApi.new
571
-
572
- model_transaction_id = 'model_transaction_id_example' # String | UUID model_transaction_id
573
-
574
-
575
- begin
576
- #Delete a model transaction
577
- api_instance.delete_model_transaction_using_delete(model_transaction_id)
578
- rescue NucleusApi::ApiError => e
579
- puts "Exception when calling ModelApi->delete_model_transaction_using_delete: #{e}"
580
- end
581
- ```
582
-
583
- ### Parameters
584
-
585
- Name | Type | Description | Notes
586
- ------------- | ------------- | ------------- | -------------
587
- **model_transaction_id** | [**String**](.md)| UUID model_transaction_id |
588
-
589
- ### Return type
590
-
591
- nil (empty response body)
592
-
593
- ### Authorization
594
-
595
- [oauth2](../README.md#oauth2)
596
-
597
- ### HTTP request headers
598
-
599
- - **Content-Type**: Not defined
600
- - **Accept**: */*
601
-
602
-
603
-
604
- # **delete_model_using_delete**
605
- > delete_model_using_delete(model_id)
606
-
607
- Delete a model
608
-
609
- Permanently delete a model for your firm.
610
-
611
- ### Example
612
- ```ruby
613
- # load the gem
614
- require 'nucleus_api'
615
- # Setup authorization
616
- NucleusApi.configure do |config|
617
- # Use one of the below method to generate oauth token
618
- # Creating a token for grant_type=client_credentials
619
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
620
- # Creating a token for grant_type=password
621
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
622
- # Creating a token using client token
623
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
624
- end
625
-
626
- api_instance = NucleusApi::ModelApi.new
627
-
628
- model_id = 'model_id_example' # String | UUID model_id
629
-
630
-
631
- begin
632
- #Delete a model
633
- api_instance.delete_model_using_delete(model_id)
634
- rescue NucleusApi::ApiError => e
635
- puts "Exception when calling ModelApi->delete_model_using_delete: #{e}"
636
- end
637
- ```
638
-
639
- ### Parameters
640
-
641
- Name | Type | Description | Notes
642
- ------------- | ------------- | ------------- | -------------
643
- **model_id** | [**String**](.md)| UUID model_id |
644
-
645
- ### Return type
646
-
647
- nil (empty response body)
648
-
649
- ### Authorization
650
-
651
- [oauth2](../README.md#oauth2)
652
-
653
- ### HTTP request headers
654
-
655
- - **Content-Type**: Not defined
656
- - **Accept**: */*
657
-
658
-
659
-
660
- # **get_model_all_using_get**
661
- > PageModel get_model_all_using_get(opts)
662
-
663
- List all models
664
-
665
- Get details for all models defined for your firm to which portfolios can subscribe.
666
-
667
- ### Example
668
- ```ruby
669
- # load the gem
670
- require 'nucleus_api'
671
- # Setup authorization
672
- NucleusApi.configure do |config|
673
- # Use one of the below method to generate oauth token
674
- # Creating a token for grant_type=client_credentials
675
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
676
- # Creating a token for grant_type=password
677
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
678
- # Creating a token using client token
679
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
680
- end
681
-
682
- api_instance = NucleusApi::ModelApi.new
683
-
684
- opts = {
685
- ascending: false, # BOOLEAN | ascending
686
- filter: 'filter_example', # String | filter
687
- order_by: 'update_date', # String | order_by
688
- page: 0, # Integer | page
689
- size: 25 # Integer | size
690
- }
691
-
692
- begin
693
- #List all models
694
- result = api_instance.get_model_all_using_get(opts)
695
- p result
696
- rescue NucleusApi::ApiError => e
697
- puts "Exception when calling ModelApi->get_model_all_using_get: #{e}"
698
- end
699
- ```
700
-
701
- ### Parameters
702
-
703
- Name | Type | Description | Notes
704
- ------------- | ------------- | ------------- | -------------
705
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
706
- **filter** | **String**| filter | [optional]
707
- **order_by** | **String**| order_by | [optional] [default to update_date]
708
- **page** | **Integer**| page | [optional] [default to 0]
709
- **size** | **Integer**| size | [optional] [default to 25]
710
-
711
- ### Return type
712
-
713
- [**PageModel**](PageModel.md)
714
-
715
- ### Authorization
716
-
717
- [oauth2](../README.md#oauth2)
718
-
719
- ### HTTP request headers
720
-
721
- - **Content-Type**: Not defined
722
- - **Accept**: */*
723
-
724
-
725
-
726
- # **get_model_asset_size_all_using_get**
727
- > PageModelAssetSize get_model_asset_size_all_using_get(opts)
728
-
729
- List all model asset sizes
730
-
731
- Get a list of asset sizes per date for all models defined for your firm.
732
-
733
- ### Example
734
- ```ruby
735
- # load the gem
736
- require 'nucleus_api'
737
- # Setup authorization
738
- NucleusApi.configure do |config|
739
- # Use one of the below method to generate oauth token
740
- # Creating a token for grant_type=client_credentials
741
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
742
- # Creating a token for grant_type=password
743
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
744
- # Creating a token using client token
745
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
746
- end
747
-
748
- api_instance = NucleusApi::ModelApi.new
749
-
750
- opts = {
751
- ascending: false, # BOOLEAN | ascending
752
- currency_conversion: 'currency_conversion_example', # String | currency_conversion
753
- filter: 'filter_example', # String | filter
754
- order_by: 'update_date', # String | order_by
755
- page: 0, # Integer | page
756
- size: 25 # Integer | size
757
- }
758
-
759
- begin
760
- #List all model asset sizes
761
- result = api_instance.get_model_asset_size_all_using_get(opts)
762
- p result
763
- rescue NucleusApi::ApiError => e
764
- puts "Exception when calling ModelApi->get_model_asset_size_all_using_get: #{e}"
765
- end
766
- ```
767
-
768
- ### Parameters
769
-
770
- Name | Type | Description | Notes
771
- ------------- | ------------- | ------------- | -------------
772
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
773
- **currency_conversion** | **String**| currency_conversion | [optional]
774
- **filter** | **String**| filter | [optional]
775
- **order_by** | **String**| order_by | [optional] [default to update_date]
776
- **page** | **Integer**| page | [optional] [default to 0]
777
- **size** | **Integer**| size | [optional] [default to 25]
778
-
779
- ### Return type
780
-
781
- [**PageModelAssetSize**](PageModelAssetSize.md)
782
-
783
- ### Authorization
784
-
785
- [oauth2](../README.md#oauth2)
786
-
787
- ### HTTP request headers
788
-
789
- - **Content-Type**: Not defined
790
- - **Accept**: */*
791
-
792
-
793
-
794
- # **get_model_asset_size_using_get**
795
- > ModelAssetSize get_model_asset_size_using_get(model_asset_size_id, opts)
796
-
797
- Retrieve a model asset size
798
-
799
- Retrieve the information for a model asset size record for a model.
800
-
801
- ### Example
802
- ```ruby
803
- # load the gem
804
- require 'nucleus_api'
805
- # Setup authorization
806
- NucleusApi.configure do |config|
807
- # Use one of the below method to generate oauth token
808
- # Creating a token for grant_type=client_credentials
809
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
810
- # Creating a token for grant_type=password
811
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
812
- # Creating a token using client token
813
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
814
- end
815
-
816
- api_instance = NucleusApi::ModelApi.new
817
-
818
- model_asset_size_id = 'model_asset_size_id_example' # String | UUID model_asset_size_id
819
-
820
- opts = {
821
- currency_conversion: 'currency_conversion_example' # String | USD
822
- }
823
-
824
- begin
825
- #Retrieve a model asset size
826
- result = api_instance.get_model_asset_size_using_get(model_asset_size_id, opts)
827
- p result
828
- rescue NucleusApi::ApiError => e
829
- puts "Exception when calling ModelApi->get_model_asset_size_using_get: #{e}"
830
- end
831
- ```
832
-
833
- ### Parameters
834
-
835
- Name | Type | Description | Notes
836
- ------------- | ------------- | ------------- | -------------
837
- **model_asset_size_id** | [**String**](.md)| UUID model_asset_size_id |
838
- **currency_conversion** | **String**| USD | [optional]
839
-
840
- ### Return type
841
-
842
- [**ModelAssetSize**](ModelAssetSize.md)
843
-
844
- ### Authorization
845
-
846
- [oauth2](../README.md#oauth2)
847
-
848
- ### HTTP request headers
849
-
850
- - **Content-Type**: Not defined
851
- - **Accept**: */*
852
-
853
-
854
-
855
- # **get_model_comment_all_using_get**
856
- > PageModelComment get_model_comment_all_using_get(opts)
857
-
858
- List all model commentaries
859
-
860
- List all comments for all models defined by your firm.
861
-
862
- ### Example
863
- ```ruby
864
- # load the gem
865
- require 'nucleus_api'
866
- # Setup authorization
867
- NucleusApi.configure do |config|
868
- # Use one of the below method to generate oauth token
869
- # Creating a token for grant_type=client_credentials
870
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
871
- # Creating a token for grant_type=password
872
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
873
- # Creating a token using client token
874
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
875
- end
876
-
877
- api_instance = NucleusApi::ModelApi.new
878
-
879
- opts = {
880
- ascending: false, # BOOLEAN | ascending
881
- filter: 'filter_example', # String | filter
882
- order_by: 'update_date', # String | order_by
883
- page: 0, # Integer | page
884
- size: 25 # Integer | size
885
- }
886
-
887
- begin
888
- #List all model commentaries
889
- result = api_instance.get_model_comment_all_using_get(opts)
890
- p result
891
- rescue NucleusApi::ApiError => e
892
- puts "Exception when calling ModelApi->get_model_comment_all_using_get: #{e}"
893
- end
894
- ```
895
-
896
- ### Parameters
897
-
898
- Name | Type | Description | Notes
899
- ------------- | ------------- | ------------- | -------------
900
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
901
- **filter** | **String**| filter | [optional]
902
- **order_by** | **String**| order_by | [optional] [default to update_date]
903
- **page** | **Integer**| page | [optional] [default to 0]
904
- **size** | **Integer**| size | [optional] [default to 25]
905
-
906
- ### Return type
907
-
908
- [**PageModelComment**](PageModelComment.md)
909
-
910
- ### Authorization
911
-
912
- [oauth2](../README.md#oauth2)
913
-
914
- ### HTTP request headers
915
-
916
- - **Content-Type**: Not defined
917
- - **Accept**: */*
918
-
919
-
920
-
921
- # **get_model_comment_using_get**
922
- > ModelComment get_model_comment_using_get(model_comment_id)
923
-
924
- Retrieve a model commentary
925
-
926
- Retrieve the information for a model comment for a model.
927
-
928
- ### Example
929
- ```ruby
930
- # load the gem
931
- require 'nucleus_api'
932
- # Setup authorization
933
- NucleusApi.configure do |config|
934
- # Use one of the below method to generate oauth token
935
- # Creating a token for grant_type=client_credentials
936
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
937
- # Creating a token for grant_type=password
938
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
939
- # Creating a token using client token
940
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
941
- end
942
-
943
- api_instance = NucleusApi::ModelApi.new
944
-
945
- model_comment_id = 'model_comment_id_example' # String | UUID model_comment_id
946
-
947
-
948
- begin
949
- #Retrieve a model commentary
950
- result = api_instance.get_model_comment_using_get(model_comment_id)
951
- p result
952
- rescue NucleusApi::ApiError => e
953
- puts "Exception when calling ModelApi->get_model_comment_using_get: #{e}"
954
- end
955
- ```
956
-
957
- ### Parameters
958
-
959
- Name | Type | Description | Notes
960
- ------------- | ------------- | ------------- | -------------
961
- **model_comment_id** | [**String**](.md)| UUID model_comment_id |
962
-
963
- ### Return type
964
-
965
- [**ModelComment**](ModelComment.md)
966
-
967
- ### Authorization
968
-
969
- [oauth2](../README.md#oauth2)
970
-
971
- ### HTTP request headers
972
-
973
- - **Content-Type**: Not defined
974
- - **Accept**: */*
975
-
976
-
977
-
978
- # **get_model_holding_all_using_get**
979
- > PageModelHolding get_model_holding_all_using_get(opts)
980
-
981
- List all model holdings
982
-
983
- Get all model holding records for all models defined for your firm.
984
-
985
- ### Example
986
- ```ruby
987
- # load the gem
988
- require 'nucleus_api'
989
- # Setup authorization
990
- NucleusApi.configure do |config|
991
- # Use one of the below method to generate oauth token
992
- # Creating a token for grant_type=client_credentials
993
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
994
- # Creating a token for grant_type=password
995
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
996
- # Creating a token using client token
997
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
998
- end
999
-
1000
- api_instance = NucleusApi::ModelApi.new
1001
-
1002
- opts = {
1003
- ascending: false, # BOOLEAN | ascending
1004
- filter: 'filter_example', # String | filter
1005
- order_by: 'update_date', # String | order_by
1006
- page: 0, # Integer | page
1007
- size: 25 # Integer | size
1008
- }
1009
-
1010
- begin
1011
- #List all model holdings
1012
- result = api_instance.get_model_holding_all_using_get(opts)
1013
- p result
1014
- rescue NucleusApi::ApiError => e
1015
- puts "Exception when calling ModelApi->get_model_holding_all_using_get: #{e}"
1016
- end
1017
- ```
1018
-
1019
- ### Parameters
1020
-
1021
- Name | Type | Description | Notes
1022
- ------------- | ------------- | ------------- | -------------
1023
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
1024
- **filter** | **String**| filter | [optional]
1025
- **order_by** | **String**| order_by | [optional] [default to update_date]
1026
- **page** | **Integer**| page | [optional] [default to 0]
1027
- **size** | **Integer**| size | [optional] [default to 25]
1028
-
1029
- ### Return type
1030
-
1031
- [**PageModelHolding**](PageModelHolding.md)
1032
-
1033
- ### Authorization
1034
-
1035
- [oauth2](../README.md#oauth2)
1036
-
1037
- ### HTTP request headers
1038
-
1039
- - **Content-Type**: Not defined
1040
- - **Accept**: */*
1041
-
1042
-
1043
-
1044
- # **get_model_holding_using_get**
1045
- > ModelHolding get_model_holding_using_get(model_holding_id)
1046
-
1047
- Retrieve a model holding
1048
-
1049
- Retrieve the information for a model holding record for a model.
1050
-
1051
- ### Example
1052
- ```ruby
1053
- # load the gem
1054
- require 'nucleus_api'
1055
- # Setup authorization
1056
- NucleusApi.configure do |config|
1057
- # Use one of the below method to generate oauth token
1058
- # Creating a token for grant_type=client_credentials
1059
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1060
- # Creating a token for grant_type=password
1061
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1062
- # Creating a token using client token
1063
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1064
- end
1065
-
1066
- api_instance = NucleusApi::ModelApi.new
1067
-
1068
- model_holding_id = 'model_holding_id_example' # String | UUID model_holding_id
1069
-
1070
-
1071
- begin
1072
- #Retrieve a model holding
1073
- result = api_instance.get_model_holding_using_get(model_holding_id)
1074
- p result
1075
- rescue NucleusApi::ApiError => e
1076
- puts "Exception when calling ModelApi->get_model_holding_using_get: #{e}"
1077
- end
1078
- ```
1079
-
1080
- ### Parameters
1081
-
1082
- Name | Type | Description | Notes
1083
- ------------- | ------------- | ------------- | -------------
1084
- **model_holding_id** | [**String**](.md)| UUID model_holding_id |
1085
-
1086
- ### Return type
1087
-
1088
- [**ModelHolding**](ModelHolding.md)
1089
-
1090
- ### Authorization
1091
-
1092
- [oauth2](../README.md#oauth2)
1093
-
1094
- ### HTTP request headers
1095
-
1096
- - **Content-Type**: Not defined
1097
- - **Accept**: */*
1098
-
1099
-
1100
-
1101
- # **get_model_transaction_all_using_get**
1102
- > PageModelTransaction get_model_transaction_all_using_get(opts)
1103
-
1104
- List all model transactions
1105
-
1106
- Get details for all transaction records for all models defined by your firm.
1107
-
1108
- ### Example
1109
- ```ruby
1110
- # load the gem
1111
- require 'nucleus_api'
1112
- # Setup authorization
1113
- NucleusApi.configure do |config|
1114
- # Use one of the below method to generate oauth token
1115
- # Creating a token for grant_type=client_credentials
1116
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1117
- # Creating a token for grant_type=password
1118
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1119
- # Creating a token using client token
1120
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1121
- end
1122
-
1123
- api_instance = NucleusApi::ModelApi.new
1124
-
1125
- opts = {
1126
- ascending: false, # BOOLEAN | ascending
1127
- filter: 'filter_example', # String | filter
1128
- order_by: 'update_date', # String | order_by
1129
- page: 0, # Integer | page
1130
- size: 25 # Integer | size
1131
- }
1132
-
1133
- begin
1134
- #List all model transactions
1135
- result = api_instance.get_model_transaction_all_using_get(opts)
1136
- p result
1137
- rescue NucleusApi::ApiError => e
1138
- puts "Exception when calling ModelApi->get_model_transaction_all_using_get: #{e}"
1139
- end
1140
- ```
1141
-
1142
- ### Parameters
1143
-
1144
- Name | Type | Description | Notes
1145
- ------------- | ------------- | ------------- | -------------
1146
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
1147
- **filter** | **String**| filter | [optional]
1148
- **order_by** | **String**| order_by | [optional] [default to update_date]
1149
- **page** | **Integer**| page | [optional] [default to 0]
1150
- **size** | **Integer**| size | [optional] [default to 25]
1151
-
1152
- ### Return type
1153
-
1154
- [**PageModelTransaction**](PageModelTransaction.md)
1155
-
1156
- ### Authorization
1157
-
1158
- [oauth2](../README.md#oauth2)
1159
-
1160
- ### HTTP request headers
1161
-
1162
- - **Content-Type**: Not defined
1163
- - **Accept**: */*
1164
-
1165
-
1166
-
1167
- # **get_model_transaction_using_get**
1168
- > ModelTransaction get_model_transaction_using_get(model_transaction_id)
1169
-
1170
- Retrieve a model transaction
1171
-
1172
- Retrieve the information for a model transaction for a model.
1173
-
1174
- ### Example
1175
- ```ruby
1176
- # load the gem
1177
- require 'nucleus_api'
1178
- # Setup authorization
1179
- NucleusApi.configure do |config|
1180
- # Use one of the below method to generate oauth token
1181
- # Creating a token for grant_type=client_credentials
1182
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1183
- # Creating a token for grant_type=password
1184
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1185
- # Creating a token using client token
1186
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1187
- end
1188
-
1189
- api_instance = NucleusApi::ModelApi.new
1190
-
1191
- model_transaction_id = 'model_transaction_id_example' # String | UUID model_transaction_id
1192
-
1193
-
1194
- begin
1195
- #Retrieve a model transaction
1196
- result = api_instance.get_model_transaction_using_get(model_transaction_id)
1197
- p result
1198
- rescue NucleusApi::ApiError => e
1199
- puts "Exception when calling ModelApi->get_model_transaction_using_get: #{e}"
1200
- end
1201
- ```
1202
-
1203
- ### Parameters
1204
-
1205
- Name | Type | Description | Notes
1206
- ------------- | ------------- | ------------- | -------------
1207
- **model_transaction_id** | [**String**](.md)| UUID model_transaction_id |
1208
-
1209
- ### Return type
1210
-
1211
- [**ModelTransaction**](ModelTransaction.md)
1212
-
1213
- ### Authorization
1214
-
1215
- [oauth2](../README.md#oauth2)
1216
-
1217
- ### HTTP request headers
1218
-
1219
- - **Content-Type**: Not defined
1220
- - **Accept**: */*
1221
-
1222
-
1223
-
1224
- # **get_model_using_get**
1225
- > Model get_model_using_get(model_id)
1226
-
1227
- Retrieve a model
1228
-
1229
- Get the information for a model for your firm.
1230
-
1231
- ### Example
1232
- ```ruby
1233
- # load the gem
1234
- require 'nucleus_api'
1235
- # Setup authorization
1236
- NucleusApi.configure do |config|
1237
- # Use one of the below method to generate oauth token
1238
- # Creating a token for grant_type=client_credentials
1239
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1240
- # Creating a token for grant_type=password
1241
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1242
- # Creating a token using client token
1243
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1244
- end
1245
-
1246
- api_instance = NucleusApi::ModelApi.new
1247
-
1248
- model_id = 'model_id_example' # String | UUID model_id
1249
-
1250
-
1251
- begin
1252
- #Retrieve a model
1253
- result = api_instance.get_model_using_get(model_id)
1254
- p result
1255
- rescue NucleusApi::ApiError => e
1256
- puts "Exception when calling ModelApi->get_model_using_get: #{e}"
1257
- end
1258
- ```
1259
-
1260
- ### Parameters
1261
-
1262
- Name | Type | Description | Notes
1263
- ------------- | ------------- | ------------- | -------------
1264
- **model_id** | [**String**](.md)| UUID model_id |
1265
-
1266
- ### Return type
1267
-
1268
- [**Model**](Model.md)
1269
-
1270
- ### Authorization
1271
-
1272
- [oauth2](../README.md#oauth2)
1273
-
1274
- ### HTTP request headers
1275
-
1276
- - **Content-Type**: Not defined
1277
- - **Accept**: */*
1278
-
1279
-
1280
-
1281
- # **update_model_asset_size_using_put**
1282
- > ModelAssetSize update_model_asset_size_using_put(model_asset_size, model_asset_size_id)
1283
-
1284
- Update a model asset size
1285
-
1286
- Update a model asset size record for a model.
1287
-
1288
- ### Example
1289
- ```ruby
1290
- # load the gem
1291
- require 'nucleus_api'
1292
- # Setup authorization
1293
- NucleusApi.configure do |config|
1294
- # Use one of the below method to generate oauth token
1295
- # Creating a token for grant_type=client_credentials
1296
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1297
- # Creating a token for grant_type=password
1298
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1299
- # Creating a token using client token
1300
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1301
- end
1302
-
1303
- api_instance = NucleusApi::ModelApi.new
1304
-
1305
- model_asset_size = nil # Object | model_asset_size
1306
-
1307
- model_asset_size_id = 'model_asset_size_id_example' # String | UUID model_asset_size_id
1308
-
1309
-
1310
- begin
1311
- #Update a model asset size
1312
- result = api_instance.update_model_asset_size_using_put(model_asset_size, model_asset_size_id)
1313
- p result
1314
- rescue NucleusApi::ApiError => e
1315
- puts "Exception when calling ModelApi->update_model_asset_size_using_put: #{e}"
1316
- end
1317
- ```
1318
-
1319
- ### Parameters
1320
-
1321
- Name | Type | Description | Notes
1322
- ------------- | ------------- | ------------- | -------------
1323
- **model_asset_size** | **Object**| model_asset_size |
1324
- **model_asset_size_id** | [**String**](.md)| UUID model_asset_size_id |
1325
-
1326
- ### Return type
1327
-
1328
- [**ModelAssetSize**](ModelAssetSize.md)
1329
-
1330
- ### Authorization
1331
-
1332
- [oauth2](../README.md#oauth2)
1333
-
1334
- ### HTTP request headers
1335
-
1336
- - **Content-Type**: application/json
1337
- - **Accept**: */*
1338
-
1339
-
1340
-
1341
- # **update_model_comment_using_put**
1342
- > ModelComment update_model_comment_using_put(model_comment, model_comment_id)
1343
-
1344
- Update a model commentary
1345
-
1346
- Update a model comment for a model.
1347
-
1348
- ### Example
1349
- ```ruby
1350
- # load the gem
1351
- require 'nucleus_api'
1352
- # Setup authorization
1353
- NucleusApi.configure do |config|
1354
- # Use one of the below method to generate oauth token
1355
- # Creating a token for grant_type=client_credentials
1356
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1357
- # Creating a token for grant_type=password
1358
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1359
- # Creating a token using client token
1360
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1361
- end
1362
-
1363
- api_instance = NucleusApi::ModelApi.new
1364
-
1365
- model_comment = nil # Object | model_comment
1366
-
1367
- model_comment_id = 'model_comment_id_example' # String | UUID model_comment_id
1368
-
1369
-
1370
- begin
1371
- #Update a model commentary
1372
- result = api_instance.update_model_comment_using_put(model_comment, model_comment_id)
1373
- p result
1374
- rescue NucleusApi::ApiError => e
1375
- puts "Exception when calling ModelApi->update_model_comment_using_put: #{e}"
1376
- end
1377
- ```
1378
-
1379
- ### Parameters
1380
-
1381
- Name | Type | Description | Notes
1382
- ------------- | ------------- | ------------- | -------------
1383
- **model_comment** | **Object**| model_comment |
1384
- **model_comment_id** | [**String**](.md)| UUID model_comment_id |
1385
-
1386
- ### Return type
1387
-
1388
- [**ModelComment**](ModelComment.md)
1389
-
1390
- ### Authorization
1391
-
1392
- [oauth2](../README.md#oauth2)
1393
-
1394
- ### HTTP request headers
1395
-
1396
- - **Content-Type**: application/json
1397
- - **Accept**: */*
1398
-
1399
-
1400
-
1401
- # **update_model_holding_using_put**
1402
- > ModelHolding update_model_holding_using_put(model_holding, model_holding_id)
1403
-
1404
- Update a model holding
1405
-
1406
- Update a model holding record for a model.
1407
-
1408
- ### Example
1409
- ```ruby
1410
- # load the gem
1411
- require 'nucleus_api'
1412
- # Setup authorization
1413
- NucleusApi.configure do |config|
1414
- # Use one of the below method to generate oauth token
1415
- # Creating a token for grant_type=client_credentials
1416
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1417
- # Creating a token for grant_type=password
1418
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1419
- # Creating a token using client token
1420
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1421
- end
1422
-
1423
- api_instance = NucleusApi::ModelApi.new
1424
-
1425
- model_holding = nil # Object | model_holding
1426
-
1427
- model_holding_id = 'model_holding_id_example' # String | UUID model_holding_id
1428
-
1429
-
1430
- begin
1431
- #Update a model holding
1432
- result = api_instance.update_model_holding_using_put(model_holding, model_holding_id)
1433
- p result
1434
- rescue NucleusApi::ApiError => e
1435
- puts "Exception when calling ModelApi->update_model_holding_using_put: #{e}"
1436
- end
1437
- ```
1438
-
1439
- ### Parameters
1440
-
1441
- Name | Type | Description | Notes
1442
- ------------- | ------------- | ------------- | -------------
1443
- **model_holding** | **Object**| model_holding |
1444
- **model_holding_id** | [**String**](.md)| UUID model_holding_id |
1445
-
1446
- ### Return type
1447
-
1448
- [**ModelHolding**](ModelHolding.md)
1449
-
1450
- ### Authorization
1451
-
1452
- [oauth2](../README.md#oauth2)
1453
-
1454
- ### HTTP request headers
1455
-
1456
- - **Content-Type**: application/json
1457
- - **Accept**: */*
1458
-
1459
-
1460
-
1461
- # **update_model_transaction_using_put**
1462
- > ModelTransaction update_model_transaction_using_put(model_transaction, model_transaction_id)
1463
-
1464
- Update a model transaction
1465
-
1466
- Update a model transaction for a model.
1467
-
1468
- ### Example
1469
- ```ruby
1470
- # load the gem
1471
- require 'nucleus_api'
1472
- # Setup authorization
1473
- NucleusApi.configure do |config|
1474
- # Use one of the below method to generate oauth token
1475
- # Creating a token for grant_type=client_credentials
1476
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1477
- # Creating a token for grant_type=password
1478
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1479
- # Creating a token using client token
1480
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1481
- end
1482
-
1483
- api_instance = NucleusApi::ModelApi.new
1484
-
1485
- model_transaction = nil # Object | model_transaction
1486
-
1487
- model_transaction_id = 'model_transaction_id_example' # String | UUID model_transaction_id
1488
-
1489
-
1490
- begin
1491
- #Update a model transaction
1492
- result = api_instance.update_model_transaction_using_put(model_transaction, model_transaction_id)
1493
- p result
1494
- rescue NucleusApi::ApiError => e
1495
- puts "Exception when calling ModelApi->update_model_transaction_using_put: #{e}"
1496
- end
1497
- ```
1498
-
1499
- ### Parameters
1500
-
1501
- Name | Type | Description | Notes
1502
- ------------- | ------------- | ------------- | -------------
1503
- **model_transaction** | **Object**| model_transaction |
1504
- **model_transaction_id** | [**String**](.md)| UUID model_transaction_id |
1505
-
1506
- ### Return type
1507
-
1508
- [**ModelTransaction**](ModelTransaction.md)
1509
-
1510
- ### Authorization
1511
-
1512
- [oauth2](../README.md#oauth2)
1513
-
1514
- ### HTTP request headers
1515
-
1516
- - **Content-Type**: application/json
1517
- - **Accept**: */*
1518
-
1519
-
1520
-
1521
- # **update_model_using_put**
1522
- > Model update_model_using_put(model, model_id)
1523
-
1524
- Update a model
1525
-
1526
- Update a model for your firm.
1527
-
1528
- ### Example
1529
- ```ruby
1530
- # load the gem
1531
- require 'nucleus_api'
1532
- # Setup authorization
1533
- NucleusApi.configure do |config|
1534
- # Use one of the below method to generate oauth token
1535
- # Creating a token for grant_type=client_credentials
1536
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1537
- # Creating a token for grant_type=password
1538
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1539
- # Creating a token using client token
1540
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1541
- end
1542
-
1543
- api_instance = NucleusApi::ModelApi.new
1544
-
1545
- model = nil # Object | model
1546
-
1547
- model_id = 'model_id_example' # String | UUID model_id
1548
-
1549
-
1550
- begin
1551
- #Update a model
1552
- result = api_instance.update_model_using_put(model, model_id)
1553
- p result
1554
- rescue NucleusApi::ApiError => e
1555
- puts "Exception when calling ModelApi->update_model_using_put: #{e}"
1556
- end
1557
- ```
1558
-
1559
- ### Parameters
1560
-
1561
- Name | Type | Description | Notes
1562
- ------------- | ------------- | ------------- | -------------
1563
- **model** | **Object**| model |
1564
- **model_id** | [**String**](.md)| UUID model_id |
1565
-
1566
- ### Return type
1567
-
1568
- [**Model**](Model.md)
1569
-
1570
- ### Authorization
1571
-
1572
- [oauth2](../README.md#oauth2)
1573
-
1574
- ### HTTP request headers
1575
-
1576
- - **Content-Type**: application/json
1577
- - **Accept**: */*
1578
-
1579
-
1580
-