mx-platform-ruby 1.10.0 → 1.10.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (589) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/docs/ACHResponse.md +74 -0
  4. data/docs/ACHReturnCreateRequest.md +48 -0
  5. data/docs/ACHReturnCreateRequestBody.md +18 -0
  6. data/docs/ACHReturnResponseBody.md +18 -0
  7. data/docs/{HoldingsResponseBody.md → ACHReturnsResponseBody.md} +4 -4
  8. data/docs/AccountCreateRequest.md +9 -9
  9. data/docs/AccountNumberResponse.md +3 -3
  10. data/docs/AccountResponse.md +37 -37
  11. data/docs/AccountUpdateRequest.md +30 -30
  12. data/docs/AccountsApi.md +780 -0
  13. data/docs/AchReturnApi.md +234 -0
  14. data/docs/AuthorizationCodeResponseBody.md +1 -1
  15. data/docs/BudgetResponse.md +1 -1
  16. data/docs/BudgetsApi.md +115 -115
  17. data/docs/CategoriesApi.md +600 -0
  18. data/docs/CategoryCreateRequest.md +1 -1
  19. data/docs/CategoryResponse.md +1 -1
  20. data/docs/ConnectWidgetRequest.md +5 -3
  21. data/docs/CreditCardProduct.md +1 -1
  22. data/docs/GoalResponse.md +1 -1
  23. data/docs/GoalsApi.md +117 -113
  24. data/docs/GoalsResponse.md +1 -1
  25. data/docs/ImageOptionResponse.md +0 -2
  26. data/docs/InsightResponse.md +3 -1
  27. data/docs/InsightResponseBody.md +1 -1
  28. data/docs/InsightUpdateRequestBody.md +18 -0
  29. data/docs/InsightsApi.md +170 -91
  30. data/docs/InstitutionResponse.md +15 -7
  31. data/docs/InstitutionsApi.md +319 -0
  32. data/docs/InvestmentHoldingResponse.md +90 -0
  33. data/docs/InvestmentHoldingResponseBody.md +18 -0
  34. data/docs/InvestmentHoldingsApi.md +386 -0
  35. data/docs/InvestmentHoldingsDeactivation.md +20 -0
  36. data/docs/InvestmentHoldingsResponseBody.md +20 -0
  37. data/docs/ManagedAccountCreateRequest.md +15 -15
  38. data/docs/ManagedAccountUpdateRequest.md +14 -14
  39. data/docs/ManagedDataApi.md +1228 -0
  40. data/docs/ManagedTransactionCreateRequest.md +1 -1
  41. data/docs/MemberCreateRequest.md +5 -3
  42. data/docs/MemberCreateRequestBody.md +3 -3
  43. data/docs/MemberElements.md +22 -0
  44. data/docs/MemberResponse.md +1 -3
  45. data/docs/MemberStatusResponse.md +2 -2
  46. data/docs/MemberUpdateRequest.md +4 -2
  47. data/docs/MembersApi.md +997 -0
  48. data/docs/MerchantsApi.md +226 -0
  49. data/docs/{MicrodepositRequest.md → MicrodepositElements.md} +7 -7
  50. data/docs/MicrodepositRequestBody.md +1 -1
  51. data/docs/MicrodepositResponse.md +0 -14
  52. data/docs/MicrodepositResponseBody.md +1 -1
  53. data/docs/MicrodepositResponseBodyMicroDepositInner.md +44 -0
  54. data/docs/MicrodepositVerifyRequest.md +4 -4
  55. data/docs/MicrodepositsApi.md +153 -82
  56. data/docs/MonthlyCashFlowProfileApi.md +151 -0
  57. data/docs/MonthlyCashFlowResponse.md +3 -3
  58. data/docs/NotificationResponse.md +36 -0
  59. data/docs/NotificationResponseBody.md +18 -0
  60. data/docs/NotificationsApi.md +236 -0
  61. data/docs/NotificationsResponseBody.md +18 -0
  62. data/docs/OptionResponse.md +0 -2
  63. data/docs/PaymentAccount.md +34 -0
  64. data/docs/PaymentAccountBody.md +18 -0
  65. data/docs/PaymentAccountBodyPaymentAccount.md +40 -0
  66. data/docs/PaymentProcessorAuthorizationCodeRequest.md +3 -3
  67. data/docs/ProcessorAccountNumber.md +34 -0
  68. data/docs/ProcessorAccountNumberBody.md +18 -0
  69. data/docs/ProcessorAccountNumberBodyAccountNumbersInner.md +40 -0
  70. data/docs/ProcessorOwner.md +34 -0
  71. data/docs/ProcessorOwnerBody.md +20 -0
  72. data/docs/ProcessorOwnerBodyAccountOwnersInner.md +40 -0
  73. data/docs/ProcessorTokenApi.md +490 -0
  74. data/docs/RepeatingTransactionResponse.md +40 -0
  75. data/docs/RepeatingTransactionsResponseBody.md +18 -0
  76. data/docs/{RewardsResponse.md → RewardElements.md} +3 -9
  77. data/docs/RewardResponseBody.md +1 -1
  78. data/docs/RewardsApi.md +299 -0
  79. data/docs/RewardsResponseBody.md +1 -1
  80. data/docs/{RewardResponse.md → RewardsResponseBodyRewardsInner.md} +8 -8
  81. data/docs/ScheduledPaymentsResponseBody.md +3 -3
  82. data/docs/SpendingPlanApi.md +142 -63
  83. data/docs/SpendingPlanIterationItemResponse.md +5 -5
  84. data/docs/StatementsApi.md +309 -0
  85. data/docs/StatementsResponseBody.md +3 -3
  86. data/docs/TaggingsApi.md +377 -0
  87. data/docs/TaggingsResponseBody.md +3 -3
  88. data/docs/TagsApi.md +379 -0
  89. data/docs/TagsResponseBody.md +3 -3
  90. data/docs/TokenRequestBody.md +18 -0
  91. data/docs/TokenResponse.md +24 -0
  92. data/docs/TokenResponseBody.md +18 -0
  93. data/docs/TransactionIncludesResponse.md +112 -0
  94. data/docs/TransactionIncludesResponseAllOfClassification.md +20 -0
  95. data/docs/TransactionIncludesResponseAllOfGeolocation.md +24 -0
  96. data/docs/TransactionIncludesResponseAllOfMerchant.md +24 -0
  97. data/docs/TransactionIncludesResponseAllOfRepeatingTransaction.md +22 -0
  98. data/docs/TransactionResponse.md +38 -36
  99. data/docs/TransactionRulesApi.md +305 -0
  100. data/docs/TransactionRulesResponseBody.md +3 -3
  101. data/docs/TransactionUpdateRequest.md +7 -1
  102. data/docs/TransactionsApi.md +1232 -14
  103. data/docs/TransactionsResponseBody.md +3 -3
  104. data/docs/TransactionsResponseBodyIncludes.md +20 -0
  105. data/docs/UsersApi.md +375 -0
  106. data/docs/UsersResponseBody.md +3 -3
  107. data/docs/VCResponse.md +18 -0
  108. data/docs/VerifiableCredentialsApi.md +232 -0
  109. data/docs/WidgetRequest.md +31 -23
  110. data/docs/WidgetsApi.md +244 -0
  111. data/lib/mx-platform-ruby/api/accounts_api.rb +781 -0
  112. data/lib/mx-platform-ruby/api/ach_return_api.rb +231 -0
  113. data/lib/mx-platform-ruby/api/budgets_api.rb +131 -131
  114. data/lib/mx-platform-ruby/api/categories_api.rb +576 -0
  115. data/lib/mx-platform-ruby/api/goals_api.rb +148 -134
  116. data/lib/mx-platform-ruby/api/insights_api.rb +162 -87
  117. data/lib/mx-platform-ruby/api/institutions_api.rb +301 -0
  118. data/lib/mx-platform-ruby/api/investment_holdings_api.rb +373 -0
  119. data/lib/mx-platform-ruby/api/managed_data_api.rb +1265 -0
  120. data/lib/mx-platform-ruby/api/members_api.rb +977 -0
  121. data/lib/mx-platform-ruby/api/merchants_api.rb +214 -0
  122. data/lib/mx-platform-ruby/api/microdeposits_api.rb +159 -96
  123. data/lib/mx-platform-ruby/api/monthly_cash_flow_profile_api.rb +159 -0
  124. data/lib/mx-platform-ruby/api/notifications_api.rb +243 -0
  125. data/lib/mx-platform-ruby/api/processor_token_api.rb +450 -0
  126. data/lib/mx-platform-ruby/api/rewards_api.rb +298 -0
  127. data/lib/mx-platform-ruby/api/spending_plan_api.rb +139 -64
  128. data/lib/mx-platform-ruby/api/statements_api.rb +316 -0
  129. data/lib/mx-platform-ruby/api/taggings_api.rb +381 -0
  130. data/lib/mx-platform-ruby/api/tags_api.rb +388 -0
  131. data/lib/mx-platform-ruby/api/transaction_rules_api.rb +314 -0
  132. data/lib/mx-platform-ruby/api/transactions_api.rb +1237 -15
  133. data/lib/mx-platform-ruby/api/users_api.rb +367 -0
  134. data/lib/mx-platform-ruby/api/verifiable_credentials_api.rb +235 -0
  135. data/lib/mx-platform-ruby/api/widgets_api.rb +260 -0
  136. data/lib/mx-platform-ruby/api_client.rb +2 -2
  137. data/lib/mx-platform-ruby/api_error.rb +2 -2
  138. data/lib/mx-platform-ruby/configuration.rb +12 -5
  139. data/lib/mx-platform-ruby/models/account_create_request.rb +2 -2
  140. data/lib/mx-platform-ruby/models/account_create_request_body.rb +2 -2
  141. data/lib/mx-platform-ruby/models/account_number_response.rb +13 -13
  142. data/lib/mx-platform-ruby/models/account_numbers_response_body.rb +2 -2
  143. data/lib/mx-platform-ruby/models/account_owner_response.rb +2 -2
  144. data/lib/mx-platform-ruby/models/account_owners_response_body.rb +2 -2
  145. data/lib/mx-platform-ruby/models/account_response.rb +2 -2
  146. data/lib/mx-platform-ruby/models/account_response_body.rb +2 -2
  147. data/lib/mx-platform-ruby/models/account_update_request.rb +23 -2
  148. data/lib/mx-platform-ruby/models/account_update_request_body.rb +2 -2
  149. data/lib/mx-platform-ruby/models/accounts_response_body.rb +2 -2
  150. data/lib/mx-platform-ruby/models/ach_response.rb +485 -0
  151. data/lib/mx-platform-ruby/models/ach_return_create_request.rb +400 -0
  152. data/lib/mx-platform-ruby/models/ach_return_create_request_body.rb +214 -0
  153. data/lib/mx-platform-ruby/models/ach_return_response_body.rb +214 -0
  154. data/lib/mx-platform-ruby/models/{holdings_response_body.rb → ach_returns_response_body.rb} +13 -13
  155. data/lib/mx-platform-ruby/models/authorization_code_request.rb +2 -2
  156. data/lib/mx-platform-ruby/models/authorization_code_request_body.rb +2 -2
  157. data/lib/mx-platform-ruby/models/authorization_code_response.rb +2 -2
  158. data/lib/mx-platform-ruby/models/authorization_code_response_body.rb +4 -6
  159. data/lib/mx-platform-ruby/models/budget_create_request.rb +2 -2
  160. data/lib/mx-platform-ruby/models/budget_create_request_body.rb +2 -2
  161. data/lib/mx-platform-ruby/models/budget_response.rb +2 -2
  162. data/lib/mx-platform-ruby/models/budget_response_body.rb +2 -2
  163. data/lib/mx-platform-ruby/models/budget_update_request.rb +2 -2
  164. data/lib/mx-platform-ruby/models/budget_update_request_body.rb +2 -2
  165. data/lib/mx-platform-ruby/models/categories_response_body.rb +2 -2
  166. data/lib/mx-platform-ruby/models/category_create_request.rb +9 -2
  167. data/lib/mx-platform-ruby/models/category_create_request_body.rb +2 -2
  168. data/lib/mx-platform-ruby/models/category_response.rb +3 -2
  169. data/lib/mx-platform-ruby/models/category_response_body.rb +2 -2
  170. data/lib/mx-platform-ruby/models/category_update_request.rb +2 -2
  171. data/lib/mx-platform-ruby/models/category_update_request_body.rb +2 -2
  172. data/lib/mx-platform-ruby/models/challenge_response.rb +2 -2
  173. data/lib/mx-platform-ruby/models/challenges_response_body.rb +2 -2
  174. data/lib/mx-platform-ruby/models/connect_widget_request.rb +13 -3
  175. data/lib/mx-platform-ruby/models/connect_widget_request_body.rb +2 -2
  176. data/lib/mx-platform-ruby/models/connect_widget_response.rb +2 -2
  177. data/lib/mx-platform-ruby/models/connect_widget_response_body.rb +2 -2
  178. data/lib/mx-platform-ruby/models/credential_request.rb +2 -2
  179. data/lib/mx-platform-ruby/models/credential_response.rb +2 -2
  180. data/lib/mx-platform-ruby/models/credentials_response_body.rb +2 -2
  181. data/lib/mx-platform-ruby/models/credit_card_product.rb +4 -2
  182. data/lib/mx-platform-ruby/models/credit_card_product_response.rb +2 -2
  183. data/lib/mx-platform-ruby/models/enhance_transaction_response.rb +2 -2
  184. data/lib/mx-platform-ruby/models/enhance_transactions_request.rb +2 -2
  185. data/lib/mx-platform-ruby/models/enhance_transactions_request_body.rb +2 -2
  186. data/lib/mx-platform-ruby/models/enhance_transactions_response_body.rb +2 -2
  187. data/lib/mx-platform-ruby/models/goal_request.rb +2 -2
  188. data/lib/mx-platform-ruby/models/goal_request_body.rb +2 -2
  189. data/lib/mx-platform-ruby/models/goal_response.rb +2 -2
  190. data/lib/mx-platform-ruby/models/goal_response_body.rb +2 -2
  191. data/lib/mx-platform-ruby/models/goals_response.rb +2 -2
  192. data/lib/mx-platform-ruby/models/goals_response_body.rb +2 -2
  193. data/lib/mx-platform-ruby/models/image_option_response.rb +3 -13
  194. data/lib/mx-platform-ruby/models/insight_response.rb +13 -3
  195. data/lib/mx-platform-ruby/models/insight_response_body.rb +4 -6
  196. data/lib/mx-platform-ruby/models/insight_update_request.rb +2 -2
  197. data/lib/mx-platform-ruby/models/{tax_document_response_body.rb → insight_update_request_body.rb} +12 -12
  198. data/lib/mx-platform-ruby/models/insights_response_body.rb +2 -2
  199. data/lib/mx-platform-ruby/models/institution_response.rb +35 -3
  200. data/lib/mx-platform-ruby/models/institution_response_body.rb +2 -2
  201. data/lib/mx-platform-ruby/models/institutions_response_body.rb +2 -2
  202. data/lib/mx-platform-ruby/models/investment_holding_response.rb +575 -0
  203. data/lib/mx-platform-ruby/models/investment_holding_response_body.rb +214 -0
  204. data/lib/mx-platform-ruby/models/investment_holdings_deactivation.rb +225 -0
  205. data/lib/mx-platform-ruby/models/investment_holdings_response_body.rb +225 -0
  206. data/lib/mx-platform-ruby/models/managed_account_create_request.rb +9 -2
  207. data/lib/mx-platform-ruby/models/managed_account_create_request_body.rb +2 -2
  208. data/lib/mx-platform-ruby/models/managed_account_update_request.rb +2 -2
  209. data/lib/mx-platform-ruby/models/managed_account_update_request_body.rb +2 -2
  210. data/lib/mx-platform-ruby/models/managed_member_create_request.rb +2 -2
  211. data/lib/mx-platform-ruby/models/managed_member_create_request_body.rb +2 -2
  212. data/lib/mx-platform-ruby/models/managed_member_update_request.rb +2 -2
  213. data/lib/mx-platform-ruby/models/managed_member_update_request_body.rb +2 -2
  214. data/lib/mx-platform-ruby/models/managed_transaction_create_request.rb +9 -2
  215. data/lib/mx-platform-ruby/models/managed_transaction_create_request_body.rb +2 -2
  216. data/lib/mx-platform-ruby/models/managed_transaction_update_request.rb +2 -2
  217. data/lib/mx-platform-ruby/models/managed_transaction_update_request_body.rb +2 -2
  218. data/lib/mx-platform-ruby/models/member_create_request.rb +40 -6
  219. data/lib/mx-platform-ruby/models/member_create_request_body.rb +3 -2
  220. data/lib/mx-platform-ruby/models/member_elements.rb +232 -0
  221. data/lib/mx-platform-ruby/models/member_response.rb +3 -13
  222. data/lib/mx-platform-ruby/models/member_response_body.rb +2 -2
  223. data/lib/mx-platform-ruby/models/member_resume_request.rb +2 -2
  224. data/lib/mx-platform-ruby/models/member_resume_request_body.rb +2 -2
  225. data/lib/mx-platform-ruby/models/member_status_response.rb +13 -13
  226. data/lib/mx-platform-ruby/models/member_status_response_body.rb +2 -2
  227. data/lib/mx-platform-ruby/models/member_update_request.rb +40 -6
  228. data/lib/mx-platform-ruby/models/member_update_request_body.rb +2 -2
  229. data/lib/mx-platform-ruby/models/members_response_body.rb +2 -2
  230. data/lib/mx-platform-ruby/models/merchant_location_response.rb +2 -2
  231. data/lib/mx-platform-ruby/models/merchant_location_response_body.rb +2 -2
  232. data/lib/mx-platform-ruby/models/merchant_response.rb +2 -2
  233. data/lib/mx-platform-ruby/models/merchant_response_body.rb +2 -2
  234. data/lib/mx-platform-ruby/models/merchants_response_body.rb +2 -2
  235. data/lib/mx-platform-ruby/models/{microdeposit_request.rb → microdeposit_elements.rb} +29 -29
  236. data/lib/mx-platform-ruby/models/microdeposit_request_body.rb +3 -3
  237. data/lib/mx-platform-ruby/models/microdeposit_response.rb +5 -66
  238. data/lib/mx-platform-ruby/models/microdeposit_response_body.rb +6 -4
  239. data/lib/mx-platform-ruby/models/microdeposit_response_body_micro_deposit_inner.rb +362 -0
  240. data/lib/mx-platform-ruby/models/microdeposit_verify_request.rb +4 -4
  241. data/lib/mx-platform-ruby/models/microdeposit_verify_request_body.rb +2 -2
  242. data/lib/mx-platform-ruby/models/microdeposits_response_body.rb +2 -2
  243. data/lib/mx-platform-ruby/models/monthly_cash_flow_profile_request.rb +2 -2
  244. data/lib/mx-platform-ruby/models/monthly_cash_flow_profile_request_body.rb +2 -2
  245. data/lib/mx-platform-ruby/models/monthly_cash_flow_response.rb +4 -3
  246. data/lib/mx-platform-ruby/models/monthly_cash_flow_response_body.rb +2 -2
  247. data/lib/mx-platform-ruby/models/notification_response.rb +305 -0
  248. data/lib/mx-platform-ruby/models/{tax_documents_response_body.rb → notification_response_body.rb} +12 -23
  249. data/lib/mx-platform-ruby/models/notifications_response_body.rb +216 -0
  250. data/lib/mx-platform-ruby/models/o_auth_window_response.rb +2 -2
  251. data/lib/mx-platform-ruby/models/o_auth_window_response_body.rb +2 -2
  252. data/lib/mx-platform-ruby/models/option_response.rb +3 -13
  253. data/lib/mx-platform-ruby/models/pagination_response.rb +2 -2
  254. data/lib/mx-platform-ruby/models/{tax_document_response.rb → payment_account.rb} +66 -76
  255. data/lib/mx-platform-ruby/models/payment_account_body.rb +214 -0
  256. data/lib/mx-platform-ruby/models/payment_account_body_payment_account.rb +330 -0
  257. data/lib/mx-platform-ruby/models/payment_processor_authorization_code_request.rb +23 -5
  258. data/lib/mx-platform-ruby/models/payment_processor_authorization_code_request_body.rb +2 -2
  259. data/lib/mx-platform-ruby/models/payment_processor_authorization_code_response.rb +2 -2
  260. data/lib/mx-platform-ruby/models/payment_processor_authorization_code_response_body.rb +2 -2
  261. data/lib/mx-platform-ruby/models/processor_account_number.rb +292 -0
  262. data/lib/mx-platform-ruby/models/processor_account_number_body.rb +216 -0
  263. data/lib/mx-platform-ruby/models/processor_account_number_body_account_numbers_inner.rb +327 -0
  264. data/lib/mx-platform-ruby/models/processor_owner.rb +295 -0
  265. data/lib/mx-platform-ruby/models/processor_owner_body.rb +225 -0
  266. data/lib/mx-platform-ruby/models/processor_owner_body_account_owners_inner.rb +330 -0
  267. data/lib/mx-platform-ruby/models/{holding_response.rb → repeating_transaction_response.rb} +100 -135
  268. data/lib/mx-platform-ruby/models/repeating_transactions_response_body.rb +216 -0
  269. data/lib/mx-platform-ruby/models/reposition_request.rb +2 -2
  270. data/lib/mx-platform-ruby/models/reposition_request_body.rb +2 -2
  271. data/lib/mx-platform-ruby/models/reposition_response_body.rb +2 -2
  272. data/lib/mx-platform-ruby/models/{rewards_response.rb → reward_elements.rb} +9 -36
  273. data/lib/mx-platform-ruby/models/reward_response_body.rb +3 -3
  274. data/lib/mx-platform-ruby/models/rewards_response_body.rb +3 -3
  275. data/lib/mx-platform-ruby/models/{reward_response.rb → rewards_response_body_rewards_inner.rb} +35 -27
  276. data/lib/mx-platform-ruby/models/scheduled_payment_response.rb +2 -2
  277. data/lib/mx-platform-ruby/models/scheduled_payments_response_body.rb +15 -15
  278. data/lib/mx-platform-ruby/models/spending_plan_account_response.rb +2 -2
  279. data/lib/mx-platform-ruby/models/spending_plan_accounts_response.rb +2 -2
  280. data/lib/mx-platform-ruby/models/spending_plan_iteration_item_create_request_body.rb +2 -2
  281. data/lib/mx-platform-ruby/models/spending_plan_iteration_item_response.rb +2 -2
  282. data/lib/mx-platform-ruby/models/spending_plan_iteration_items_response_body.rb +2 -2
  283. data/lib/mx-platform-ruby/models/spending_plan_iteration_response.rb +2 -2
  284. data/lib/mx-platform-ruby/models/spending_plan_iterations_response.rb +2 -2
  285. data/lib/mx-platform-ruby/models/spending_plan_response.rb +2 -2
  286. data/lib/mx-platform-ruby/models/spending_plans_response_body.rb +2 -2
  287. data/lib/mx-platform-ruby/models/split_transaction_request.rb +2 -2
  288. data/lib/mx-platform-ruby/models/split_transaction_request_body.rb +2 -2
  289. data/lib/mx-platform-ruby/models/split_transactions_response_body.rb +2 -2
  290. data/lib/mx-platform-ruby/models/statement_response.rb +2 -2
  291. data/lib/mx-platform-ruby/models/statement_response_body.rb +2 -2
  292. data/lib/mx-platform-ruby/models/statements_response_body.rb +15 -15
  293. data/lib/mx-platform-ruby/models/tag_create_request.rb +2 -2
  294. data/lib/mx-platform-ruby/models/tag_create_request_body.rb +2 -2
  295. data/lib/mx-platform-ruby/models/tag_response.rb +2 -2
  296. data/lib/mx-platform-ruby/models/tag_response_body.rb +2 -2
  297. data/lib/mx-platform-ruby/models/tag_update_request.rb +2 -2
  298. data/lib/mx-platform-ruby/models/tag_update_request_body.rb +2 -2
  299. data/lib/mx-platform-ruby/models/tagging_create_request.rb +2 -2
  300. data/lib/mx-platform-ruby/models/tagging_create_request_body.rb +2 -2
  301. data/lib/mx-platform-ruby/models/tagging_response.rb +2 -2
  302. data/lib/mx-platform-ruby/models/tagging_response_body.rb +2 -2
  303. data/lib/mx-platform-ruby/models/tagging_update_request.rb +2 -2
  304. data/lib/mx-platform-ruby/models/tagging_update_request_body.rb +2 -2
  305. data/lib/mx-platform-ruby/models/taggings_response_body.rb +15 -15
  306. data/lib/mx-platform-ruby/models/tags_response_body.rb +15 -15
  307. data/lib/mx-platform-ruby/models/{holding_response_body.rb → token_request_body.rb} +12 -12
  308. data/lib/mx-platform-ruby/models/token_response.rb +241 -0
  309. data/lib/mx-platform-ruby/models/token_response_body.rb +216 -0
  310. data/lib/mx-platform-ruby/models/transaction_create_request.rb +2 -2
  311. data/lib/mx-platform-ruby/models/transaction_create_request_body.rb +2 -2
  312. data/lib/mx-platform-ruby/models/transaction_create_response_body.rb +2 -2
  313. data/lib/mx-platform-ruby/models/transaction_includes_response.rb +692 -0
  314. data/lib/mx-platform-ruby/models/transaction_includes_response_all_of_classification.rb +257 -0
  315. data/lib/mx-platform-ruby/models/transaction_includes_response_all_of_geolocation.rb +241 -0
  316. data/lib/mx-platform-ruby/models/transaction_includes_response_all_of_merchant.rb +241 -0
  317. data/lib/mx-platform-ruby/models/transaction_includes_response_all_of_repeating_transaction.rb +278 -0
  318. data/lib/mx-platform-ruby/models/transaction_response.rb +13 -3
  319. data/lib/mx-platform-ruby/models/transaction_response_body.rb +2 -2
  320. data/lib/mx-platform-ruby/models/transaction_rule_create_request.rb +2 -2
  321. data/lib/mx-platform-ruby/models/transaction_rule_create_request_body.rb +2 -2
  322. data/lib/mx-platform-ruby/models/transaction_rule_response.rb +2 -2
  323. data/lib/mx-platform-ruby/models/transaction_rule_response_body.rb +2 -2
  324. data/lib/mx-platform-ruby/models/transaction_rule_update_request.rb +2 -2
  325. data/lib/mx-platform-ruby/models/transaction_rule_update_request_body.rb +2 -2
  326. data/lib/mx-platform-ruby/models/transaction_rules_response_body.rb +15 -15
  327. data/lib/mx-platform-ruby/models/transaction_update_request.rb +30 -10
  328. data/lib/mx-platform-ruby/models/transaction_update_request_body.rb +2 -2
  329. data/lib/mx-platform-ruby/models/transactions_response_body.rb +15 -15
  330. data/lib/mx-platform-ruby/models/transactions_response_body_includes.rb +225 -0
  331. data/lib/mx-platform-ruby/models/update_goal_request.rb +2 -2
  332. data/lib/mx-platform-ruby/models/update_goal_request_body.rb +2 -2
  333. data/lib/mx-platform-ruby/models/user_create_request.rb +2 -2
  334. data/lib/mx-platform-ruby/models/user_create_request_body.rb +2 -2
  335. data/lib/mx-platform-ruby/models/user_response.rb +2 -2
  336. data/lib/mx-platform-ruby/models/user_response_body.rb +2 -2
  337. data/lib/mx-platform-ruby/models/user_update_request.rb +2 -2
  338. data/lib/mx-platform-ruby/models/user_update_request_body.rb +2 -2
  339. data/lib/mx-platform-ruby/models/users_response_body.rb +15 -15
  340. data/lib/mx-platform-ruby/models/vc_response.rb +214 -0
  341. data/lib/mx-platform-ruby/models/widget_request.rb +89 -3
  342. data/lib/mx-platform-ruby/models/widget_request_body.rb +2 -2
  343. data/lib/mx-platform-ruby/models/widget_response.rb +2 -2
  344. data/lib/mx-platform-ruby/models/widget_response_body.rb +2 -2
  345. data/lib/mx-platform-ruby/version.rb +3 -3
  346. data/lib/mx-platform-ruby.rb +60 -12
  347. data/mx-platform-ruby.gemspec +2 -2
  348. data/openapi/config.yml +1 -1
  349. data/spec/api/accounts_api_spec.rb +182 -0
  350. data/spec/api/ach_return_api_spec.rb +77 -0
  351. data/spec/api/budgets_api_spec.rb +38 -38
  352. data/spec/api/categories_api_spec.rb +141 -0
  353. data/spec/api/goals_api_spec.rb +42 -40
  354. data/spec/api/insights_api_spec.rb +53 -38
  355. data/spec/api/institutions_api_spec.rb +94 -0
  356. data/spec/api/investment_holdings_api_spec.rb +104 -0
  357. data/spec/api/managed_data_api_spec.rb +267 -0
  358. data/spec/api/members_api_spec.rb +218 -0
  359. data/spec/api/merchants_api_spec.rb +73 -0
  360. data/spec/api/microdeposits_api_spec.rb +40 -28
  361. data/spec/api/monthly_cash_flow_profile_api_spec.rb +60 -0
  362. data/spec/api/notifications_api_spec.rb +78 -0
  363. data/spec/api/processor_token_api_spec.rb +115 -0
  364. data/spec/api/rewards_api_spec.rb +87 -0
  365. data/spec/api/spending_plan_api_spec.rb +48 -33
  366. data/spec/api/statements_api_spec.rb +91 -0
  367. data/spec/api/taggings_api_spec.rb +102 -0
  368. data/spec/api/tags_api_spec.rb +103 -0
  369. data/spec/api/transaction_rules_api_spec.rb +89 -0
  370. data/spec/api/transactions_api_spec.rb +258 -6
  371. data/spec/api/users_api_spec.rb +101 -0
  372. data/spec/api/verifiable_credentials_api_spec.rb +76 -0
  373. data/spec/api/widgets_api_spec.rb +81 -0
  374. data/spec/models/account_create_request_body_spec.rb +2 -2
  375. data/spec/models/account_create_request_spec.rb +2 -2
  376. data/spec/models/account_number_response_spec.rb +5 -5
  377. data/spec/models/account_numbers_response_body_spec.rb +2 -2
  378. data/spec/models/account_owner_response_spec.rb +2 -2
  379. data/spec/models/account_owners_response_body_spec.rb +2 -2
  380. data/spec/models/account_response_body_spec.rb +2 -2
  381. data/spec/models/account_response_spec.rb +2 -2
  382. data/spec/models/account_update_request_body_spec.rb +2 -2
  383. data/spec/models/account_update_request_spec.rb +2 -2
  384. data/spec/models/accounts_response_body_spec.rb +2 -2
  385. data/spec/models/ach_response_spec.rb +204 -0
  386. data/spec/models/ach_return_create_request_body_spec.rb +36 -0
  387. data/spec/models/{holding_response_spec.rb → ach_return_create_request_spec.rb} +22 -40
  388. data/spec/models/ach_return_response_body_spec.rb +36 -0
  389. data/spec/models/{tax_documents_response_body_spec.rb → ach_returns_response_body_spec.rb} +10 -10
  390. data/spec/models/authorization_code_request_body_spec.rb +2 -2
  391. data/spec/models/authorization_code_request_spec.rb +2 -2
  392. data/spec/models/authorization_code_response_body_spec.rb +2 -2
  393. data/spec/models/authorization_code_response_spec.rb +2 -2
  394. data/spec/models/budget_create_request_body_spec.rb +2 -2
  395. data/spec/models/budget_create_request_spec.rb +2 -2
  396. data/spec/models/budget_response_body_spec.rb +2 -2
  397. data/spec/models/budget_response_spec.rb +2 -2
  398. data/spec/models/budget_update_request_body_spec.rb +2 -2
  399. data/spec/models/budget_update_request_spec.rb +2 -2
  400. data/spec/models/categories_response_body_spec.rb +2 -2
  401. data/spec/models/category_create_request_body_spec.rb +2 -2
  402. data/spec/models/category_create_request_spec.rb +2 -2
  403. data/spec/models/category_response_body_spec.rb +2 -2
  404. data/spec/models/category_response_spec.rb +2 -2
  405. data/spec/models/category_update_request_body_spec.rb +2 -2
  406. data/spec/models/category_update_request_spec.rb +2 -2
  407. data/spec/models/challenge_response_spec.rb +2 -2
  408. data/spec/models/challenges_response_body_spec.rb +2 -2
  409. data/spec/models/connect_widget_request_body_spec.rb +2 -2
  410. data/spec/models/connect_widget_request_spec.rb +8 -2
  411. data/spec/models/connect_widget_response_body_spec.rb +2 -2
  412. data/spec/models/connect_widget_response_spec.rb +2 -2
  413. data/spec/models/credential_request_spec.rb +2 -2
  414. data/spec/models/credential_response_spec.rb +2 -2
  415. data/spec/models/credentials_response_body_spec.rb +2 -2
  416. data/spec/models/credit_card_product_response_spec.rb +2 -2
  417. data/spec/models/credit_card_product_spec.rb +2 -2
  418. data/spec/models/enhance_transaction_response_spec.rb +2 -2
  419. data/spec/models/enhance_transactions_request_body_spec.rb +2 -2
  420. data/spec/models/enhance_transactions_request_spec.rb +2 -2
  421. data/spec/models/enhance_transactions_response_body_spec.rb +2 -2
  422. data/spec/models/goal_request_body_spec.rb +2 -2
  423. data/spec/models/goal_request_spec.rb +2 -2
  424. data/spec/models/goal_response_body_spec.rb +2 -2
  425. data/spec/models/goal_response_spec.rb +2 -2
  426. data/spec/models/goals_response_body_spec.rb +2 -2
  427. data/spec/models/goals_response_spec.rb +2 -2
  428. data/spec/models/image_option_response_spec.rb +2 -8
  429. data/spec/models/insight_response_body_spec.rb +2 -2
  430. data/spec/models/insight_response_spec.rb +8 -2
  431. data/spec/models/insight_update_request_body_spec.rb +36 -0
  432. data/spec/models/insight_update_request_spec.rb +2 -2
  433. data/spec/models/insights_response_body_spec.rb +2 -2
  434. data/spec/models/institution_response_body_spec.rb +2 -2
  435. data/spec/models/institution_response_spec.rb +20 -2
  436. data/spec/models/institutions_response_body_spec.rb +2 -2
  437. data/spec/models/investment_holding_response_body_spec.rb +36 -0
  438. data/spec/models/investment_holding_response_spec.rb +252 -0
  439. data/spec/models/investment_holdings_deactivation_spec.rb +42 -0
  440. data/spec/models/investment_holdings_response_body_spec.rb +42 -0
  441. data/spec/models/managed_account_create_request_body_spec.rb +2 -2
  442. data/spec/models/managed_account_create_request_spec.rb +2 -2
  443. data/spec/models/managed_account_update_request_body_spec.rb +2 -2
  444. data/spec/models/managed_account_update_request_spec.rb +2 -2
  445. data/spec/models/managed_member_create_request_body_spec.rb +2 -2
  446. data/spec/models/managed_member_create_request_spec.rb +2 -2
  447. data/spec/models/managed_member_update_request_body_spec.rb +2 -2
  448. data/spec/models/managed_member_update_request_spec.rb +2 -2
  449. data/spec/models/managed_transaction_create_request_body_spec.rb +2 -2
  450. data/spec/models/managed_transaction_create_request_spec.rb +2 -2
  451. data/spec/models/managed_transaction_update_request_body_spec.rb +2 -2
  452. data/spec/models/managed_transaction_update_request_spec.rb +2 -2
  453. data/spec/models/member_create_request_body_spec.rb +2 -2
  454. data/spec/models/member_create_request_spec.rb +12 -2
  455. data/spec/models/member_elements_spec.rb +48 -0
  456. data/spec/models/member_response_body_spec.rb +2 -2
  457. data/spec/models/member_response_spec.rb +2 -8
  458. data/spec/models/member_resume_request_body_spec.rb +2 -2
  459. data/spec/models/member_resume_request_spec.rb +2 -2
  460. data/spec/models/member_status_response_body_spec.rb +2 -2
  461. data/spec/models/member_status_response_spec.rb +4 -4
  462. data/spec/models/member_update_request_body_spec.rb +2 -2
  463. data/spec/models/member_update_request_spec.rb +12 -2
  464. data/spec/models/members_response_body_spec.rb +2 -2
  465. data/spec/models/merchant_location_response_body_spec.rb +2 -2
  466. data/spec/models/merchant_location_response_spec.rb +2 -2
  467. data/spec/models/merchant_response_body_spec.rb +2 -2
  468. data/spec/models/merchant_response_spec.rb +2 -2
  469. data/spec/models/merchants_response_body_spec.rb +2 -2
  470. data/spec/models/{microdeposit_request_spec.rb → microdeposit_elements_spec.rb} +15 -15
  471. data/spec/models/microdeposit_request_body_spec.rb +2 -2
  472. data/spec/models/microdeposit_response_body_micro_deposit_inner_spec.rb +114 -0
  473. data/spec/models/microdeposit_response_body_spec.rb +2 -2
  474. data/spec/models/microdeposit_response_spec.rb +2 -44
  475. data/spec/models/microdeposit_verify_request_body_spec.rb +2 -2
  476. data/spec/models/microdeposit_verify_request_spec.rb +2 -2
  477. data/spec/models/microdeposits_response_body_spec.rb +2 -2
  478. data/spec/models/monthly_cash_flow_profile_request_body_spec.rb +2 -2
  479. data/spec/models/monthly_cash_flow_profile_request_spec.rb +2 -2
  480. data/spec/models/monthly_cash_flow_response_body_spec.rb +2 -2
  481. data/spec/models/monthly_cash_flow_response_spec.rb +2 -2
  482. data/spec/models/notification_response_body_spec.rb +36 -0
  483. data/spec/models/{tax_document_response_spec.rb → notification_response_spec.rb} +18 -18
  484. data/spec/models/notifications_response_body_spec.rb +36 -0
  485. data/spec/models/o_auth_window_response_body_spec.rb +2 -2
  486. data/spec/models/o_auth_window_response_spec.rb +2 -2
  487. data/spec/models/option_response_spec.rb +2 -8
  488. data/spec/models/pagination_response_spec.rb +2 -2
  489. data/spec/models/{reward_response_spec.rb → payment_account_body_payment_account_spec.rb} +24 -18
  490. data/spec/models/payment_account_body_spec.rb +36 -0
  491. data/spec/models/payment_account_spec.rb +84 -0
  492. data/spec/models/payment_processor_authorization_code_request_body_spec.rb +2 -2
  493. data/spec/models/payment_processor_authorization_code_request_spec.rb +2 -2
  494. data/spec/models/payment_processor_authorization_code_response_body_spec.rb +2 -2
  495. data/spec/models/payment_processor_authorization_code_response_spec.rb +2 -2
  496. data/spec/models/processor_account_number_body_account_numbers_inner_spec.rb +102 -0
  497. data/spec/models/processor_account_number_body_spec.rb +36 -0
  498. data/spec/models/processor_account_number_spec.rb +84 -0
  499. data/spec/models/processor_owner_body_account_owners_inner_spec.rb +102 -0
  500. data/spec/models/{holdings_response_body_spec.rb → processor_owner_body_spec.rb} +9 -9
  501. data/spec/models/processor_owner_spec.rb +84 -0
  502. data/spec/models/repeating_transaction_response_spec.rb +110 -0
  503. data/spec/models/repeating_transactions_response_body_spec.rb +36 -0
  504. data/spec/models/reposition_request_body_spec.rb +2 -2
  505. data/spec/models/reposition_request_spec.rb +2 -2
  506. data/spec/models/reposition_response_body_spec.rb +2 -2
  507. data/spec/models/reward_elements_spec.rb +78 -0
  508. data/spec/models/reward_response_body_spec.rb +2 -2
  509. data/spec/models/{rewards_response_spec.rb → rewards_response_body_rewards_inner_spec.rb} +18 -18
  510. data/spec/models/rewards_response_body_spec.rb +2 -2
  511. data/spec/models/scheduled_payment_response_spec.rb +2 -2
  512. data/spec/models/scheduled_payments_response_body_spec.rb +4 -4
  513. data/spec/models/spending_plan_account_response_spec.rb +2 -2
  514. data/spec/models/spending_plan_accounts_response_spec.rb +2 -2
  515. data/spec/models/spending_plan_iteration_item_create_request_body_spec.rb +2 -2
  516. data/spec/models/spending_plan_iteration_item_response_spec.rb +2 -2
  517. data/spec/models/spending_plan_iteration_items_response_body_spec.rb +2 -2
  518. data/spec/models/spending_plan_iteration_response_spec.rb +2 -2
  519. data/spec/models/spending_plan_iterations_response_spec.rb +2 -2
  520. data/spec/models/spending_plan_response_spec.rb +2 -2
  521. data/spec/models/spending_plans_response_body_spec.rb +2 -2
  522. data/spec/models/split_transaction_request_body_spec.rb +2 -2
  523. data/spec/models/split_transaction_request_spec.rb +2 -2
  524. data/spec/models/split_transactions_response_body_spec.rb +2 -2
  525. data/spec/models/statement_response_body_spec.rb +2 -2
  526. data/spec/models/statement_response_spec.rb +2 -2
  527. data/spec/models/statements_response_body_spec.rb +4 -4
  528. data/spec/models/tag_create_request_body_spec.rb +2 -2
  529. data/spec/models/tag_create_request_spec.rb +2 -2
  530. data/spec/models/tag_response_body_spec.rb +2 -2
  531. data/spec/models/tag_response_spec.rb +2 -2
  532. data/spec/models/tag_update_request_body_spec.rb +2 -2
  533. data/spec/models/tag_update_request_spec.rb +2 -2
  534. data/spec/models/tagging_create_request_body_spec.rb +2 -2
  535. data/spec/models/tagging_create_request_spec.rb +2 -2
  536. data/spec/models/tagging_response_body_spec.rb +2 -2
  537. data/spec/models/tagging_response_spec.rb +2 -2
  538. data/spec/models/tagging_update_request_body_spec.rb +2 -2
  539. data/spec/models/tagging_update_request_spec.rb +2 -2
  540. data/spec/models/taggings_response_body_spec.rb +4 -4
  541. data/spec/models/tags_response_body_spec.rb +4 -4
  542. data/spec/models/{tax_document_response_body_spec.rb → token_request_body_spec.rb} +9 -9
  543. data/spec/models/token_response_body_spec.rb +36 -0
  544. data/spec/models/token_response_spec.rb +54 -0
  545. data/spec/models/transaction_create_request_body_spec.rb +2 -2
  546. data/spec/models/transaction_create_request_spec.rb +2 -2
  547. data/spec/models/transaction_create_response_body_spec.rb +2 -2
  548. data/spec/models/transaction_includes_response_all_of_classification_spec.rb +46 -0
  549. data/spec/models/transaction_includes_response_all_of_geolocation_spec.rb +54 -0
  550. data/spec/models/transaction_includes_response_all_of_merchant_spec.rb +54 -0
  551. data/spec/models/transaction_includes_response_all_of_repeating_transaction_spec.rb +56 -0
  552. data/spec/models/transaction_includes_response_spec.rb +318 -0
  553. data/spec/models/transaction_response_body_spec.rb +2 -2
  554. data/spec/models/transaction_response_spec.rb +8 -2
  555. data/spec/models/transaction_rule_create_request_body_spec.rb +2 -2
  556. data/spec/models/transaction_rule_create_request_spec.rb +2 -2
  557. data/spec/models/transaction_rule_response_body_spec.rb +2 -2
  558. data/spec/models/transaction_rule_response_spec.rb +2 -2
  559. data/spec/models/transaction_rule_update_request_body_spec.rb +2 -2
  560. data/spec/models/transaction_rule_update_request_spec.rb +2 -2
  561. data/spec/models/transaction_rules_response_body_spec.rb +4 -4
  562. data/spec/models/transaction_update_request_body_spec.rb +2 -2
  563. data/spec/models/transaction_update_request_spec.rb +20 -2
  564. data/spec/models/transactions_response_body_includes_spec.rb +42 -0
  565. data/spec/models/transactions_response_body_spec.rb +4 -4
  566. data/spec/models/update_goal_request_body_spec.rb +2 -2
  567. data/spec/models/update_goal_request_spec.rb +2 -2
  568. data/spec/models/user_create_request_body_spec.rb +2 -2
  569. data/spec/models/user_create_request_spec.rb +2 -2
  570. data/spec/models/user_response_body_spec.rb +2 -2
  571. data/spec/models/user_response_spec.rb +2 -2
  572. data/spec/models/user_update_request_body_spec.rb +2 -2
  573. data/spec/models/user_update_request_spec.rb +2 -2
  574. data/spec/models/users_response_body_spec.rb +4 -4
  575. data/spec/models/{holding_response_body_spec.rb → vc_response_spec.rb} +9 -9
  576. data/spec/models/widget_request_body_spec.rb +2 -2
  577. data/spec/models/widget_request_spec.rb +30 -2
  578. data/spec/models/widget_response_body_spec.rb +2 -2
  579. data/spec/models/widget_response_spec.rb +2 -2
  580. data/spec/spec_helper.rb +2 -2
  581. metadata +233 -41
  582. data/docs/HoldingResponse.md +0 -54
  583. data/docs/HoldingResponseBody.md +0 -18
  584. data/docs/MxPlatformApi.md +0 -8065
  585. data/docs/TaxDocumentResponse.md +0 -36
  586. data/docs/TaxDocumentResponseBody.md +0 -18
  587. data/docs/TaxDocumentsResponseBody.md +0 -20
  588. data/lib/mx-platform-ruby/api/mx_platform_api.rb +0 -7795
  589. data/spec/api/mx_platform_api_spec.rb +0 -1519
data/docs/InsightsApi.md CHANGED
@@ -1,25 +1,26 @@
1
1
  # MxPlatformRuby::InsightsApi
2
2
 
3
- All URIs are relative to *https://api.mx.com*
3
+ All URIs are relative to *https://int-api.mx.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**list_accounts_insight**](InsightsApi.md#list_accounts_insight) | **GET** /users/{user_guid}/insights/{insight_guid}/accounts | List all accounts associated with an insight. |
8
- | [**list_categories_insight**](InsightsApi.md#list_categories_insight) | **GET** /users/{user_guid}/insights/{insight_guid}/categories | List all categories associated with an insight. |
7
+ | [**list_accounts_insight**](InsightsApi.md#list_accounts_insight) | **GET** /users/{user_guid}/insights/{insight_guid}/accounts | List all accounts associated with an insight |
8
+ | [**list_categories_insight**](InsightsApi.md#list_categories_insight) | **GET** /users/{user_guid}/insights/{insight_guid}/categories | List all categories associated with an insight |
9
9
  | [**list_insights_by_account**](InsightsApi.md#list_insights_by_account) | **GET** /users/{user_guid}/accounts/{account_guid}/insights | List insights by account |
10
- | [**list_insights_user**](InsightsApi.md#list_insights_user) | **GET** /users/{user_guid}/insights | List all insights for a user. |
11
- | [**list_merchants_insight**](InsightsApi.md#list_merchants_insight) | **GET** /users/{user_guid}/insights/{insight_guid}/merchants | List all merchants associated with an insight. |
10
+ | [**list_insights_by_transaction**](InsightsApi.md#list_insights_by_transaction) | **GET** /users/{user_guid}/transactions/{transaction_guid}/insights | List insights by transaction |
11
+ | [**list_insights_user**](InsightsApi.md#list_insights_user) | **GET** /users/{user_guid}/insights | List all insights for a user |
12
+ | [**list_merchants_insight**](InsightsApi.md#list_merchants_insight) | **GET** /users/{user_guid}/insights/{insight_guid}/merchants | List all merchants associated with an insight |
12
13
  | [**list_scheduled_payments_insight**](InsightsApi.md#list_scheduled_payments_insight) | **GET** /users/{user_guid}/insights/{insight_guid}/scheduled_payments | List all scheduled payments associated with an insight |
13
- | [**list_transactions_insight**](InsightsApi.md#list_transactions_insight) | **GET** /users/{user_guid}/insights/{insight_guid}/transactions | List all transactions associated with an insight. |
14
- | [**read_insights_user**](InsightsApi.md#read_insights_user) | **GET** /users/{user_guid}/insights{insight_guid} | Read a specific insight. |
15
- | [**update_insight**](InsightsApi.md#update_insight) | **PUT** /users/{user_guid}/insights{insight_guid} | Update insight |
14
+ | [**list_transactions_insight**](InsightsApi.md#list_transactions_insight) | **GET** /users/{user_guid}/insights/{insight_guid}/transactions | List all transactions associated with an insight |
15
+ | [**read_insight_user**](InsightsApi.md#read_insight_user) | **GET** /users/{user_guid}/insights/{insight_guid} | Read insight |
16
+ | [**update_insight**](InsightsApi.md#update_insight) | **PUT** /users/{user_guid}/insights/{insight_guid} | Update insight |
16
17
 
17
18
 
18
19
  ## list_accounts_insight
19
20
 
20
21
  > <AccountsResponseBody> list_accounts_insight(user_guid, insight_guid, opts)
21
22
 
22
- List all accounts associated with an insight.
23
+ List all accounts associated with an insight
23
24
 
24
25
  Use this endpoint to list all the accounts associated with the insight.
25
26
 
@@ -36,15 +37,15 @@ MxPlatformRuby.configure do |config|
36
37
  end
37
38
 
38
39
  api_instance = MxPlatformRuby::InsightsApi.new
39
- user_guid = 'USR-1234-abcd' # String | The unique identifier for the user. Defined by MX.
40
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
40
41
  insight_guid = 'BET-1234-abcd' # String | The unique identifier for the insight. Defined by MX.
41
42
  opts = {
42
- page: 1, # Integer | Specify current page.
43
- records_per_page: 10 # Integer | Specify records per page.
43
+ page: 1, # Integer | Results are paginated. Specify current page.
44
+ records_per_page: 10 # Integer | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead.
44
45
  }
45
46
 
46
47
  begin
47
- # List all accounts associated with an insight.
48
+ # List all accounts associated with an insight
48
49
  result = api_instance.list_accounts_insight(user_guid, insight_guid, opts)
49
50
  p result
50
51
  rescue MxPlatformRuby::ApiError => e
@@ -60,7 +61,7 @@ This returns an Array which contains the response data, status code and headers.
60
61
 
61
62
  ```ruby
62
63
  begin
63
- # List all accounts associated with an insight.
64
+ # List all accounts associated with an insight
64
65
  data, status_code, headers = api_instance.list_accounts_insight_with_http_info(user_guid, insight_guid, opts)
65
66
  p status_code # => 2xx
66
67
  p headers # => { ... }
@@ -74,10 +75,10 @@ end
74
75
 
75
76
  | Name | Type | Description | Notes |
76
77
  | ---- | ---- | ----------- | ----- |
77
- | **user_guid** | **String** | The unique identifier for the user. Defined by MX. | |
78
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
78
79
  | **insight_guid** | **String** | The unique identifier for the insight. Defined by MX. | |
79
- | **page** | **Integer** | Specify current page. | [optional] |
80
- | **records_per_page** | **Integer** | Specify records per page. | [optional] |
80
+ | **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
81
+ | **records_per_page** | **Integer** | This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;100&#x60;. If the value exceeds &#x60;100&#x60;, the default value of &#x60;25&#x60; will be used instead. | [optional] |
81
82
 
82
83
  ### Return type
83
84
 
@@ -97,7 +98,7 @@ end
97
98
 
98
99
  > <CategoriesResponseBody> list_categories_insight(user_guid, insight_guid, opts)
99
100
 
100
- List all categories associated with an insight.
101
+ List all categories associated with an insight
101
102
 
102
103
  Use this endpoint to list all the categories associated with the insight.
103
104
 
@@ -114,15 +115,15 @@ MxPlatformRuby.configure do |config|
114
115
  end
115
116
 
116
117
  api_instance = MxPlatformRuby::InsightsApi.new
117
- user_guid = 'USR-1234-abcd' # String | The unique identifier for the user. Defined by MX.
118
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
118
119
  insight_guid = 'BET-1234-abcd' # String | The unique identifier for the insight. Defined by MX.
119
120
  opts = {
120
- page: 1, # Integer | Specify current page.
121
- records_per_page: 10 # Integer | Specify records per page.
121
+ page: 1, # Integer | Results are paginated. Specify current page.
122
+ records_per_page: 10 # Integer | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead.
122
123
  }
123
124
 
124
125
  begin
125
- # List all categories associated with an insight.
126
+ # List all categories associated with an insight
126
127
  result = api_instance.list_categories_insight(user_guid, insight_guid, opts)
127
128
  p result
128
129
  rescue MxPlatformRuby::ApiError => e
@@ -138,7 +139,7 @@ This returns an Array which contains the response data, status code and headers.
138
139
 
139
140
  ```ruby
140
141
  begin
141
- # List all categories associated with an insight.
142
+ # List all categories associated with an insight
142
143
  data, status_code, headers = api_instance.list_categories_insight_with_http_info(user_guid, insight_guid, opts)
143
144
  p status_code # => 2xx
144
145
  p headers # => { ... }
@@ -152,10 +153,10 @@ end
152
153
 
153
154
  | Name | Type | Description | Notes |
154
155
  | ---- | ---- | ----------- | ----- |
155
- | **user_guid** | **String** | The unique identifier for the user. Defined by MX. | |
156
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
156
157
  | **insight_guid** | **String** | The unique identifier for the insight. Defined by MX. | |
157
- | **page** | **Integer** | Specify current page. | [optional] |
158
- | **records_per_page** | **Integer** | Specify records per page. | [optional] |
158
+ | **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
159
+ | **records_per_page** | **Integer** | This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;100&#x60;. If the value exceeds &#x60;100&#x60;, the default value of &#x60;25&#x60; will be used instead. | [optional] |
159
160
 
160
161
  ### Return type
161
162
 
@@ -177,7 +178,7 @@ end
177
178
 
178
179
  List insights by account
179
180
 
180
- Use this endpoint to list all insights associated with a specified account GUID.
181
+ Use this endpoint to list all insights associated with an account GUID.
181
182
 
182
183
  ### Examples
183
184
 
@@ -192,11 +193,11 @@ MxPlatformRuby.configure do |config|
192
193
  end
193
194
 
194
195
  api_instance = MxPlatformRuby::InsightsApi.new
195
- account_guid = 'ACT-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for the `account`.
196
- user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for the `user`.
196
+ account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
197
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
197
198
  opts = {
198
- page: 1, # Integer | Specify current page.
199
- records_per_page: 10 # Integer | Specify records per page.
199
+ page: 1, # Integer | Results are paginated. Specify current page.
200
+ records_per_page: 10 # Integer | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead.
200
201
  }
201
202
 
202
203
  begin
@@ -230,10 +231,88 @@ end
230
231
 
231
232
  | Name | Type | Description | Notes |
232
233
  | ---- | ---- | ----------- | ----- |
233
- | **account_guid** | **String** | The unique id for the &#x60;account&#x60;. | |
234
- | **user_guid** | **String** | The unique id for the &#x60;user&#x60;. | |
235
- | **page** | **Integer** | Specify current page. | [optional] |
236
- | **records_per_page** | **Integer** | Specify records per page. | [optional] |
234
+ | **account_guid** | **String** | The unique id for an &#x60;account&#x60;. | |
235
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
236
+ | **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
237
+ | **records_per_page** | **Integer** | This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;100&#x60;. If the value exceeds &#x60;100&#x60;, the default value of &#x60;25&#x60; will be used instead. | [optional] |
238
+
239
+ ### Return type
240
+
241
+ [**InsightsResponseBody**](InsightsResponseBody.md)
242
+
243
+ ### Authorization
244
+
245
+ [basicAuth](../README.md#basicAuth)
246
+
247
+ ### HTTP request headers
248
+
249
+ - **Content-Type**: Not defined
250
+ - **Accept**: application/vnd.mx.api.v1+json
251
+
252
+
253
+ ## list_insights_by_transaction
254
+
255
+ > <InsightsResponseBody> list_insights_by_transaction(transaction_guid, user_guid, opts)
256
+
257
+ List insights by transaction
258
+
259
+ Use this endpoint to list all insights associated with a transaction GUID.
260
+
261
+ ### Examples
262
+
263
+ ```ruby
264
+ require 'time'
265
+ require 'mx-platform-ruby'
266
+ # setup authorization
267
+ MxPlatformRuby.configure do |config|
268
+ # Configure HTTP basic authorization: basicAuth
269
+ config.username = 'YOUR USERNAME'
270
+ config.password = 'YOUR PASSWORD'
271
+ end
272
+
273
+ api_instance = MxPlatformRuby::InsightsApi.new
274
+ transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
275
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
276
+ opts = {
277
+ page: 1, # Integer | Results are paginated. Specify current page.
278
+ records_per_page: 10 # Integer | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead.
279
+ }
280
+
281
+ begin
282
+ # List insights by transaction
283
+ result = api_instance.list_insights_by_transaction(transaction_guid, user_guid, opts)
284
+ p result
285
+ rescue MxPlatformRuby::ApiError => e
286
+ puts "Error when calling InsightsApi->list_insights_by_transaction: #{e}"
287
+ end
288
+ ```
289
+
290
+ #### Using the list_insights_by_transaction_with_http_info variant
291
+
292
+ This returns an Array which contains the response data, status code and headers.
293
+
294
+ > <Array(<InsightsResponseBody>, Integer, Hash)> list_insights_by_transaction_with_http_info(transaction_guid, user_guid, opts)
295
+
296
+ ```ruby
297
+ begin
298
+ # List insights by transaction
299
+ data, status_code, headers = api_instance.list_insights_by_transaction_with_http_info(transaction_guid, user_guid, opts)
300
+ p status_code # => 2xx
301
+ p headers # => { ... }
302
+ p data # => <InsightsResponseBody>
303
+ rescue MxPlatformRuby::ApiError => e
304
+ puts "Error when calling InsightsApi->list_insights_by_transaction_with_http_info: #{e}"
305
+ end
306
+ ```
307
+
308
+ ### Parameters
309
+
310
+ | Name | Type | Description | Notes |
311
+ | ---- | ---- | ----------- | ----- |
312
+ | **transaction_guid** | **String** | The unique id for a &#x60;transaction&#x60;. | |
313
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
314
+ | **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
315
+ | **records_per_page** | **Integer** | This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;100&#x60;. If the value exceeds &#x60;100&#x60;, the default value of &#x60;25&#x60; will be used instead. | [optional] |
237
316
 
238
317
  ### Return type
239
318
 
@@ -253,7 +332,7 @@ end
253
332
 
254
333
  > <InsightsResponseBody> list_insights_user(user_guid, opts)
255
334
 
256
- List all insights for a user.
335
+ List all insights for a user
257
336
 
258
337
  Use this endpoint to list all the insights associated with the user.
259
338
 
@@ -270,14 +349,14 @@ MxPlatformRuby.configure do |config|
270
349
  end
271
350
 
272
351
  api_instance = MxPlatformRuby::InsightsApi.new
273
- user_guid = 'USR-1234-abcd' # String | The unique identifier for the user. Defined by MX.
352
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
274
353
  opts = {
275
- page: 1, # Integer | Specify current page.
276
- records_per_page: 10 # Integer | Specify records per page.
354
+ page: 1, # Integer | Results are paginated. Specify current page.
355
+ records_per_page: 10 # Integer | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead.
277
356
  }
278
357
 
279
358
  begin
280
- # List all insights for a user.
359
+ # List all insights for a user
281
360
  result = api_instance.list_insights_user(user_guid, opts)
282
361
  p result
283
362
  rescue MxPlatformRuby::ApiError => e
@@ -293,7 +372,7 @@ This returns an Array which contains the response data, status code and headers.
293
372
 
294
373
  ```ruby
295
374
  begin
296
- # List all insights for a user.
375
+ # List all insights for a user
297
376
  data, status_code, headers = api_instance.list_insights_user_with_http_info(user_guid, opts)
298
377
  p status_code # => 2xx
299
378
  p headers # => { ... }
@@ -307,9 +386,9 @@ end
307
386
 
308
387
  | Name | Type | Description | Notes |
309
388
  | ---- | ---- | ----------- | ----- |
310
- | **user_guid** | **String** | The unique identifier for the user. Defined by MX. | |
311
- | **page** | **Integer** | Specify current page. | [optional] |
312
- | **records_per_page** | **Integer** | Specify records per page. | [optional] |
389
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
390
+ | **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
391
+ | **records_per_page** | **Integer** | This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;100&#x60;. If the value exceeds &#x60;100&#x60;, the default value of &#x60;25&#x60; will be used instead. | [optional] |
313
392
 
314
393
  ### Return type
315
394
 
@@ -329,7 +408,7 @@ end
329
408
 
330
409
  > <MerchantsResponseBody> list_merchants_insight(user_guid, insight_guid, opts)
331
410
 
332
- List all merchants associated with an insight.
411
+ List all merchants associated with an insight
333
412
 
334
413
  Use this endpoint to list all the merchants associated with the insight.
335
414
 
@@ -346,15 +425,15 @@ MxPlatformRuby.configure do |config|
346
425
  end
347
426
 
348
427
  api_instance = MxPlatformRuby::InsightsApi.new
349
- user_guid = 'USR-1234-abcd' # String | The unique identifier for the user. Defined by MX.
428
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
350
429
  insight_guid = 'BET-1234-abcd' # String | The unique identifier for the insight. Defined by MX.
351
430
  opts = {
352
- page: 1, # Integer | Specify current page.
353
- records_per_page: 10 # Integer | Specify records per page.
431
+ page: 1, # Integer | Results are paginated. Specify current page.
432
+ records_per_page: 10 # Integer | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead.
354
433
  }
355
434
 
356
435
  begin
357
- # List all merchants associated with an insight.
436
+ # List all merchants associated with an insight
358
437
  result = api_instance.list_merchants_insight(user_guid, insight_guid, opts)
359
438
  p result
360
439
  rescue MxPlatformRuby::ApiError => e
@@ -370,7 +449,7 @@ This returns an Array which contains the response data, status code and headers.
370
449
 
371
450
  ```ruby
372
451
  begin
373
- # List all merchants associated with an insight.
452
+ # List all merchants associated with an insight
374
453
  data, status_code, headers = api_instance.list_merchants_insight_with_http_info(user_guid, insight_guid, opts)
375
454
  p status_code # => 2xx
376
455
  p headers # => { ... }
@@ -384,10 +463,10 @@ end
384
463
 
385
464
  | Name | Type | Description | Notes |
386
465
  | ---- | ---- | ----------- | ----- |
387
- | **user_guid** | **String** | The unique identifier for the user. Defined by MX. | |
466
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
388
467
  | **insight_guid** | **String** | The unique identifier for the insight. Defined by MX. | |
389
- | **page** | **Integer** | Specify current page. | [optional] |
390
- | **records_per_page** | **Integer** | Specify records per page. | [optional] |
468
+ | **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
469
+ | **records_per_page** | **Integer** | This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;100&#x60;. If the value exceeds &#x60;100&#x60;, the default value of &#x60;25&#x60; will be used instead. | [optional] |
391
470
 
392
471
  ### Return type
393
472
 
@@ -424,11 +503,11 @@ MxPlatformRuby.configure do |config|
424
503
  end
425
504
 
426
505
  api_instance = MxPlatformRuby::InsightsApi.new
427
- user_guid = 'USR-1234-abcd' # String | The unique identifier for the user. Defined by MX.
506
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
428
507
  insight_guid = 'BET-1234-abcd' # String | The unique identifier for the insight. Defined by MX.
429
508
  opts = {
430
- page: 1, # Integer | Specify current page.
431
- records_per_page: 10 # Integer | Specify records per page.
509
+ page: 1, # Integer | Results are paginated. Specify current page.
510
+ records_per_page: 10 # Integer | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead.
432
511
  }
433
512
 
434
513
  begin
@@ -462,10 +541,10 @@ end
462
541
 
463
542
  | Name | Type | Description | Notes |
464
543
  | ---- | ---- | ----------- | ----- |
465
- | **user_guid** | **String** | The unique identifier for the user. Defined by MX. | |
544
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
466
545
  | **insight_guid** | **String** | The unique identifier for the insight. Defined by MX. | |
467
- | **page** | **Integer** | Specify current page. | [optional] |
468
- | **records_per_page** | **Integer** | Specify records per page. | [optional] |
546
+ | **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
547
+ | **records_per_page** | **Integer** | This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;100&#x60;. If the value exceeds &#x60;100&#x60;, the default value of &#x60;25&#x60; will be used instead. | [optional] |
469
548
 
470
549
  ### Return type
471
550
 
@@ -485,7 +564,7 @@ end
485
564
 
486
565
  > <TransactionsResponseBody> list_transactions_insight(user_guid, insight_guid, opts)
487
566
 
488
- List all transactions associated with an insight.
567
+ List all transactions associated with an insight
489
568
 
490
569
  Use this endpoint to list all the transactions associated with the insight.
491
570
 
@@ -502,15 +581,15 @@ MxPlatformRuby.configure do |config|
502
581
  end
503
582
 
504
583
  api_instance = MxPlatformRuby::InsightsApi.new
505
- user_guid = 'USR-1234-abcd' # String | The unique identifier for the user. Defined by MX.
584
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
506
585
  insight_guid = 'BET-1234-abcd' # String | The unique identifier for the insight. Defined by MX.
507
586
  opts = {
508
- page: 1, # Integer | Specify current page.
509
- records_per_page: 10 # Integer | Specify records per page.
587
+ page: 1, # Integer | Results are paginated. Specify current page.
588
+ records_per_page: 10 # Integer | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead.
510
589
  }
511
590
 
512
591
  begin
513
- # List all transactions associated with an insight.
592
+ # List all transactions associated with an insight
514
593
  result = api_instance.list_transactions_insight(user_guid, insight_guid, opts)
515
594
  p result
516
595
  rescue MxPlatformRuby::ApiError => e
@@ -526,7 +605,7 @@ This returns an Array which contains the response data, status code and headers.
526
605
 
527
606
  ```ruby
528
607
  begin
529
- # List all transactions associated with an insight.
608
+ # List all transactions associated with an insight
530
609
  data, status_code, headers = api_instance.list_transactions_insight_with_http_info(user_guid, insight_guid, opts)
531
610
  p status_code # => 2xx
532
611
  p headers # => { ... }
@@ -540,10 +619,10 @@ end
540
619
 
541
620
  | Name | Type | Description | Notes |
542
621
  | ---- | ---- | ----------- | ----- |
543
- | **user_guid** | **String** | The unique identifier for the user. Defined by MX. | |
622
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
544
623
  | **insight_guid** | **String** | The unique identifier for the insight. Defined by MX. | |
545
- | **page** | **Integer** | Specify current page. | [optional] |
546
- | **records_per_page** | **Integer** | Specify records per page. | [optional] |
624
+ | **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
625
+ | **records_per_page** | **Integer** | This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;100&#x60;. If the value exceeds &#x60;100&#x60;, the default value of &#x60;25&#x60; will be used instead. | [optional] |
547
626
 
548
627
  ### Return type
549
628
 
@@ -559,13 +638,13 @@ end
559
638
  - **Accept**: application/vnd.mx.api.v1+json
560
639
 
561
640
 
562
- ## read_insights_user
641
+ ## read_insight_user
563
642
 
564
- > <InsightResponseBody> read_insights_user(user_guid, insight_guid)
643
+ > <InsightResponseBody> read_insight_user(user_guid, insight_guid)
565
644
 
566
- Read a specific insight.
645
+ Read insight
567
646
 
568
- Use this endpoint to read the attributes of a specific insight according to its unique GUID.
647
+ Use this endpoint to read the attributes of an insight according to its unique GUID.
569
648
 
570
649
  ### Examples
571
650
 
@@ -580,33 +659,33 @@ MxPlatformRuby.configure do |config|
580
659
  end
581
660
 
582
661
  api_instance = MxPlatformRuby::InsightsApi.new
583
- user_guid = 'USR-1234-abcd' # String | The unique identifier for the user. Defined by MX.
662
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
584
663
  insight_guid = 'BET-1234-abcd' # String | The unique identifier for the insight. Defined by MX.
585
664
 
586
665
  begin
587
- # Read a specific insight.
588
- result = api_instance.read_insights_user(user_guid, insight_guid)
666
+ # Read insight
667
+ result = api_instance.read_insight_user(user_guid, insight_guid)
589
668
  p result
590
669
  rescue MxPlatformRuby::ApiError => e
591
- puts "Error when calling InsightsApi->read_insights_user: #{e}"
670
+ puts "Error when calling InsightsApi->read_insight_user: #{e}"
592
671
  end
593
672
  ```
594
673
 
595
- #### Using the read_insights_user_with_http_info variant
674
+ #### Using the read_insight_user_with_http_info variant
596
675
 
597
676
  This returns an Array which contains the response data, status code and headers.
598
677
 
599
- > <Array(<InsightResponseBody>, Integer, Hash)> read_insights_user_with_http_info(user_guid, insight_guid)
678
+ > <Array(<InsightResponseBody>, Integer, Hash)> read_insight_user_with_http_info(user_guid, insight_guid)
600
679
 
601
680
  ```ruby
602
681
  begin
603
- # Read a specific insight.
604
- data, status_code, headers = api_instance.read_insights_user_with_http_info(user_guid, insight_guid)
682
+ # Read insight
683
+ data, status_code, headers = api_instance.read_insight_user_with_http_info(user_guid, insight_guid)
605
684
  p status_code # => 2xx
606
685
  p headers # => { ... }
607
686
  p data # => <InsightResponseBody>
608
687
  rescue MxPlatformRuby::ApiError => e
609
- puts "Error when calling InsightsApi->read_insights_user_with_http_info: #{e}"
688
+ puts "Error when calling InsightsApi->read_insight_user_with_http_info: #{e}"
610
689
  end
611
690
  ```
612
691
 
@@ -614,7 +693,7 @@ end
614
693
 
615
694
  | Name | Type | Description | Notes |
616
695
  | ---- | ---- | ----------- | ----- |
617
- | **user_guid** | **String** | The unique identifier for the user. Defined by MX. | |
696
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
618
697
  | **insight_guid** | **String** | The unique identifier for the insight. Defined by MX. | |
619
698
 
620
699
  ### Return type
@@ -633,11 +712,11 @@ end
633
712
 
634
713
  ## update_insight
635
714
 
636
- > <InsightResponse> update_insight(user_guid, insight_guid, insight_update_request)
715
+ > <InsightResponse> update_insight(user_guid, insight_guid, insight_update_request_body)
637
716
 
638
717
  Update insight
639
718
 
640
- Use this endpoint to update the attributes of a particular insight according to its unique GUID.
719
+ Use this endpoint to update the attributes of an insight according to its unique GUID.
641
720
 
642
721
  ### Examples
643
722
 
@@ -652,13 +731,13 @@ MxPlatformRuby.configure do |config|
652
731
  end
653
732
 
654
733
  api_instance = MxPlatformRuby::InsightsApi.new
655
- user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for the user. Defined by MX.
734
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
656
735
  insight_guid = 'BET-1234-abcd' # String | The unique identifier for the insight. Defined by MX.
657
- insight_update_request = MxPlatformRuby::InsightUpdateRequest.new # InsightUpdateRequest | The insight to be updated (None of these parameters are required, but the user object cannot be empty.)
736
+ insight_update_request_body = MxPlatformRuby::InsightUpdateRequestBody.new # InsightUpdateRequestBody | The insight to be updated (None of these parameters are required, but the user object cannot be empty.)
658
737
 
659
738
  begin
660
739
  # Update insight
661
- result = api_instance.update_insight(user_guid, insight_guid, insight_update_request)
740
+ result = api_instance.update_insight(user_guid, insight_guid, insight_update_request_body)
662
741
  p result
663
742
  rescue MxPlatformRuby::ApiError => e
664
743
  puts "Error when calling InsightsApi->update_insight: #{e}"
@@ -669,12 +748,12 @@ end
669
748
 
670
749
  This returns an Array which contains the response data, status code and headers.
671
750
 
672
- > <Array(<InsightResponse>, Integer, Hash)> update_insight_with_http_info(user_guid, insight_guid, insight_update_request)
751
+ > <Array(<InsightResponse>, Integer, Hash)> update_insight_with_http_info(user_guid, insight_guid, insight_update_request_body)
673
752
 
674
753
  ```ruby
675
754
  begin
676
755
  # Update insight
677
- data, status_code, headers = api_instance.update_insight_with_http_info(user_guid, insight_guid, insight_update_request)
756
+ data, status_code, headers = api_instance.update_insight_with_http_info(user_guid, insight_guid, insight_update_request_body)
678
757
  p status_code # => 2xx
679
758
  p headers # => { ... }
680
759
  p data # => <InsightResponse>
@@ -687,9 +766,9 @@ end
687
766
 
688
767
  | Name | Type | Description | Notes |
689
768
  | ---- | ---- | ----------- | ----- |
690
- | **user_guid** | **String** | The unique identifier for the user. Defined by MX. | |
769
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
691
770
  | **insight_guid** | **String** | The unique identifier for the insight. Defined by MX. | |
692
- | **insight_update_request** | [**InsightUpdateRequest**](InsightUpdateRequest.md) | The insight to be updated (None of these parameters are required, but the user object cannot be empty.) | |
771
+ | **insight_update_request_body** | [**InsightUpdateRequestBody**](InsightUpdateRequestBody.md) | The insight to be updated (None of these parameters are required, but the user object cannot be empty.) | |
693
772
 
694
773
  ### Return type
695
774
 
data/docs/InstitutionResponse.md CHANGED
@@ -8,6 +8,9 @@
8
8
  | **forgot_password_url** | **String** | | [optional] |
9
9
  | **forgot_username_url** | **String** | | [optional] |
10
10
  | **instructional_text** | **String** | | [optional] |
11
+ | **instructional_text_steps** | **Array&lt;String&gt;** | An array of instructional steps that may contain html elements. | [optional] |
12
+ | **is_disabled_by_client** | **Boolean** | | [optional] |
13
+ | **iso_country_code** | **String** | | [optional] |
11
14
  | **medium_logo_url** | **String** | | [optional] |
12
15
  | **name** | **String** | | [optional] |
13
16
  | **small_logo_url** | **String** | | [optional] |
@@ -26,12 +29,17 @@
26
29
  require 'mx-platform-ruby'
27
30
 
28
31
  instance = MxPlatformRuby::InstitutionResponse.new(
29
- code: chase,
30
- forgot_password_url: https://example.url.chase.com/forgot-password,
31
- forgot_username_url: https://example.url.chase.com/forgot-username,
32
- instructional_text: Some instructional text &lt;a href&#x3D;&quot;https://example.url.chase.com/instructions&quot; id&#x3D;&quot;instructional_text&quot;&gt;for end users&lt;/a&gt;.,
32
+ code: mxbank,
33
+ forgot_password_url: https://example.url.mxbank.com/forgot-password,
34
+ forgot_username_url: https://example.url.mxbank.com/forgot-username,
35
+ instructional_text: Some instructional text &lt;a href&#x3D;&quot;https://example.url.mxbank.com/instructions&quot;
36
+ id&#x3D;&quot;instructional_text&quot;&gt;for end users&lt;/a&gt;.
37
+ ,
38
+ instructional_text_steps: [&quot;Step 1: Do this.&quot;,&quot;Step 2: Do that.&quot;],
39
+ is_disabled_by_client: false,
40
+ iso_country_code: US,
33
41
  medium_logo_url: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png,
34
- name: Chase Bank,
42
+ name: MX Bank,
35
43
  small_logo_url: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png,
36
44
  supports_account_identification: true,
37
45
  supports_account_statement: true,
@@ -39,8 +47,8 @@ instance = MxPlatformRuby::InstitutionResponse.new(
39
47
  supports_oauth: true,
40
48
  supports_tax_document: true,
41
49
  supports_transaction_history: true,
42
- trouble_signing_in_url: https://example.url.chase.com/login-trouble,
43
- url: https://www.chase.com
50
+ trouble_signing_in_url: https://example.url.mxbank.com/login-trouble,
51
+ url: https://www.mxbank.com
44
52
  )
45
53
  ```
46
54