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
@@ -1,9 +1,9 @@
1
1
  =begin
2
2
  #MX Platform API
3
3
 
4
- #The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.
4
+ #The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions. Just getting started? See our [use case guides](/use-cases/).
5
5
 
6
- The version of the OpenAPI document: 0.1.0
6
+ The version of the OpenAPI document: 20111101
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.8.0
@@ -19,26 +19,26 @@ module MxPlatformRuby
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # List all accounts associated with an insight.
22
+ # List all accounts associated with an insight
23
23
  # Use this endpoint to list all the accounts associated with the insight.
24
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
24
+ # @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
25
25
  # @param insight_guid [String] The unique identifier for the insight. Defined by MX.
26
26
  # @param [Hash] opts the optional parameters
27
- # @option opts [Integer] :page Specify current page.
28
- # @option opts [Integer] :records_per_page Specify records per page.
27
+ # @option opts [Integer] :page Results are paginated. Specify current page.
28
+ # @option opts [Integer] :records_per_page 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.
29
29
  # @return [AccountsResponseBody]
30
30
  def list_accounts_insight(user_guid, insight_guid, opts = {})
31
31
  data, _status_code, _headers = list_accounts_insight_with_http_info(user_guid, insight_guid, opts)
32
32
  data
33
33
  end
34
34
 
35
- # List all accounts associated with an insight.
35
+ # List all accounts associated with an insight
36
36
  # Use this endpoint to list all the accounts associated with the insight.
37
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
37
+ # @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
38
38
  # @param insight_guid [String] The unique identifier for the insight. Defined by MX.
39
39
  # @param [Hash] opts the optional parameters
40
- # @option opts [Integer] :page Specify current page.
41
- # @option opts [Integer] :records_per_page Specify records per page.
40
+ # @option opts [Integer] :page Results are paginated. Specify current page.
41
+ # @option opts [Integer] :records_per_page 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.
42
42
  # @return [Array<(AccountsResponseBody, Integer, Hash)>] AccountsResponseBody data, response status code and response headers
43
43
  def list_accounts_insight_with_http_info(user_guid, insight_guid, opts = {})
44
44
  if @api_client.config.debugging
@@ -94,26 +94,26 @@ module MxPlatformRuby
94
94
  return data, status_code, headers
95
95
  end
96
96
 
97
- # List all categories associated with an insight.
97
+ # List all categories associated with an insight
98
98
  # Use this endpoint to list all the categories associated with the insight.
99
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
99
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
100
100
  # @param insight_guid [String] The unique identifier for the insight. Defined by MX.
101
101
  # @param [Hash] opts the optional parameters
102
- # @option opts [Integer] :page Specify current page.
103
- # @option opts [Integer] :records_per_page Specify records per page.
102
+ # @option opts [Integer] :page Results are paginated. Specify current page.
103
+ # @option opts [Integer] :records_per_page 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.
104
104
  # @return [CategoriesResponseBody]
105
105
  def list_categories_insight(user_guid, insight_guid, opts = {})
106
106
  data, _status_code, _headers = list_categories_insight_with_http_info(user_guid, insight_guid, opts)
107
107
  data
108
108
  end
109
109
 
110
- # List all categories associated with an insight.
110
+ # List all categories associated with an insight
111
111
  # Use this endpoint to list all the categories associated with the insight.
112
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
112
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
113
113
  # @param insight_guid [String] The unique identifier for the insight. Defined by MX.
114
114
  # @param [Hash] opts the optional parameters
115
- # @option opts [Integer] :page Specify current page.
116
- # @option opts [Integer] :records_per_page Specify records per page.
115
+ # @option opts [Integer] :page Results are paginated. Specify current page.
116
+ # @option opts [Integer] :records_per_page 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.
117
117
  # @return [Array<(CategoriesResponseBody, Integer, Hash)>] CategoriesResponseBody data, response status code and response headers
118
118
  def list_categories_insight_with_http_info(user_guid, insight_guid, opts = {})
119
119
  if @api_client.config.debugging
@@ -170,12 +170,12 @@ module MxPlatformRuby
170
170
  end
171
171
 
172
172
  # List insights by account
173
- # Use this endpoint to list all insights associated with a specified account GUID.
174
- # @param account_guid [String] The unique id for the &#x60;account&#x60;.
175
- # @param user_guid [String] The unique id for the &#x60;user&#x60;.
173
+ # Use this endpoint to list all insights associated with an account GUID.
174
+ # @param account_guid [String] The unique id for an &#x60;account&#x60;.
175
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
176
176
  # @param [Hash] opts the optional parameters
177
- # @option opts [Integer] :page Specify current page.
178
- # @option opts [Integer] :records_per_page Specify records per page.
177
+ # @option opts [Integer] :page Results are paginated. Specify current page.
178
+ # @option opts [Integer] :records_per_page 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.
179
179
  # @return [InsightsResponseBody]
180
180
  def list_insights_by_account(account_guid, user_guid, opts = {})
181
181
  data, _status_code, _headers = list_insights_by_account_with_http_info(account_guid, user_guid, opts)
@@ -183,12 +183,12 @@ module MxPlatformRuby
183
183
  end
184
184
 
185
185
  # List insights by account
186
- # Use this endpoint to list all insights associated with a specified account GUID.
187
- # @param account_guid [String] The unique id for the &#x60;account&#x60;.
188
- # @param user_guid [String] The unique id for the &#x60;user&#x60;.
186
+ # Use this endpoint to list all insights associated with an account GUID.
187
+ # @param account_guid [String] The unique id for an &#x60;account&#x60;.
188
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
189
189
  # @param [Hash] opts the optional parameters
190
- # @option opts [Integer] :page Specify current page.
191
- # @option opts [Integer] :records_per_page Specify records per page.
190
+ # @option opts [Integer] :page Results are paginated. Specify current page.
191
+ # @option opts [Integer] :records_per_page 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.
192
192
  # @return [Array<(InsightsResponseBody, Integer, Hash)>] InsightsResponseBody data, response status code and response headers
193
193
  def list_insights_by_account_with_http_info(account_guid, user_guid, opts = {})
194
194
  if @api_client.config.debugging
@@ -244,24 +244,99 @@ module MxPlatformRuby
244
244
  return data, status_code, headers
245
245
  end
246
246
 
247
- # List all insights for a user.
247
+ # List insights by transaction
248
+ # Use this endpoint to list all insights associated with a transaction GUID.
249
+ # @param transaction_guid [String] The unique id for a &#x60;transaction&#x60;.
250
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
251
+ # @param [Hash] opts the optional parameters
252
+ # @option opts [Integer] :page Results are paginated. Specify current page.
253
+ # @option opts [Integer] :records_per_page 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.
254
+ # @return [InsightsResponseBody]
255
+ def list_insights_by_transaction(transaction_guid, user_guid, opts = {})
256
+ data, _status_code, _headers = list_insights_by_transaction_with_http_info(transaction_guid, user_guid, opts)
257
+ data
258
+ end
259
+
260
+ # List insights by transaction
261
+ # Use this endpoint to list all insights associated with a transaction GUID.
262
+ # @param transaction_guid [String] The unique id for a &#x60;transaction&#x60;.
263
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
264
+ # @param [Hash] opts the optional parameters
265
+ # @option opts [Integer] :page Results are paginated. Specify current page.
266
+ # @option opts [Integer] :records_per_page 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.
267
+ # @return [Array<(InsightsResponseBody, Integer, Hash)>] InsightsResponseBody data, response status code and response headers
268
+ def list_insights_by_transaction_with_http_info(transaction_guid, user_guid, opts = {})
269
+ if @api_client.config.debugging
270
+ @api_client.config.logger.debug 'Calling API: InsightsApi.list_insights_by_transaction ...'
271
+ end
272
+ # verify the required parameter 'transaction_guid' is set
273
+ if @api_client.config.client_side_validation && transaction_guid.nil?
274
+ fail ArgumentError, "Missing the required parameter 'transaction_guid' when calling InsightsApi.list_insights_by_transaction"
275
+ end
276
+ # verify the required parameter 'user_guid' is set
277
+ if @api_client.config.client_side_validation && user_guid.nil?
278
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling InsightsApi.list_insights_by_transaction"
279
+ end
280
+ # resource path
281
+ local_var_path = '/users/{user_guid}/transactions/{transaction_guid}/insights'.sub('{' + 'transaction_guid' + '}', CGI.escape(transaction_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
282
+
283
+ # query parameters
284
+ query_params = opts[:query_params] || {}
285
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
286
+ query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
287
+
288
+ # header parameters
289
+ header_params = opts[:header_params] || {}
290
+ # HTTP header 'Accept' (if needed)
291
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
292
+
293
+ # form parameters
294
+ form_params = opts[:form_params] || {}
295
+
296
+ # http body (model)
297
+ post_body = opts[:debug_body]
298
+
299
+ # return_type
300
+ return_type = opts[:debug_return_type] || 'InsightsResponseBody'
301
+
302
+ # auth_names
303
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
304
+
305
+ new_options = opts.merge(
306
+ :operation => :"InsightsApi.list_insights_by_transaction",
307
+ :header_params => header_params,
308
+ :query_params => query_params,
309
+ :form_params => form_params,
310
+ :body => post_body,
311
+ :auth_names => auth_names,
312
+ :return_type => return_type
313
+ )
314
+
315
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
316
+ if @api_client.config.debugging
317
+ @api_client.config.logger.debug "API called: InsightsApi#list_insights_by_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
318
+ end
319
+ return data, status_code, headers
320
+ end
321
+
322
+ # List all insights for a user
248
323
  # Use this endpoint to list all the insights associated with the user.
249
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
324
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
250
325
  # @param [Hash] opts the optional parameters
251
- # @option opts [Integer] :page Specify current page.
252
- # @option opts [Integer] :records_per_page Specify records per page.
326
+ # @option opts [Integer] :page Results are paginated. Specify current page.
327
+ # @option opts [Integer] :records_per_page 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.
253
328
  # @return [InsightsResponseBody]
254
329
  def list_insights_user(user_guid, opts = {})
255
330
  data, _status_code, _headers = list_insights_user_with_http_info(user_guid, opts)
256
331
  data
257
332
  end
258
333
 
259
- # List all insights for a user.
334
+ # List all insights for a user
260
335
  # Use this endpoint to list all the insights associated with the user.
261
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
336
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
262
337
  # @param [Hash] opts the optional parameters
263
- # @option opts [Integer] :page Specify current page.
264
- # @option opts [Integer] :records_per_page Specify records per page.
338
+ # @option opts [Integer] :page Results are paginated. Specify current page.
339
+ # @option opts [Integer] :records_per_page 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.
265
340
  # @return [Array<(InsightsResponseBody, Integer, Hash)>] InsightsResponseBody data, response status code and response headers
266
341
  def list_insights_user_with_http_info(user_guid, opts = {})
267
342
  if @api_client.config.debugging
@@ -313,26 +388,26 @@ module MxPlatformRuby
313
388
  return data, status_code, headers
314
389
  end
315
390
 
316
- # List all merchants associated with an insight.
391
+ # List all merchants associated with an insight
317
392
  # Use this endpoint to list all the merchants associated with the insight.
318
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
393
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
319
394
  # @param insight_guid [String] The unique identifier for the insight. Defined by MX.
320
395
  # @param [Hash] opts the optional parameters
321
- # @option opts [Integer] :page Specify current page.
322
- # @option opts [Integer] :records_per_page Specify records per page.
396
+ # @option opts [Integer] :page Results are paginated. Specify current page.
397
+ # @option opts [Integer] :records_per_page 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.
323
398
  # @return [MerchantsResponseBody]
324
399
  def list_merchants_insight(user_guid, insight_guid, opts = {})
325
400
  data, _status_code, _headers = list_merchants_insight_with_http_info(user_guid, insight_guid, opts)
326
401
  data
327
402
  end
328
403
 
329
- # List all merchants associated with an insight.
404
+ # List all merchants associated with an insight
330
405
  # Use this endpoint to list all the merchants associated with the insight.
331
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
406
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
332
407
  # @param insight_guid [String] The unique identifier for the insight. Defined by MX.
333
408
  # @param [Hash] opts the optional parameters
334
- # @option opts [Integer] :page Specify current page.
335
- # @option opts [Integer] :records_per_page Specify records per page.
409
+ # @option opts [Integer] :page Results are paginated. Specify current page.
410
+ # @option opts [Integer] :records_per_page 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.
336
411
  # @return [Array<(MerchantsResponseBody, Integer, Hash)>] MerchantsResponseBody data, response status code and response headers
337
412
  def list_merchants_insight_with_http_info(user_guid, insight_guid, opts = {})
338
413
  if @api_client.config.debugging
@@ -390,11 +465,11 @@ module MxPlatformRuby
390
465
 
391
466
  # List all scheduled payments associated with an insight
392
467
  # Use this endpoint to list all the scheduled payments associated with the insight.
393
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
468
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
394
469
  # @param insight_guid [String] The unique identifier for the insight. Defined by MX.
395
470
  # @param [Hash] opts the optional parameters
396
- # @option opts [Integer] :page Specify current page.
397
- # @option opts [Integer] :records_per_page Specify records per page.
471
+ # @option opts [Integer] :page Results are paginated. Specify current page.
472
+ # @option opts [Integer] :records_per_page 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.
398
473
  # @return [ScheduledPaymentsResponseBody]
399
474
  def list_scheduled_payments_insight(user_guid, insight_guid, opts = {})
400
475
  data, _status_code, _headers = list_scheduled_payments_insight_with_http_info(user_guid, insight_guid, opts)
@@ -403,11 +478,11 @@ module MxPlatformRuby
403
478
 
404
479
  # List all scheduled payments associated with an insight
405
480
  # Use this endpoint to list all the scheduled payments associated with the insight.
406
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
481
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
407
482
  # @param insight_guid [String] The unique identifier for the insight. Defined by MX.
408
483
  # @param [Hash] opts the optional parameters
409
- # @option opts [Integer] :page Specify current page.
410
- # @option opts [Integer] :records_per_page Specify records per page.
484
+ # @option opts [Integer] :page Results are paginated. Specify current page.
485
+ # @option opts [Integer] :records_per_page 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.
411
486
  # @return [Array<(ScheduledPaymentsResponseBody, Integer, Hash)>] ScheduledPaymentsResponseBody data, response status code and response headers
412
487
  def list_scheduled_payments_insight_with_http_info(user_guid, insight_guid, opts = {})
413
488
  if @api_client.config.debugging
@@ -463,26 +538,26 @@ module MxPlatformRuby
463
538
  return data, status_code, headers
464
539
  end
465
540
 
466
- # List all transactions associated with an insight.
541
+ # List all transactions associated with an insight
467
542
  # Use this endpoint to list all the transactions associated with the insight.
468
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
543
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
469
544
  # @param insight_guid [String] The unique identifier for the insight. Defined by MX.
470
545
  # @param [Hash] opts the optional parameters
471
- # @option opts [Integer] :page Specify current page.
472
- # @option opts [Integer] :records_per_page Specify records per page.
546
+ # @option opts [Integer] :page Results are paginated. Specify current page.
547
+ # @option opts [Integer] :records_per_page 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.
473
548
  # @return [TransactionsResponseBody]
474
549
  def list_transactions_insight(user_guid, insight_guid, opts = {})
475
550
  data, _status_code, _headers = list_transactions_insight_with_http_info(user_guid, insight_guid, opts)
476
551
  data
477
552
  end
478
553
 
479
- # List all transactions associated with an insight.
554
+ # List all transactions associated with an insight
480
555
  # Use this endpoint to list all the transactions associated with the insight.
481
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
556
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
482
557
  # @param insight_guid [String] The unique identifier for the insight. Defined by MX.
483
558
  # @param [Hash] opts the optional parameters
484
- # @option opts [Integer] :page Specify current page.
485
- # @option opts [Integer] :records_per_page Specify records per page.
559
+ # @option opts [Integer] :page Results are paginated. Specify current page.
560
+ # @option opts [Integer] :records_per_page 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.
486
561
  # @return [Array<(TransactionsResponseBody, Integer, Hash)>] TransactionsResponseBody data, response status code and response headers
487
562
  def list_transactions_insight_with_http_info(user_guid, insight_guid, opts = {})
488
563
  if @api_client.config.debugging
@@ -538,37 +613,37 @@ module MxPlatformRuby
538
613
  return data, status_code, headers
539
614
  end
540
615
 
541
- # Read a specific insight.
542
- # Use this endpoint to read the attributes of a specific insight according to its unique GUID.
543
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
616
+ # Read insight
617
+ # Use this endpoint to read the attributes of an insight according to its unique GUID.
618
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
544
619
  # @param insight_guid [String] The unique identifier for the insight. Defined by MX.
545
620
  # @param [Hash] opts the optional parameters
546
621
  # @return [InsightResponseBody]
547
- def read_insights_user(user_guid, insight_guid, opts = {})
548
- data, _status_code, _headers = read_insights_user_with_http_info(user_guid, insight_guid, opts)
622
+ def read_insight_user(user_guid, insight_guid, opts = {})
623
+ data, _status_code, _headers = read_insight_user_with_http_info(user_guid, insight_guid, opts)
549
624
  data
550
625
  end
551
626
 
552
- # Read a specific insight.
553
- # Use this endpoint to read the attributes of a specific insight according to its unique GUID.
554
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
627
+ # Read insight
628
+ # Use this endpoint to read the attributes of an insight according to its unique GUID.
629
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
555
630
  # @param insight_guid [String] The unique identifier for the insight. Defined by MX.
556
631
  # @param [Hash] opts the optional parameters
557
632
  # @return [Array<(InsightResponseBody, Integer, Hash)>] InsightResponseBody data, response status code and response headers
558
- def read_insights_user_with_http_info(user_guid, insight_guid, opts = {})
633
+ def read_insight_user_with_http_info(user_guid, insight_guid, opts = {})
559
634
  if @api_client.config.debugging
560
- @api_client.config.logger.debug 'Calling API: InsightsApi.read_insights_user ...'
635
+ @api_client.config.logger.debug 'Calling API: InsightsApi.read_insight_user ...'
561
636
  end
562
637
  # verify the required parameter 'user_guid' is set
563
638
  if @api_client.config.client_side_validation && user_guid.nil?
564
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling InsightsApi.read_insights_user"
639
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling InsightsApi.read_insight_user"
565
640
  end
566
641
  # verify the required parameter 'insight_guid' is set
567
642
  if @api_client.config.client_side_validation && insight_guid.nil?
568
- fail ArgumentError, "Missing the required parameter 'insight_guid' when calling InsightsApi.read_insights_user"
643
+ fail ArgumentError, "Missing the required parameter 'insight_guid' when calling InsightsApi.read_insight_user"
569
644
  end
570
645
  # resource path
571
- local_var_path = '/users/{user_guid}/insights{insight_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'insight_guid' + '}', CGI.escape(insight_guid.to_s))
646
+ local_var_path = '/users/{user_guid}/insights/{insight_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'insight_guid' + '}', CGI.escape(insight_guid.to_s))
572
647
 
573
648
  # query parameters
574
649
  query_params = opts[:query_params] || {}
@@ -591,7 +666,7 @@ module MxPlatformRuby
591
666
  auth_names = opts[:debug_auth_names] || ['basicAuth']
592
667
 
593
668
  new_options = opts.merge(
594
- :operation => :"InsightsApi.read_insights_user",
669
+ :operation => :"InsightsApi.read_insight_user",
595
670
  :header_params => header_params,
596
671
  :query_params => query_params,
597
672
  :form_params => form_params,
@@ -602,31 +677,31 @@ module MxPlatformRuby
602
677
 
603
678
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
604
679
  if @api_client.config.debugging
605
- @api_client.config.logger.debug "API called: InsightsApi#read_insights_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
680
+ @api_client.config.logger.debug "API called: InsightsApi#read_insight_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
606
681
  end
607
682
  return data, status_code, headers
608
683
  end
609
684
 
610
685
  # Update insight
611
- # Use this endpoint to update the attributes of a particular insight according to its unique GUID.
612
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
686
+ # Use this endpoint to update the attributes of an insight according to its unique GUID.
687
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
613
688
  # @param insight_guid [String] The unique identifier for the insight. Defined by MX.
614
- # @param insight_update_request [InsightUpdateRequest] The insight to be updated (None of these parameters are required, but the user object cannot be empty.)
689
+ # @param insight_update_request_body [InsightUpdateRequestBody] The insight to be updated (None of these parameters are required, but the user object cannot be empty.)
615
690
  # @param [Hash] opts the optional parameters
616
691
  # @return [InsightResponse]
617
- def update_insight(user_guid, insight_guid, insight_update_request, opts = {})
618
- data, _status_code, _headers = update_insight_with_http_info(user_guid, insight_guid, insight_update_request, opts)
692
+ def update_insight(user_guid, insight_guid, insight_update_request_body, opts = {})
693
+ data, _status_code, _headers = update_insight_with_http_info(user_guid, insight_guid, insight_update_request_body, opts)
619
694
  data
620
695
  end
621
696
 
622
697
  # Update insight
623
- # Use this endpoint to update the attributes of a particular insight according to its unique GUID.
624
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
698
+ # Use this endpoint to update the attributes of an insight according to its unique GUID.
699
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
625
700
  # @param insight_guid [String] The unique identifier for the insight. Defined by MX.
626
- # @param insight_update_request [InsightUpdateRequest] The insight to be updated (None of these parameters are required, but the user object cannot be empty.)
701
+ # @param insight_update_request_body [InsightUpdateRequestBody] The insight to be updated (None of these parameters are required, but the user object cannot be empty.)
627
702
  # @param [Hash] opts the optional parameters
628
703
  # @return [Array<(InsightResponse, Integer, Hash)>] InsightResponse data, response status code and response headers
629
- def update_insight_with_http_info(user_guid, insight_guid, insight_update_request, opts = {})
704
+ def update_insight_with_http_info(user_guid, insight_guid, insight_update_request_body, opts = {})
630
705
  if @api_client.config.debugging
631
706
  @api_client.config.logger.debug 'Calling API: InsightsApi.update_insight ...'
632
707
  end
@@ -638,12 +713,12 @@ module MxPlatformRuby
638
713
  if @api_client.config.client_side_validation && insight_guid.nil?
639
714
  fail ArgumentError, "Missing the required parameter 'insight_guid' when calling InsightsApi.update_insight"
640
715
  end
641
- # verify the required parameter 'insight_update_request' is set
642
- if @api_client.config.client_side_validation && insight_update_request.nil?
643
- fail ArgumentError, "Missing the required parameter 'insight_update_request' when calling InsightsApi.update_insight"
716
+ # verify the required parameter 'insight_update_request_body' is set
717
+ if @api_client.config.client_side_validation && insight_update_request_body.nil?
718
+ fail ArgumentError, "Missing the required parameter 'insight_update_request_body' when calling InsightsApi.update_insight"
644
719
  end
645
720
  # resource path
646
- local_var_path = '/users/{user_guid}/insights{insight_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'insight_guid' + '}', CGI.escape(insight_guid.to_s))
721
+ local_var_path = '/users/{user_guid}/insights/{insight_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'insight_guid' + '}', CGI.escape(insight_guid.to_s))
647
722
 
648
723
  # query parameters
649
724
  query_params = opts[:query_params] || {}
@@ -662,7 +737,7 @@ module MxPlatformRuby
662
737
  form_params = opts[:form_params] || {}
663
738
 
664
739
  # http body (model)
665
- post_body = opts[:debug_body] || @api_client.object_to_http_body(insight_update_request)
740
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(insight_update_request_body)
666
741
 
667
742
  # return_type
668
743
  return_type = opts[:debug_return_type] || 'InsightResponse'