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