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
@@ -1,20 +0,0 @@
1
- # NucleusApi::PortfolioAssetSizeLog
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **account_id** | **String** | accountId |
7
- **asset_size** | **Float** | asset_size |
8
- **asset_size_available** | **Float** | asset_size_available | [optional]
9
- **asset_size_pending** | **Float** | asset_size_pending | [optional]
10
- **cash_flow** | **Float** | cash_flow |
11
- **create_date** | **DateTime** | | [optional]
12
- **currency_code** | **String** | currency_code | [optional]
13
- **date** | **DateTime** | date |
14
- **id** | **String** | | [optional]
15
- **model_id** | **String** | modelId |
16
- **portfolio_id** | **String** | portfolioId |
17
- **secondary_id** | **String** | | [optional]
18
- **update_date** | **DateTime** | | [optional]
19
-
20
-
@@ -1,16 +0,0 @@
1
- # NucleusApi::PortfolioComment
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **account_id** | **String** | accountId |
7
- **create_date** | **DateTime** | | [optional]
8
- **id** | **String** | | [optional]
9
- **is_read** | **BOOLEAN** | isRead | [optional]
10
- **model_comment_id** | **String** | modelCommentId |
11
- **model_id** | **String** | modelId |
12
- **portfolio_id** | **String** | portfolioId |
13
- **secondary_id** | **String** | | [optional]
14
- **update_date** | **DateTime** | | [optional]
15
-
16
-
@@ -1,14 +0,0 @@
1
- # NucleusApi::PortfolioGoal
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **create_date** | **DateTime** | | [optional]
7
- **date** | **Date** | date |
8
- **goals** | [**Array<PortfolioGoalMap>**](PortfolioGoalMap.md) | |
9
- **id** | **String** | | [optional]
10
- **portfolio_id** | **String** | portfolioId |
11
- **secondary_id** | **String** | | [optional]
12
- **update_date** | **DateTime** | | [optional]
13
-
14
-
@@ -1,9 +0,0 @@
1
- # NucleusApi::PortfolioGoalMap
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **goal_id** | **String** | goal_id |
7
- **weight** | **Float** | weight |
8
-
9
-
@@ -1,14 +0,0 @@
1
- # NucleusApi::PortfolioHoldingAgg
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **amount** | **Float** | amount | [optional]
7
- **cost_basis** | **Float** | costBasis | [optional]
8
- **currency_code** | **String** | currencyCode | [optional]
9
- **date** | **Date** | date | [optional]
10
- **security_id** | **String** | securityId | [optional]
11
- **shares** | **Float** | shares | [optional]
12
- **weight** | **Float** | weight | [optional]
13
-
14
-
@@ -1,21 +0,0 @@
1
- # NucleusApi::PortfolioHoldingLog
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **account_id** | **String** | accountId |
7
- **amount** | **Float** | amount | [optional]
8
- **cost_basis** | **Float** | cost_basis | [optional]
9
- **create_date** | **DateTime** | | [optional]
10
- **currency_code** | **String** | currency_code | [optional]
11
- **date** | **DateTime** | date |
12
- **id** | **String** | | [optional]
13
- **model_id** | **String** | modelId |
14
- **portfolio_id** | **String** | portfolioId |
15
- **secondary_id** | **String** | | [optional]
16
- **security_id** | **String** | securityId |
17
- **shares** | **Float** | shares |
18
- **update_date** | **DateTime** | | [optional]
19
- **weight** | **Float** | weight | [optional]
20
-
21
-
@@ -1,37 +0,0 @@
1
- # NucleusApi::PortfolioTransaction
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **account_id** | **String** | accountId |
7
- **amount** | **Float** | amount | [optional]
8
- **balance** | **Float** | balance | [optional]
9
- **category** | **String** | category | [optional]
10
- **check** | [**Check**](Check.md) | | [optional]
11
- **create_date** | **DateTime** | | [optional]
12
- **currency_code** | **String** | currency_code | [optional]
13
- **date** | **DateTime** | date |
14
- **date_available** | **DateTime** | dateAvailable | [optional]
15
- **description** | **String** | description | [optional]
16
- **id** | **String** | | [optional]
17
- **is_cleansed** | **BOOLEAN** | is_cleansed | [optional]
18
- **is_disputed** | **BOOLEAN** | is_disputed | [optional]
19
- **is_read** | **BOOLEAN** | isRead | [optional]
20
- **is_recurring** | **BOOLEAN** | is_recurring | [optional]
21
- **location** | [**Location**](Location.md) | location | [optional]
22
- **memo** | **String** | memo | [optional]
23
- **merchant** | **String** | merchant | [optional]
24
- **merchant_category_code** | **Integer** | merchant_category_code | [optional]
25
- **metadata** | **Hash<String, String>** | metadata | [optional]
26
- **model_id** | **String** | modelId |
27
- **portfolio_id** | **String** | portfolioId |
28
- **price** | **Float** | price | [optional]
29
- **quantity** | **Float** | quantity | [optional]
30
- **secondary_id** | **String** | | [optional]
31
- **security_id** | **String** | securityId | [optional]
32
- **status** | **String** | status | [optional]
33
- **subcategory** | **String** | subcategory | [optional]
34
- **transaction_code_id** | **String** | alertId |
35
- **update_date** | **DateTime** | | [optional]
36
-
37
-
data/docs/Question.md DELETED
@@ -1,23 +0,0 @@
1
- # NucleusApi::Question
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **answers** | [**Array<Answer>**](Answer.md) | | [optional]
7
- **category** | **String** | category | [optional]
8
- **description** | **String** | description | [optional]
9
- **document** | **String** | document | [optional]
10
- **id** | **String** | | [optional]
11
- **image** | **String** | image | [optional]
12
- **is_account** | **BOOLEAN** | is_account | [optional]
13
- **metadata** | **Hash<String, String>** | metadata | [optional]
14
- **order_index** | **String** | order_index | [optional]
15
- **question_type** | **String** | question_type | [optional]
16
- **questionnaire** | [**Questionnaire**](Questionnaire.md) | | [optional]
17
- **questionnaire_id** | **String** | questionnaireId | [optional]
18
- **subcategory** | **String** | subcategory | [optional]
19
- **title** | **String** | title | [optional]
20
- **tooltip** | **String** | tooltip | [optional]
21
- **weight** | **Float** | weight | [optional]
22
-
23
-
@@ -1,17 +0,0 @@
1
- # NucleusApi::Questionnaire
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **create_date** | **DateTime** | | [optional]
7
- **decision_tree_id** | **String** | decision_tree_id | [optional]
8
- **description** | **String** | description | [optional]
9
- **id** | **String** | | [optional]
10
- **is_active** | **BOOLEAN** | is_active | [optional]
11
- **name** | **String** | name |
12
- **questions** | [**Array<Question>**](Question.md) | | [optional]
13
- **secondary_id** | **String** | | [optional]
14
- **type** | **String** | type | [optional]
15
- **update_date** | **DateTime** | | [optional]
16
-
17
-
@@ -1,1212 +0,0 @@
1
- # NucleusApi::QuestionnaireApi
2
-
3
- All URIs are relative to *https://sandbox.hydrogenplatform.com/nucleus/v1*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_answer_using_post**](QuestionnaireApi.md#create_answer_using_post) | **POST** /answer | Create an answer
8
- [**create_client_response_using_post**](QuestionnaireApi.md#create_client_response_using_post) | **POST** /client_response | Create a client response
9
- [**create_question_using_post**](QuestionnaireApi.md#create_question_using_post) | **POST** /question | Create a question
10
- [**create_questionnaire_using_post**](QuestionnaireApi.md#create_questionnaire_using_post) | **POST** /questionnaire | Create a questionnaire
11
- [**delete_answer_using_delete**](QuestionnaireApi.md#delete_answer_using_delete) | **DELETE** /answer/{answer_id} | Delete an answer
12
- [**delete_client_response_using_delete**](QuestionnaireApi.md#delete_client_response_using_delete) | **DELETE** /client_response/{client_response_id} | Delete a client response
13
- [**delete_question_using_delete**](QuestionnaireApi.md#delete_question_using_delete) | **DELETE** /question/{question_id} | Delete a question
14
- [**delete_questionnaire_using_delete**](QuestionnaireApi.md#delete_questionnaire_using_delete) | **DELETE** /questionnaire/{questionnaire_id} | Delete a questionnaire
15
- [**get_answer_all_using_get**](QuestionnaireApi.md#get_answer_all_using_get) | **GET** /answer | List all Answers
16
- [**get_answer_using_get**](QuestionnaireApi.md#get_answer_using_get) | **GET** /answer/{answer_id} | Retrieve an answer
17
- [**get_client_response_all_using_get**](QuestionnaireApi.md#get_client_response_all_using_get) | **GET** /client_response | List all client responses
18
- [**get_client_response_using_get**](QuestionnaireApi.md#get_client_response_using_get) | **GET** /client_response/{client_response_id} | Retrieve a client response
19
- [**get_question_all_using_get**](QuestionnaireApi.md#get_question_all_using_get) | **GET** /question | List all Questions
20
- [**get_question_using_get**](QuestionnaireApi.md#get_question_using_get) | **GET** /question/{question_id} | Retrieve a question
21
- [**get_questionnaire_all_using_get**](QuestionnaireApi.md#get_questionnaire_all_using_get) | **GET** /questionnaire | List all questionnaires
22
- [**get_questionnaire_using_get**](QuestionnaireApi.md#get_questionnaire_using_get) | **GET** /questionnaire/{questionnaire_id} | Retrieve a questionnaire
23
- [**update_answer_using_put**](QuestionnaireApi.md#update_answer_using_put) | **PUT** /answer/{answer_id} | Update an answer
24
- [**update_client_response_using_put**](QuestionnaireApi.md#update_client_response_using_put) | **PUT** /client_response/{client_response_id} | Update a client response
25
- [**update_question_using_put**](QuestionnaireApi.md#update_question_using_put) | **PUT** /question/{question_id} | Update a question.
26
- [**update_questionnaire_using_put**](QuestionnaireApi.md#update_questionnaire_using_put) | **PUT** /questionnaire/{questionnaire_id} | Update a questionnaire
27
-
28
-
29
- # **create_answer_using_post**
30
- > Answer create_answer_using_post(answer)
31
-
32
- Create an answer
33
-
34
- Create a new answer for question.
35
-
36
- ### Example
37
- ```ruby
38
- # load the gem
39
- require 'nucleus_api'
40
- # Setup authorization
41
- NucleusApi.configure do |config|
42
- # Use one of the below method to generate oauth token
43
- # Creating a token for grant_type=client_credentials
44
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
45
- # Creating a token for grant_type=password
46
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
47
- # Creating a token using client token
48
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
49
- end
50
-
51
- api_instance = NucleusApi::QuestionnaireApi.new
52
-
53
- answer = NucleusApi::Answer.new # Answer | answer
54
-
55
-
56
- begin
57
- #Create an answer
58
- result = api_instance.create_answer_using_post(answer)
59
- p result
60
- rescue NucleusApi::ApiError => e
61
- puts "Exception when calling QuestionnaireApi->create_answer_using_post: #{e}"
62
- end
63
- ```
64
-
65
- ### Parameters
66
-
67
- Name | Type | Description | Notes
68
- ------------- | ------------- | ------------- | -------------
69
- **answer** | [**Answer**](Answer.md)| answer |
70
-
71
- ### Return type
72
-
73
- [**Answer**](Answer.md)
74
-
75
- ### Authorization
76
-
77
- [oauth2](../README.md#oauth2)
78
-
79
- ### HTTP request headers
80
-
81
- - **Content-Type**: application/json
82
- - **Accept**: application/json
83
-
84
-
85
-
86
- # **create_client_response_using_post**
87
- > ClientResponse create_client_response_using_post(client_response)
88
-
89
- Create a client response
90
-
91
- Create a new client response for a question as part of a questionnaires.
92
-
93
- ### Example
94
- ```ruby
95
- # load the gem
96
- require 'nucleus_api'
97
- # Setup authorization
98
- NucleusApi.configure do |config|
99
- # Use one of the below method to generate oauth token
100
- # Creating a token for grant_type=client_credentials
101
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
102
- # Creating a token for grant_type=password
103
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
104
- # Creating a token using client token
105
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
106
- end
107
-
108
- api_instance = NucleusApi::QuestionnaireApi.new
109
-
110
- client_response = NucleusApi::ClientResponse.new # ClientResponse | clientResponse
111
-
112
-
113
- begin
114
- #Create a client response
115
- result = api_instance.create_client_response_using_post(client_response)
116
- p result
117
- rescue NucleusApi::ApiError => e
118
- puts "Exception when calling QuestionnaireApi->create_client_response_using_post: #{e}"
119
- end
120
- ```
121
-
122
- ### Parameters
123
-
124
- Name | Type | Description | Notes
125
- ------------- | ------------- | ------------- | -------------
126
- **client_response** | [**ClientResponse**](ClientResponse.md)| clientResponse |
127
-
128
- ### Return type
129
-
130
- [**ClientResponse**](ClientResponse.md)
131
-
132
- ### Authorization
133
-
134
- [oauth2](../README.md#oauth2)
135
-
136
- ### HTTP request headers
137
-
138
- - **Content-Type**: application/json
139
- - **Accept**: */*
140
-
141
-
142
-
143
- # **create_question_using_post**
144
- > Question create_question_using_post(question)
145
-
146
- Create a question
147
-
148
- Create a new question for questionnaire.
149
-
150
- ### Example
151
- ```ruby
152
- # load the gem
153
- require 'nucleus_api'
154
- # Setup authorization
155
- NucleusApi.configure do |config|
156
- # Use one of the below method to generate oauth token
157
- # Creating a token for grant_type=client_credentials
158
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
159
- # Creating a token for grant_type=password
160
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
161
- # Creating a token using client token
162
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
163
- end
164
-
165
- api_instance = NucleusApi::QuestionnaireApi.new
166
-
167
- question = NucleusApi::Question.new # Question | question
168
-
169
-
170
- begin
171
- #Create a question
172
- result = api_instance.create_question_using_post(question)
173
- p result
174
- rescue NucleusApi::ApiError => e
175
- puts "Exception when calling QuestionnaireApi->create_question_using_post: #{e}"
176
- end
177
- ```
178
-
179
- ### Parameters
180
-
181
- Name | Type | Description | Notes
182
- ------------- | ------------- | ------------- | -------------
183
- **question** | [**Question**](Question.md)| question |
184
-
185
- ### Return type
186
-
187
- [**Question**](Question.md)
188
-
189
- ### Authorization
190
-
191
- [oauth2](../README.md#oauth2)
192
-
193
- ### HTTP request headers
194
-
195
- - **Content-Type**: application/json
196
- - **Accept**: application/json
197
-
198
-
199
-
200
- # **create_questionnaire_using_post**
201
- > Questionnaire create_questionnaire_using_post(questionnaire)
202
-
203
- Create a questionnaire
204
-
205
- Create a new questionnaire for your firm.
206
-
207
- ### Example
208
- ```ruby
209
- # load the gem
210
- require 'nucleus_api'
211
- # Setup authorization
212
- NucleusApi.configure do |config|
213
- # Use one of the below method to generate oauth token
214
- # Creating a token for grant_type=client_credentials
215
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
216
- # Creating a token for grant_type=password
217
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
218
- # Creating a token using client token
219
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
220
- end
221
-
222
- api_instance = NucleusApi::QuestionnaireApi.new
223
-
224
- questionnaire = NucleusApi::Questionnaire.new # Questionnaire | questionnaire
225
-
226
-
227
- begin
228
- #Create a questionnaire
229
- result = api_instance.create_questionnaire_using_post(questionnaire)
230
- p result
231
- rescue NucleusApi::ApiError => e
232
- puts "Exception when calling QuestionnaireApi->create_questionnaire_using_post: #{e}"
233
- end
234
- ```
235
-
236
- ### Parameters
237
-
238
- Name | Type | Description | Notes
239
- ------------- | ------------- | ------------- | -------------
240
- **questionnaire** | [**Questionnaire**](Questionnaire.md)| questionnaire |
241
-
242
- ### Return type
243
-
244
- [**Questionnaire**](Questionnaire.md)
245
-
246
- ### Authorization
247
-
248
- [oauth2](../README.md#oauth2)
249
-
250
- ### HTTP request headers
251
-
252
- - **Content-Type**: application/json
253
- - **Accept**: */*
254
-
255
-
256
-
257
- # **delete_answer_using_delete**
258
- > delete_answer_using_delete(answer_id)
259
-
260
- Delete an answer
261
-
262
- Delete an answer for the question
263
-
264
- ### Example
265
- ```ruby
266
- # load the gem
267
- require 'nucleus_api'
268
- # Setup authorization
269
- NucleusApi.configure do |config|
270
- # Use one of the below method to generate oauth token
271
- # Creating a token for grant_type=client_credentials
272
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
273
- # Creating a token for grant_type=password
274
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
275
- # Creating a token using client token
276
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
277
- end
278
-
279
- api_instance = NucleusApi::QuestionnaireApi.new
280
-
281
- answer_id = 'answer_id_example' # String | UUID answer_id
282
-
283
-
284
- begin
285
- #Delete an answer
286
- api_instance.delete_answer_using_delete(answer_id)
287
- rescue NucleusApi::ApiError => e
288
- puts "Exception when calling QuestionnaireApi->delete_answer_using_delete: #{e}"
289
- end
290
- ```
291
-
292
- ### Parameters
293
-
294
- Name | Type | Description | Notes
295
- ------------- | ------------- | ------------- | -------------
296
- **answer_id** | [**String**](.md)| UUID answer_id |
297
-
298
- ### Return type
299
-
300
- nil (empty response body)
301
-
302
- ### Authorization
303
-
304
- [oauth2](../README.md#oauth2)
305
-
306
- ### HTTP request headers
307
-
308
- - **Content-Type**: Not defined
309
- - **Accept**: */*
310
-
311
-
312
-
313
- # **delete_client_response_using_delete**
314
- > delete_client_response_using_delete(client_response_id)
315
-
316
- Delete a client response
317
-
318
- Permanently delete a client response for a client.
319
-
320
- ### Example
321
- ```ruby
322
- # load the gem
323
- require 'nucleus_api'
324
- # Setup authorization
325
- NucleusApi.configure do |config|
326
- # Use one of the below method to generate oauth token
327
- # Creating a token for grant_type=client_credentials
328
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
329
- # Creating a token for grant_type=password
330
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
331
- # Creating a token using client token
332
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
333
- end
334
-
335
- api_instance = NucleusApi::QuestionnaireApi.new
336
-
337
- client_response_id = 'client_response_id_example' # String | UUID client_response_id
338
-
339
-
340
- begin
341
- #Delete a client response
342
- api_instance.delete_client_response_using_delete(client_response_id)
343
- rescue NucleusApi::ApiError => e
344
- puts "Exception when calling QuestionnaireApi->delete_client_response_using_delete: #{e}"
345
- end
346
- ```
347
-
348
- ### Parameters
349
-
350
- Name | Type | Description | Notes
351
- ------------- | ------------- | ------------- | -------------
352
- **client_response_id** | [**String**](.md)| UUID client_response_id |
353
-
354
- ### Return type
355
-
356
- nil (empty response body)
357
-
358
- ### Authorization
359
-
360
- [oauth2](../README.md#oauth2)
361
-
362
- ### HTTP request headers
363
-
364
- - **Content-Type**: Not defined
365
- - **Accept**: */*
366
-
367
-
368
-
369
- # **delete_question_using_delete**
370
- > delete_question_using_delete(question_id)
371
-
372
- Delete a question
373
-
374
- Delete an answer for the question
375
-
376
- ### Example
377
- ```ruby
378
- # load the gem
379
- require 'nucleus_api'
380
- # Setup authorization
381
- NucleusApi.configure do |config|
382
- # Use one of the below method to generate oauth token
383
- # Creating a token for grant_type=client_credentials
384
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
385
- # Creating a token for grant_type=password
386
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
387
- # Creating a token using client token
388
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
389
- end
390
-
391
- api_instance = NucleusApi::QuestionnaireApi.new
392
-
393
- question_id = 'question_id_example' # String | UUID question_id
394
-
395
-
396
- begin
397
- #Delete a question
398
- api_instance.delete_question_using_delete(question_id)
399
- rescue NucleusApi::ApiError => e
400
- puts "Exception when calling QuestionnaireApi->delete_question_using_delete: #{e}"
401
- end
402
- ```
403
-
404
- ### Parameters
405
-
406
- Name | Type | Description | Notes
407
- ------------- | ------------- | ------------- | -------------
408
- **question_id** | [**String**](.md)| UUID question_id |
409
-
410
- ### Return type
411
-
412
- nil (empty response body)
413
-
414
- ### Authorization
415
-
416
- [oauth2](../README.md#oauth2)
417
-
418
- ### HTTP request headers
419
-
420
- - **Content-Type**: Not defined
421
- - **Accept**: */*
422
-
423
-
424
-
425
- # **delete_questionnaire_using_delete**
426
- > delete_questionnaire_using_delete(questionnaire_id)
427
-
428
- Delete a questionnaire
429
-
430
- Permanently delete a questionnaire for your firm.
431
-
432
- ### Example
433
- ```ruby
434
- # load the gem
435
- require 'nucleus_api'
436
- # Setup authorization
437
- NucleusApi.configure do |config|
438
- # Use one of the below method to generate oauth token
439
- # Creating a token for grant_type=client_credentials
440
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
441
- # Creating a token for grant_type=password
442
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
443
- # Creating a token using client token
444
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
445
- end
446
-
447
- api_instance = NucleusApi::QuestionnaireApi.new
448
-
449
- questionnaire_id = 'questionnaire_id_example' # String | UUID questionnaire_id
450
-
451
-
452
- begin
453
- #Delete a questionnaire
454
- api_instance.delete_questionnaire_using_delete(questionnaire_id)
455
- rescue NucleusApi::ApiError => e
456
- puts "Exception when calling QuestionnaireApi->delete_questionnaire_using_delete: #{e}"
457
- end
458
- ```
459
-
460
- ### Parameters
461
-
462
- Name | Type | Description | Notes
463
- ------------- | ------------- | ------------- | -------------
464
- **questionnaire_id** | [**String**](.md)| UUID questionnaire_id |
465
-
466
- ### Return type
467
-
468
- nil (empty response body)
469
-
470
- ### Authorization
471
-
472
- [oauth2](../README.md#oauth2)
473
-
474
- ### HTTP request headers
475
-
476
- - **Content-Type**: Not defined
477
- - **Accept**: */*
478
-
479
-
480
-
481
- # **get_answer_all_using_get**
482
- > PageAnswer get_answer_all_using_get(opts)
483
-
484
- List all Answers
485
-
486
- Get information for all Answers
487
-
488
- ### Example
489
- ```ruby
490
- # load the gem
491
- require 'nucleus_api'
492
- # Setup authorization
493
- NucleusApi.configure do |config|
494
- # Use one of the below method to generate oauth token
495
- # Creating a token for grant_type=client_credentials
496
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
497
- # Creating a token for grant_type=password
498
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
499
- # Creating a token using client token
500
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
501
- end
502
-
503
- api_instance = NucleusApi::QuestionnaireApi.new
504
-
505
- opts = {
506
- ascending: false, # BOOLEAN | ascending
507
- filter: 'filter_example', # String | filter
508
- order_by: 'label', # String | order_by
509
- page: 0, # Integer | page
510
- size: 25 # Integer | size
511
- }
512
-
513
- begin
514
- #List all Answers
515
- result = api_instance.get_answer_all_using_get(opts)
516
- p result
517
- rescue NucleusApi::ApiError => e
518
- puts "Exception when calling QuestionnaireApi->get_answer_all_using_get: #{e}"
519
- end
520
- ```
521
-
522
- ### Parameters
523
-
524
- Name | Type | Description | Notes
525
- ------------- | ------------- | ------------- | -------------
526
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
527
- **filter** | **String**| filter | [optional]
528
- **order_by** | **String**| order_by | [optional] [default to label]
529
- **page** | **Integer**| page | [optional] [default to 0]
530
- **size** | **Integer**| size | [optional] [default to 25]
531
-
532
- ### Return type
533
-
534
- [**PageAnswer**](PageAnswer.md)
535
-
536
- ### Authorization
537
-
538
- [oauth2](../README.md#oauth2)
539
-
540
- ### HTTP request headers
541
-
542
- - **Content-Type**: Not defined
543
- - **Accept**: */*
544
-
545
-
546
-
547
- # **get_answer_using_get**
548
- > Answer get_answer_using_get(answer_id)
549
-
550
- Retrieve an answer
551
-
552
- Retrieve the information for an answer for question
553
-
554
- ### Example
555
- ```ruby
556
- # load the gem
557
- require 'nucleus_api'
558
- # Setup authorization
559
- NucleusApi.configure do |config|
560
- # Use one of the below method to generate oauth token
561
- # Creating a token for grant_type=client_credentials
562
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
563
- # Creating a token for grant_type=password
564
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
565
- # Creating a token using client token
566
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
567
- end
568
-
569
- api_instance = NucleusApi::QuestionnaireApi.new
570
-
571
- answer_id = 'answer_id_example' # String | UUID answer_id
572
-
573
-
574
- begin
575
- #Retrieve an answer
576
- result = api_instance.get_answer_using_get(answer_id)
577
- p result
578
- rescue NucleusApi::ApiError => e
579
- puts "Exception when calling QuestionnaireApi->get_answer_using_get: #{e}"
580
- end
581
- ```
582
-
583
- ### Parameters
584
-
585
- Name | Type | Description | Notes
586
- ------------- | ------------- | ------------- | -------------
587
- **answer_id** | [**String**](.md)| UUID answer_id |
588
-
589
- ### Return type
590
-
591
- [**Answer**](Answer.md)
592
-
593
- ### Authorization
594
-
595
- [oauth2](../README.md#oauth2)
596
-
597
- ### HTTP request headers
598
-
599
- - **Content-Type**: Not defined
600
- - **Accept**: application/json
601
-
602
-
603
-
604
- # **get_client_response_all_using_get**
605
- > PageClientResponse get_client_response_all_using_get(opts)
606
-
607
- List all client responses
608
-
609
- Get all the client responses for questions as part of a questionnaire defined by your firm.
610
-
611
- ### Example
612
- ```ruby
613
- # load the gem
614
- require 'nucleus_api'
615
- # Setup authorization
616
- NucleusApi.configure do |config|
617
- # Use one of the below method to generate oauth token
618
- # Creating a token for grant_type=client_credentials
619
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
620
- # Creating a token for grant_type=password
621
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
622
- # Creating a token using client token
623
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
624
- end
625
-
626
- api_instance = NucleusApi::QuestionnaireApi.new
627
-
628
- opts = {
629
- ascending: false, # BOOLEAN | ascending
630
- filter: 'filter_example', # String | filter
631
- order_by: 'update_date', # String | order_by
632
- page: 0, # Integer | page
633
- size: 25 # Integer | size
634
- }
635
-
636
- begin
637
- #List all client responses
638
- result = api_instance.get_client_response_all_using_get(opts)
639
- p result
640
- rescue NucleusApi::ApiError => e
641
- puts "Exception when calling QuestionnaireApi->get_client_response_all_using_get: #{e}"
642
- end
643
- ```
644
-
645
- ### Parameters
646
-
647
- Name | Type | Description | Notes
648
- ------------- | ------------- | ------------- | -------------
649
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
650
- **filter** | **String**| filter | [optional]
651
- **order_by** | **String**| order_by | [optional] [default to update_date]
652
- **page** | **Integer**| page | [optional] [default to 0]
653
- **size** | **Integer**| size | [optional] [default to 25]
654
-
655
- ### Return type
656
-
657
- [**PageClientResponse**](PageClientResponse.md)
658
-
659
- ### Authorization
660
-
661
- [oauth2](../README.md#oauth2)
662
-
663
- ### HTTP request headers
664
-
665
- - **Content-Type**: Not defined
666
- - **Accept**: */*
667
-
668
-
669
-
670
- # **get_client_response_using_get**
671
- > ClientResponse get_client_response_using_get(client_response_id)
672
-
673
- Retrieve a client response
674
-
675
- Retrieve the information for a client response for a client.
676
-
677
- ### Example
678
- ```ruby
679
- # load the gem
680
- require 'nucleus_api'
681
- # Setup authorization
682
- NucleusApi.configure do |config|
683
- # Use one of the below method to generate oauth token
684
- # Creating a token for grant_type=client_credentials
685
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
686
- # Creating a token for grant_type=password
687
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
688
- # Creating a token using client token
689
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
690
- end
691
-
692
- api_instance = NucleusApi::QuestionnaireApi.new
693
-
694
- client_response_id = 'client_response_id_example' # String | UUID client_response_id
695
-
696
-
697
- begin
698
- #Retrieve a client response
699
- result = api_instance.get_client_response_using_get(client_response_id)
700
- p result
701
- rescue NucleusApi::ApiError => e
702
- puts "Exception when calling QuestionnaireApi->get_client_response_using_get: #{e}"
703
- end
704
- ```
705
-
706
- ### Parameters
707
-
708
- Name | Type | Description | Notes
709
- ------------- | ------------- | ------------- | -------------
710
- **client_response_id** | [**String**](.md)| UUID client_response_id |
711
-
712
- ### Return type
713
-
714
- [**ClientResponse**](ClientResponse.md)
715
-
716
- ### Authorization
717
-
718
- [oauth2](../README.md#oauth2)
719
-
720
- ### HTTP request headers
721
-
722
- - **Content-Type**: Not defined
723
- - **Accept**: */*
724
-
725
-
726
-
727
- # **get_question_all_using_get**
728
- > PageQuestion get_question_all_using_get(opts)
729
-
730
- List all Questions
731
-
732
- Get information for all Questions
733
-
734
- ### Example
735
- ```ruby
736
- # load the gem
737
- require 'nucleus_api'
738
- # Setup authorization
739
- NucleusApi.configure do |config|
740
- # Use one of the below method to generate oauth token
741
- # Creating a token for grant_type=client_credentials
742
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
743
- # Creating a token for grant_type=password
744
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
745
- # Creating a token using client token
746
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
747
- end
748
-
749
- api_instance = NucleusApi::QuestionnaireApi.new
750
-
751
- opts = {
752
- ascending: false, # BOOLEAN | ascending
753
- filter: 'filter_example', # String | filter
754
- order_by: 'order_index', # String | order_by
755
- page: 0, # Integer | page
756
- size: 25 # Integer | size
757
- }
758
-
759
- begin
760
- #List all Questions
761
- result = api_instance.get_question_all_using_get(opts)
762
- p result
763
- rescue NucleusApi::ApiError => e
764
- puts "Exception when calling QuestionnaireApi->get_question_all_using_get: #{e}"
765
- end
766
- ```
767
-
768
- ### Parameters
769
-
770
- Name | Type | Description | Notes
771
- ------------- | ------------- | ------------- | -------------
772
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
773
- **filter** | **String**| filter | [optional]
774
- **order_by** | **String**| order_by | [optional] [default to order_index]
775
- **page** | **Integer**| page | [optional] [default to 0]
776
- **size** | **Integer**| size | [optional] [default to 25]
777
-
778
- ### Return type
779
-
780
- [**PageQuestion**](PageQuestion.md)
781
-
782
- ### Authorization
783
-
784
- [oauth2](../README.md#oauth2)
785
-
786
- ### HTTP request headers
787
-
788
- - **Content-Type**: Not defined
789
- - **Accept**: */*
790
-
791
-
792
-
793
- # **get_question_using_get**
794
- > Question get_question_using_get(question_id)
795
-
796
- Retrieve a question
797
-
798
- Retrieve the information for a question for questionnaire
799
-
800
- ### Example
801
- ```ruby
802
- # load the gem
803
- require 'nucleus_api'
804
- # Setup authorization
805
- NucleusApi.configure do |config|
806
- # Use one of the below method to generate oauth token
807
- # Creating a token for grant_type=client_credentials
808
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
809
- # Creating a token for grant_type=password
810
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
811
- # Creating a token using client token
812
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
813
- end
814
-
815
- api_instance = NucleusApi::QuestionnaireApi.new
816
-
817
- question_id = 'question_id_example' # String | UUID question_id
818
-
819
-
820
- begin
821
- #Retrieve a question
822
- result = api_instance.get_question_using_get(question_id)
823
- p result
824
- rescue NucleusApi::ApiError => e
825
- puts "Exception when calling QuestionnaireApi->get_question_using_get: #{e}"
826
- end
827
- ```
828
-
829
- ### Parameters
830
-
831
- Name | Type | Description | Notes
832
- ------------- | ------------- | ------------- | -------------
833
- **question_id** | [**String**](.md)| UUID question_id |
834
-
835
- ### Return type
836
-
837
- [**Question**](Question.md)
838
-
839
- ### Authorization
840
-
841
- [oauth2](../README.md#oauth2)
842
-
843
- ### HTTP request headers
844
-
845
- - **Content-Type**: Not defined
846
- - **Accept**: application/json
847
-
848
-
849
-
850
- # **get_questionnaire_all_using_get**
851
- > PageQuestionnaire get_questionnaire_all_using_get(opts)
852
-
853
- List all questionnaires
854
-
855
- Get the information for all questionnaires defined for your firm.
856
-
857
- ### Example
858
- ```ruby
859
- # load the gem
860
- require 'nucleus_api'
861
- # Setup authorization
862
- NucleusApi.configure do |config|
863
- # Use one of the below method to generate oauth token
864
- # Creating a token for grant_type=client_credentials
865
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
866
- # Creating a token for grant_type=password
867
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
868
- # Creating a token using client token
869
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
870
- end
871
-
872
- api_instance = NucleusApi::QuestionnaireApi.new
873
-
874
- opts = {
875
- ascending: false, # BOOLEAN | ascending
876
- filter: 'filter_example', # String | filter
877
- order_by: 'update_date', # String | order_by
878
- page: 0, # Integer | page
879
- size: 25 # Integer | size
880
- }
881
-
882
- begin
883
- #List all questionnaires
884
- result = api_instance.get_questionnaire_all_using_get(opts)
885
- p result
886
- rescue NucleusApi::ApiError => e
887
- puts "Exception when calling QuestionnaireApi->get_questionnaire_all_using_get: #{e}"
888
- end
889
- ```
890
-
891
- ### Parameters
892
-
893
- Name | Type | Description | Notes
894
- ------------- | ------------- | ------------- | -------------
895
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
896
- **filter** | **String**| filter | [optional]
897
- **order_by** | **String**| order_by | [optional] [default to update_date]
898
- **page** | **Integer**| page | [optional] [default to 0]
899
- **size** | **Integer**| size | [optional] [default to 25]
900
-
901
- ### Return type
902
-
903
- [**PageQuestionnaire**](PageQuestionnaire.md)
904
-
905
- ### Authorization
906
-
907
- [oauth2](../README.md#oauth2)
908
-
909
- ### HTTP request headers
910
-
911
- - **Content-Type**: Not defined
912
- - **Accept**: */*
913
-
914
-
915
-
916
- # **get_questionnaire_using_get**
917
- > Questionnaire get_questionnaire_using_get(questionnaire_id)
918
-
919
- Retrieve a questionnaire
920
-
921
- Retrieve the information for a questionnaire for your firm.
922
-
923
- ### Example
924
- ```ruby
925
- # load the gem
926
- require 'nucleus_api'
927
- # Setup authorization
928
- NucleusApi.configure do |config|
929
- # Use one of the below method to generate oauth token
930
- # Creating a token for grant_type=client_credentials
931
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
932
- # Creating a token for grant_type=password
933
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
934
- # Creating a token using client token
935
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
936
- end
937
-
938
- api_instance = NucleusApi::QuestionnaireApi.new
939
-
940
- questionnaire_id = 'questionnaire_id_example' # String | UUID questionnaire_id
941
-
942
-
943
- begin
944
- #Retrieve a questionnaire
945
- result = api_instance.get_questionnaire_using_get(questionnaire_id)
946
- p result
947
- rescue NucleusApi::ApiError => e
948
- puts "Exception when calling QuestionnaireApi->get_questionnaire_using_get: #{e}"
949
- end
950
- ```
951
-
952
- ### Parameters
953
-
954
- Name | Type | Description | Notes
955
- ------------- | ------------- | ------------- | -------------
956
- **questionnaire_id** | [**String**](.md)| UUID questionnaire_id |
957
-
958
- ### Return type
959
-
960
- [**Questionnaire**](Questionnaire.md)
961
-
962
- ### Authorization
963
-
964
- [oauth2](../README.md#oauth2)
965
-
966
- ### HTTP request headers
967
-
968
- - **Content-Type**: Not defined
969
- - **Accept**: */*
970
-
971
-
972
-
973
- # **update_answer_using_put**
974
- > Answer update_answer_using_put(answer, answer_id)
975
-
976
- Update an answer
977
-
978
- Update a answer for question.
979
-
980
- ### Example
981
- ```ruby
982
- # load the gem
983
- require 'nucleus_api'
984
- # Setup authorization
985
- NucleusApi.configure do |config|
986
- # Use one of the below method to generate oauth token
987
- # Creating a token for grant_type=client_credentials
988
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
989
- # Creating a token for grant_type=password
990
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
991
- # Creating a token using client token
992
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
993
- end
994
-
995
- api_instance = NucleusApi::QuestionnaireApi.new
996
-
997
- answer = nil # Object | answer
998
-
999
- answer_id = 'answer_id_example' # String | UUID answer_id
1000
-
1001
-
1002
- begin
1003
- #Update an answer
1004
- result = api_instance.update_answer_using_put(answer, answer_id)
1005
- p result
1006
- rescue NucleusApi::ApiError => e
1007
- puts "Exception when calling QuestionnaireApi->update_answer_using_put: #{e}"
1008
- end
1009
- ```
1010
-
1011
- ### Parameters
1012
-
1013
- Name | Type | Description | Notes
1014
- ------------- | ------------- | ------------- | -------------
1015
- **answer** | **Object**| answer |
1016
- **answer_id** | [**String**](.md)| UUID answer_id |
1017
-
1018
- ### Return type
1019
-
1020
- [**Answer**](Answer.md)
1021
-
1022
- ### Authorization
1023
-
1024
- [oauth2](../README.md#oauth2)
1025
-
1026
- ### HTTP request headers
1027
-
1028
- - **Content-Type**: application/json
1029
- - **Accept**: */*
1030
-
1031
-
1032
-
1033
- # **update_client_response_using_put**
1034
- > ClientResponse update_client_response_using_put(client_response, client_response_id)
1035
-
1036
- Update a client response
1037
-
1038
- Update a client response for a client.
1039
-
1040
- ### Example
1041
- ```ruby
1042
- # load the gem
1043
- require 'nucleus_api'
1044
- # Setup authorization
1045
- NucleusApi.configure do |config|
1046
- # Use one of the below method to generate oauth token
1047
- # Creating a token for grant_type=client_credentials
1048
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1049
- # Creating a token for grant_type=password
1050
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1051
- # Creating a token using client token
1052
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1053
- end
1054
-
1055
- api_instance = NucleusApi::QuestionnaireApi.new
1056
-
1057
- client_response = nil # Object | client_response
1058
-
1059
- client_response_id = 'client_response_id_example' # String | UUID client_response_id
1060
-
1061
-
1062
- begin
1063
- #Update a client response
1064
- result = api_instance.update_client_response_using_put(client_response, client_response_id)
1065
- p result
1066
- rescue NucleusApi::ApiError => e
1067
- puts "Exception when calling QuestionnaireApi->update_client_response_using_put: #{e}"
1068
- end
1069
- ```
1070
-
1071
- ### Parameters
1072
-
1073
- Name | Type | Description | Notes
1074
- ------------- | ------------- | ------------- | -------------
1075
- **client_response** | **Object**| client_response |
1076
- **client_response_id** | [**String**](.md)| UUID client_response_id |
1077
-
1078
- ### Return type
1079
-
1080
- [**ClientResponse**](ClientResponse.md)
1081
-
1082
- ### Authorization
1083
-
1084
- [oauth2](../README.md#oauth2)
1085
-
1086
- ### HTTP request headers
1087
-
1088
- - **Content-Type**: application/json
1089
- - **Accept**: */*
1090
-
1091
-
1092
-
1093
- # **update_question_using_put**
1094
- > Question update_question_using_put(question, question_id)
1095
-
1096
- Update a question.
1097
-
1098
- Update a question for questionnaire.
1099
-
1100
- ### Example
1101
- ```ruby
1102
- # load the gem
1103
- require 'nucleus_api'
1104
- # Setup authorization
1105
- NucleusApi.configure do |config|
1106
- # Use one of the below method to generate oauth token
1107
- # Creating a token for grant_type=client_credentials
1108
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1109
- # Creating a token for grant_type=password
1110
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1111
- # Creating a token using client token
1112
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1113
- end
1114
-
1115
- api_instance = NucleusApi::QuestionnaireApi.new
1116
-
1117
- question = nil # Object | question
1118
-
1119
- question_id = 'question_id_example' # String | UUID question_id
1120
-
1121
-
1122
- begin
1123
- #Update a question.
1124
- result = api_instance.update_question_using_put(question, question_id)
1125
- p result
1126
- rescue NucleusApi::ApiError => e
1127
- puts "Exception when calling QuestionnaireApi->update_question_using_put: #{e}"
1128
- end
1129
- ```
1130
-
1131
- ### Parameters
1132
-
1133
- Name | Type | Description | Notes
1134
- ------------- | ------------- | ------------- | -------------
1135
- **question** | **Object**| question |
1136
- **question_id** | [**String**](.md)| UUID question_id |
1137
-
1138
- ### Return type
1139
-
1140
- [**Question**](Question.md)
1141
-
1142
- ### Authorization
1143
-
1144
- [oauth2](../README.md#oauth2)
1145
-
1146
- ### HTTP request headers
1147
-
1148
- - **Content-Type**: application/json
1149
- - **Accept**: */*
1150
-
1151
-
1152
-
1153
- # **update_questionnaire_using_put**
1154
- > Questionnaire update_questionnaire_using_put(questionnaire, questionnaire_id)
1155
-
1156
- Update a questionnaire
1157
-
1158
- Update a questionnaire for your firm.
1159
-
1160
- ### Example
1161
- ```ruby
1162
- # load the gem
1163
- require 'nucleus_api'
1164
- # Setup authorization
1165
- NucleusApi.configure do |config|
1166
- # Use one of the below method to generate oauth token
1167
- # Creating a token for grant_type=client_credentials
1168
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1169
- # Creating a token for grant_type=password
1170
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1171
- # Creating a token using client token
1172
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
1173
- end
1174
-
1175
- api_instance = NucleusApi::QuestionnaireApi.new
1176
-
1177
- questionnaire = nil # Object | questionnaire
1178
-
1179
- questionnaire_id = 'questionnaire_id_example' # String | UUID questionnaire_id
1180
-
1181
-
1182
- begin
1183
- #Update a questionnaire
1184
- result = api_instance.update_questionnaire_using_put(questionnaire, questionnaire_id)
1185
- p result
1186
- rescue NucleusApi::ApiError => e
1187
- puts "Exception when calling QuestionnaireApi->update_questionnaire_using_put: #{e}"
1188
- end
1189
- ```
1190
-
1191
- ### Parameters
1192
-
1193
- Name | Type | Description | Notes
1194
- ------------- | ------------- | ------------- | -------------
1195
- **questionnaire** | **Object**| questionnaire |
1196
- **questionnaire_id** | [**String**](.md)| UUID questionnaire_id |
1197
-
1198
- ### Return type
1199
-
1200
- [**Questionnaire**](Questionnaire.md)
1201
-
1202
- ### Authorization
1203
-
1204
- [oauth2](../README.md#oauth2)
1205
-
1206
- ### HTTP request headers
1207
-
1208
- - **Content-Type**: application/json
1209
- - **Accept**: */*
1210
-
1211
-
1212
-