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