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,15 +1,30 @@
1
1
  # MxPlatformRuby::TransactionsApi
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
- | [**users_user_guid_accounts_account_guid_transactions_post**](TransactionsApi.md#users_user_guid_accounts_account_guid_transactions_post) | **POST** /users/{user_guid}/accounts/{account_guid}/transactions | Create manual transaction |
7
+ | [**create_manual_transaction**](TransactionsApi.md#create_manual_transaction) | **POST** /users/{user_guid}/accounts/{account_guid}/transactions | Create manual transaction |
8
+ | [**create_split_transactions**](TransactionsApi.md#create_split_transactions) | **POST** /users/{user_guid}/transactions/{transaction_guid}/split | Create split transactions |
9
+ | [**delete_manual_transactions**](TransactionsApi.md#delete_manual_transactions) | **DELETE** /users/{user_guid}/transactions/{transaction_guid} | Delete manual transactions |
10
+ | [**delete_split_transactions**](TransactionsApi.md#delete_split_transactions) | **DELETE** /users/{user_guid}/transactions/{transaction_guid}/split | Delete split transactions |
11
+ | [**delete_transaction_rule**](TransactionsApi.md#delete_transaction_rule) | **DELETE** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Delete transaction rule |
12
+ | [**enhance_transactions**](TransactionsApi.md#enhance_transactions) | **POST** /transactions/enhance | Enhance transactions |
13
+ | [**extend_history**](TransactionsApi.md#extend_history) | **POST** /users/{user_guid}/members/{member_guid}/extend_history | Extend history |
14
+ | [**list_transactions**](TransactionsApi.md#list_transactions) | **GET** /users/{user_guid}/transactions | List transactions |
15
+ | [**list_transactions_by_account**](TransactionsApi.md#list_transactions_by_account) | **GET** /users/{user_guid}/accounts/{account_guid}/transactions | List transactions by account |
16
+ | [**list_transactions_by_member**](TransactionsApi.md#list_transactions_by_member) | **GET** /users/{user_guid}/members/{member_guid}/transactions | List transactions by member |
17
+ | [**list_transactions_by_tag**](TransactionsApi.md#list_transactions_by_tag) | **GET** /users/{user_guid}/tags/{tag_guid}/transactions | List transactions by tag |
18
+ | [**read_transaction**](TransactionsApi.md#read_transaction) | **GET** /users/{user_guid}/transactions/{transaction_guid} | Read transaction |
19
+ | [**repeating_transactions**](TransactionsApi.md#repeating_transactions) | **GET** /users/{user_guid}/repeating_transactions | List Repeating Transactions |
20
+ | [**specific_repeating_transaction**](TransactionsApi.md#specific_repeating_transaction) | **GET** /users/{user_guid}/repeating_transactions/{repeating_transaction_guid} | Get a Repeating Transaction |
21
+ | [**update_transaction**](TransactionsApi.md#update_transaction) | **PUT** /users/{user_guid}/transactions/{transaction_guid} | Update transaction |
22
+ | [**update_transaction_by_account**](TransactionsApi.md#update_transaction_by_account) | **PUT** /users/{user_guid}/members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid} | Update Transaction by Account |
8
23
 
9
24
 
10
- ## users_user_guid_accounts_account_guid_transactions_post
25
+ ## create_manual_transaction
11
26
 
12
- > <TransactionCreateResponseBody> users_user_guid_accounts_account_guid_transactions_post(user_guid, account_guid, transaction_create_request_body)
27
+ > <TransactionCreateResponseBody> create_manual_transaction(user_guid, account_guid, transaction_create_request_body)
13
28
 
14
29
  Create manual transaction
15
30
 
@@ -28,34 +43,34 @@ MxPlatformRuby.configure do |config|
28
43
  end
29
44
 
30
45
  api_instance = MxPlatformRuby::TransactionsApi.new
31
- user_guid = 'user_guid_example' # String | The unique identifier for the user.
32
- account_guid = 'account_guid_example' # String | The unique identifier for the account.
46
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
47
+ account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
33
48
  transaction_create_request_body = MxPlatformRuby::TransactionCreateRequestBody.new # TransactionCreateRequestBody |
34
49
 
35
50
  begin
36
51
  # Create manual transaction
37
- result = api_instance.users_user_guid_accounts_account_guid_transactions_post(user_guid, account_guid, transaction_create_request_body)
52
+ result = api_instance.create_manual_transaction(user_guid, account_guid, transaction_create_request_body)
38
53
  p result
39
54
  rescue MxPlatformRuby::ApiError => e
40
- puts "Error when calling TransactionsApi->users_user_guid_accounts_account_guid_transactions_post: #{e}"
55
+ puts "Error when calling TransactionsApi->create_manual_transaction: #{e}"
41
56
  end
42
57
  ```
43
58
 
44
- #### Using the users_user_guid_accounts_account_guid_transactions_post_with_http_info variant
59
+ #### Using the create_manual_transaction_with_http_info variant
45
60
 
46
61
  This returns an Array which contains the response data, status code and headers.
47
62
 
48
- > <Array(<TransactionCreateResponseBody>, Integer, Hash)> users_user_guid_accounts_account_guid_transactions_post_with_http_info(user_guid, account_guid, transaction_create_request_body)
63
+ > <Array(<TransactionCreateResponseBody>, Integer, Hash)> create_manual_transaction_with_http_info(user_guid, account_guid, transaction_create_request_body)
49
64
 
50
65
  ```ruby
51
66
  begin
52
67
  # Create manual transaction
53
- data, status_code, headers = api_instance.users_user_guid_accounts_account_guid_transactions_post_with_http_info(user_guid, account_guid, transaction_create_request_body)
68
+ data, status_code, headers = api_instance.create_manual_transaction_with_http_info(user_guid, account_guid, transaction_create_request_body)
54
69
  p status_code # => 2xx
55
70
  p headers # => { ... }
56
71
  p data # => <TransactionCreateResponseBody>
57
72
  rescue MxPlatformRuby::ApiError => e
58
- puts "Error when calling TransactionsApi->users_user_guid_accounts_account_guid_transactions_post_with_http_info: #{e}"
73
+ puts "Error when calling TransactionsApi->create_manual_transaction_with_http_info: #{e}"
59
74
  end
60
75
  ```
61
76
 
@@ -63,8 +78,8 @@ end
63
78
 
64
79
  | Name | Type | Description | Notes |
65
80
  | ---- | ---- | ----------- | ----- |
66
- | **user_guid** | **String** | The unique identifier for the user. | |
67
- | **account_guid** | **String** | The unique identifier for the account. | |
81
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
82
+ | **account_guid** | **String** | The unique id for an &#x60;account&#x60;. | |
68
83
  | **transaction_create_request_body** | [**TransactionCreateRequestBody**](TransactionCreateRequestBody.md) | | |
69
84
 
70
85
  ### Return type
@@ -80,3 +95,1206 @@ end
80
95
  - **Content-Type**: application/json
81
96
  - **Accept**: application/vnd.mx.api.v1+json
82
97
 
98
+
99
+ ## create_split_transactions
100
+
101
+ > <SplitTransactionsResponseBody> create_split_transactions(transaction_guid, user_guid, opts)
102
+
103
+ Create split transactions
104
+
105
+ This endpoint creates two or more child transactions that are branched from a previous transaction. This endpoint allows you to link multiple categories, descriptions, and amounts to a parent transaction. When a split transaction is created, the parent transaction's `has_been_split` field will automatically be updated to true and the child transactions' `parent_guid` will have the transaction guid of the parent. The total amount of the child transactions must equal the amount of the parent transaction. Once a transaction has been split it can't be split again. In order to re-split a transaction, it must first be un-split. This can be done by calling the Delete Split Transactions endpoint. Calling this endpoint will delete the existing child transactions and update the parent transaction's `has_been_split` field to false. You can then re-split the parent transaction by calling Create Split Transaction again.
106
+
107
+ ### Examples
108
+
109
+ ```ruby
110
+ require 'time'
111
+ require 'mx-platform-ruby'
112
+ # setup authorization
113
+ MxPlatformRuby.configure do |config|
114
+ # Configure HTTP basic authorization: basicAuth
115
+ config.username = 'YOUR USERNAME'
116
+ config.password = 'YOUR PASSWORD'
117
+ end
118
+
119
+ api_instance = MxPlatformRuby::TransactionsApi.new
120
+ transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
121
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
122
+ opts = {
123
+ split_transaction_request_body: MxPlatformRuby::SplitTransactionRequestBody.new({transactions: MxPlatformRuby::SplitTransactionRequest.new({amount: 54.19})}) # SplitTransactionRequestBody |
124
+ }
125
+
126
+ begin
127
+ # Create split transactions
128
+ result = api_instance.create_split_transactions(transaction_guid, user_guid, opts)
129
+ p result
130
+ rescue MxPlatformRuby::ApiError => e
131
+ puts "Error when calling TransactionsApi->create_split_transactions: #{e}"
132
+ end
133
+ ```
134
+
135
+ #### Using the create_split_transactions_with_http_info variant
136
+
137
+ This returns an Array which contains the response data, status code and headers.
138
+
139
+ > <Array(<SplitTransactionsResponseBody>, Integer, Hash)> create_split_transactions_with_http_info(transaction_guid, user_guid, opts)
140
+
141
+ ```ruby
142
+ begin
143
+ # Create split transactions
144
+ data, status_code, headers = api_instance.create_split_transactions_with_http_info(transaction_guid, user_guid, opts)
145
+ p status_code # => 2xx
146
+ p headers # => { ... }
147
+ p data # => <SplitTransactionsResponseBody>
148
+ rescue MxPlatformRuby::ApiError => e
149
+ puts "Error when calling TransactionsApi->create_split_transactions_with_http_info: #{e}"
150
+ end
151
+ ```
152
+
153
+ ### Parameters
154
+
155
+ | Name | Type | Description | Notes |
156
+ | ---- | ---- | ----------- | ----- |
157
+ | **transaction_guid** | **String** | The unique id for a &#x60;transaction&#x60;. | |
158
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
159
+ | **split_transaction_request_body** | [**SplitTransactionRequestBody**](SplitTransactionRequestBody.md) | | [optional] |
160
+
161
+ ### Return type
162
+
163
+ [**SplitTransactionsResponseBody**](SplitTransactionsResponseBody.md)
164
+
165
+ ### Authorization
166
+
167
+ [basicAuth](../README.md#basicAuth)
168
+
169
+ ### HTTP request headers
170
+
171
+ - **Content-Type**: application/json
172
+ - **Accept**: application/vnd.mx.api.v1+json
173
+
174
+
175
+ ## delete_manual_transactions
176
+
177
+ > delete_manual_transactions(user_guid, transaction_guid)
178
+
179
+ Delete manual transactions
180
+
181
+ Delete a manual transaction. In the path, use the manual transaction guid as the `transaction_guid`, such as `MAN-810828b0-5210-4878-9bd3-f4ce514f90c4`.
182
+
183
+ ### Examples
184
+
185
+ ```ruby
186
+ require 'time'
187
+ require 'mx-platform-ruby'
188
+ # setup authorization
189
+ MxPlatformRuby.configure do |config|
190
+ # Configure HTTP basic authorization: basicAuth
191
+ config.username = 'YOUR USERNAME'
192
+ config.password = 'YOUR PASSWORD'
193
+ end
194
+
195
+ api_instance = MxPlatformRuby::TransactionsApi.new
196
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
197
+ transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
198
+
199
+ begin
200
+ # Delete manual transactions
201
+ api_instance.delete_manual_transactions(user_guid, transaction_guid)
202
+ rescue MxPlatformRuby::ApiError => e
203
+ puts "Error when calling TransactionsApi->delete_manual_transactions: #{e}"
204
+ end
205
+ ```
206
+
207
+ #### Using the delete_manual_transactions_with_http_info variant
208
+
209
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
210
+
211
+ > <Array(nil, Integer, Hash)> delete_manual_transactions_with_http_info(user_guid, transaction_guid)
212
+
213
+ ```ruby
214
+ begin
215
+ # Delete manual transactions
216
+ data, status_code, headers = api_instance.delete_manual_transactions_with_http_info(user_guid, transaction_guid)
217
+ p status_code # => 2xx
218
+ p headers # => { ... }
219
+ p data # => nil
220
+ rescue MxPlatformRuby::ApiError => e
221
+ puts "Error when calling TransactionsApi->delete_manual_transactions_with_http_info: #{e}"
222
+ end
223
+ ```
224
+
225
+ ### Parameters
226
+
227
+ | Name | Type | Description | Notes |
228
+ | ---- | ---- | ----------- | ----- |
229
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
230
+ | **transaction_guid** | **String** | The unique id for a &#x60;transaction&#x60;. | |
231
+
232
+ ### Return type
233
+
234
+ nil (empty response body)
235
+
236
+ ### Authorization
237
+
238
+ [basicAuth](../README.md#basicAuth)
239
+
240
+ ### HTTP request headers
241
+
242
+ - **Content-Type**: Not defined
243
+ - **Accept**: Not defined
244
+
245
+
246
+ ## delete_split_transactions
247
+
248
+ > delete_split_transactions(transaction_guid, user_guid)
249
+
250
+ Delete split transactions
251
+
252
+ This endpoint deletes all split transactions linked to a parent transaction, but it leaves the parent transaction active. This request will also update the parent transaction's has_been_split field to false. This endpoint accepts the optional MX-Skip-Webhook header.
253
+
254
+ ### Examples
255
+
256
+ ```ruby
257
+ require 'time'
258
+ require 'mx-platform-ruby'
259
+ # setup authorization
260
+ MxPlatformRuby.configure do |config|
261
+ # Configure HTTP basic authorization: basicAuth
262
+ config.username = 'YOUR USERNAME'
263
+ config.password = 'YOUR PASSWORD'
264
+ end
265
+
266
+ api_instance = MxPlatformRuby::TransactionsApi.new
267
+ transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
268
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
269
+
270
+ begin
271
+ # Delete split transactions
272
+ api_instance.delete_split_transactions(transaction_guid, user_guid)
273
+ rescue MxPlatformRuby::ApiError => e
274
+ puts "Error when calling TransactionsApi->delete_split_transactions: #{e}"
275
+ end
276
+ ```
277
+
278
+ #### Using the delete_split_transactions_with_http_info variant
279
+
280
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
281
+
282
+ > <Array(nil, Integer, Hash)> delete_split_transactions_with_http_info(transaction_guid, user_guid)
283
+
284
+ ```ruby
285
+ begin
286
+ # Delete split transactions
287
+ data, status_code, headers = api_instance.delete_split_transactions_with_http_info(transaction_guid, user_guid)
288
+ p status_code # => 2xx
289
+ p headers # => { ... }
290
+ p data # => nil
291
+ rescue MxPlatformRuby::ApiError => e
292
+ puts "Error when calling TransactionsApi->delete_split_transactions_with_http_info: #{e}"
293
+ end
294
+ ```
295
+
296
+ ### Parameters
297
+
298
+ | Name | Type | Description | Notes |
299
+ | ---- | ---- | ----------- | ----- |
300
+ | **transaction_guid** | **String** | The unique id for a &#x60;transaction&#x60;. | |
301
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
302
+
303
+ ### Return type
304
+
305
+ nil (empty response body)
306
+
307
+ ### Authorization
308
+
309
+ [basicAuth](../README.md#basicAuth)
310
+
311
+ ### HTTP request headers
312
+
313
+ - **Content-Type**: Not defined
314
+ - **Accept**: Not defined
315
+
316
+
317
+ ## delete_transaction_rule
318
+
319
+ > delete_transaction_rule(transaction_rule_guid, user_guid)
320
+
321
+ Delete transaction rule
322
+
323
+ Use this endpoint to permanently delete a transaction rule based on its unique GUID.
324
+
325
+ ### Examples
326
+
327
+ ```ruby
328
+ require 'time'
329
+ require 'mx-platform-ruby'
330
+ # setup authorization
331
+ MxPlatformRuby.configure do |config|
332
+ # Configure HTTP basic authorization: basicAuth
333
+ config.username = 'YOUR USERNAME'
334
+ config.password = 'YOUR PASSWORD'
335
+ end
336
+
337
+ api_instance = MxPlatformRuby::TransactionsApi.new
338
+ transaction_rule_guid = 'TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3' # String | The unique id for a `transaction_rule`.
339
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
340
+
341
+ begin
342
+ # Delete transaction rule
343
+ api_instance.delete_transaction_rule(transaction_rule_guid, user_guid)
344
+ rescue MxPlatformRuby::ApiError => e
345
+ puts "Error when calling TransactionsApi->delete_transaction_rule: #{e}"
346
+ end
347
+ ```
348
+
349
+ #### Using the delete_transaction_rule_with_http_info variant
350
+
351
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
352
+
353
+ > <Array(nil, Integer, Hash)> delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid)
354
+
355
+ ```ruby
356
+ begin
357
+ # Delete transaction rule
358
+ data, status_code, headers = api_instance.delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid)
359
+ p status_code # => 2xx
360
+ p headers # => { ... }
361
+ p data # => nil
362
+ rescue MxPlatformRuby::ApiError => e
363
+ puts "Error when calling TransactionsApi->delete_transaction_rule_with_http_info: #{e}"
364
+ end
365
+ ```
366
+
367
+ ### Parameters
368
+
369
+ | Name | Type | Description | Notes |
370
+ | ---- | ---- | ----------- | ----- |
371
+ | **transaction_rule_guid** | **String** | The unique id for a &#x60;transaction_rule&#x60;. | |
372
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
373
+
374
+ ### Return type
375
+
376
+ nil (empty response body)
377
+
378
+ ### Authorization
379
+
380
+ [basicAuth](../README.md#basicAuth)
381
+
382
+ ### HTTP request headers
383
+
384
+ - **Content-Type**: Not defined
385
+ - **Accept**: Not defined
386
+
387
+
388
+ ## enhance_transactions
389
+
390
+ > <EnhanceTransactionsResponseBody> enhance_transactions(enhance_transactions_request_body)
391
+
392
+ Enhance transactions
393
+
394
+ Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform. <br /><br />For more information on returned data, please see the [Enhanced Transactions fields guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions).
395
+
396
+ ### Examples
397
+
398
+ ```ruby
399
+ require 'time'
400
+ require 'mx-platform-ruby'
401
+ # setup authorization
402
+ MxPlatformRuby.configure do |config|
403
+ # Configure HTTP basic authorization: basicAuth
404
+ config.username = 'YOUR USERNAME'
405
+ config.password = 'YOUR PASSWORD'
406
+ end
407
+
408
+ api_instance = MxPlatformRuby::TransactionsApi.new
409
+ enhance_transactions_request_body = MxPlatformRuby::EnhanceTransactionsRequestBody.new # EnhanceTransactionsRequestBody | Transaction object to be enhanced
410
+
411
+ begin
412
+ # Enhance transactions
413
+ result = api_instance.enhance_transactions(enhance_transactions_request_body)
414
+ p result
415
+ rescue MxPlatformRuby::ApiError => e
416
+ puts "Error when calling TransactionsApi->enhance_transactions: #{e}"
417
+ end
418
+ ```
419
+
420
+ #### Using the enhance_transactions_with_http_info variant
421
+
422
+ This returns an Array which contains the response data, status code and headers.
423
+
424
+ > <Array(<EnhanceTransactionsResponseBody>, Integer, Hash)> enhance_transactions_with_http_info(enhance_transactions_request_body)
425
+
426
+ ```ruby
427
+ begin
428
+ # Enhance transactions
429
+ data, status_code, headers = api_instance.enhance_transactions_with_http_info(enhance_transactions_request_body)
430
+ p status_code # => 2xx
431
+ p headers # => { ... }
432
+ p data # => <EnhanceTransactionsResponseBody>
433
+ rescue MxPlatformRuby::ApiError => e
434
+ puts "Error when calling TransactionsApi->enhance_transactions_with_http_info: #{e}"
435
+ end
436
+ ```
437
+
438
+ ### Parameters
439
+
440
+ | Name | Type | Description | Notes |
441
+ | ---- | ---- | ----------- | ----- |
442
+ | **enhance_transactions_request_body** | [**EnhanceTransactionsRequestBody**](EnhanceTransactionsRequestBody.md) | Transaction object to be enhanced | |
443
+
444
+ ### Return type
445
+
446
+ [**EnhanceTransactionsResponseBody**](EnhanceTransactionsResponseBody.md)
447
+
448
+ ### Authorization
449
+
450
+ [basicAuth](../README.md#basicAuth)
451
+
452
+ ### HTTP request headers
453
+
454
+ - **Content-Type**: application/json
455
+ - **Accept**: application/vnd.mx.api.v1+json
456
+
457
+
458
+ ## extend_history
459
+
460
+ > <MemberResponseBody> extend_history(member_guid, user_guid)
461
+
462
+ Extend history
463
+
464
+ Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multi-factor authentication.
465
+
466
+ ### Examples
467
+
468
+ ```ruby
469
+ require 'time'
470
+ require 'mx-platform-ruby'
471
+ # setup authorization
472
+ MxPlatformRuby.configure do |config|
473
+ # Configure HTTP basic authorization: basicAuth
474
+ config.username = 'YOUR USERNAME'
475
+ config.password = 'YOUR PASSWORD'
476
+ end
477
+
478
+ api_instance = MxPlatformRuby::TransactionsApi.new
479
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
480
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
481
+
482
+ begin
483
+ # Extend history
484
+ result = api_instance.extend_history(member_guid, user_guid)
485
+ p result
486
+ rescue MxPlatformRuby::ApiError => e
487
+ puts "Error when calling TransactionsApi->extend_history: #{e}"
488
+ end
489
+ ```
490
+
491
+ #### Using the extend_history_with_http_info variant
492
+
493
+ This returns an Array which contains the response data, status code and headers.
494
+
495
+ > <Array(<MemberResponseBody>, Integer, Hash)> extend_history_with_http_info(member_guid, user_guid)
496
+
497
+ ```ruby
498
+ begin
499
+ # Extend history
500
+ data, status_code, headers = api_instance.extend_history_with_http_info(member_guid, user_guid)
501
+ p status_code # => 2xx
502
+ p headers # => { ... }
503
+ p data # => <MemberResponseBody>
504
+ rescue MxPlatformRuby::ApiError => e
505
+ puts "Error when calling TransactionsApi->extend_history_with_http_info: #{e}"
506
+ end
507
+ ```
508
+
509
+ ### Parameters
510
+
511
+ | Name | Type | Description | Notes |
512
+ | ---- | ---- | ----------- | ----- |
513
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
514
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
515
+
516
+ ### Return type
517
+
518
+ [**MemberResponseBody**](MemberResponseBody.md)
519
+
520
+ ### Authorization
521
+
522
+ [basicAuth](../README.md#basicAuth)
523
+
524
+ ### HTTP request headers
525
+
526
+ - **Content-Type**: Not defined
527
+ - **Accept**: application/vnd.mx.api.v1+json
528
+
529
+
530
+ ## list_transactions
531
+
532
+ > <TransactionsResponseBodyIncludes> list_transactions(user_guid, opts)
533
+
534
+ List transactions
535
+
536
+ Requests to this endpoint return a list of transactions associated with the specified `user`, across all members and accounts associated with that `user`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
537
+
538
+ ### Examples
539
+
540
+ ```ruby
541
+ require 'time'
542
+ require 'mx-platform-ruby'
543
+ # setup authorization
544
+ MxPlatformRuby.configure do |config|
545
+ # Configure HTTP basic authorization: basicAuth
546
+ config.username = 'YOUR USERNAME'
547
+ config.password = 'YOUR PASSWORD'
548
+ end
549
+
550
+ api_instance = MxPlatformRuby::TransactionsApi.new
551
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
552
+ opts = {
553
+ page: 1, # Integer | Results are paginated. Specify current page.
554
+ 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 `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
555
+ from_date: '2024-01-01', # String | Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
556
+ to_date: '2024-03-31', # String | Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.
557
+ from_created_at: '2024-01-01', # String | Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
558
+ to_created_at: '2024-03-31', # String | Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
559
+ from_updated_at: '2024-01-01', # String | Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
560
+ to_updated_at: '2024-03-31', # String | Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
561
+ category_guid: 'category_guid_example', # String | Filter transactions belonging to specified `category_guid`. For example, `?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
562
+ category_guid2: ['inner_example'], # Array<String> | Filter transactions belonging to any specified `category_guid[]` in url. For example, `?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
563
+ top_level_category_guid: 'top_level_category_guid_example', # String | Filter transactions belonging to specified `top_level_category_guid`. This must be top level category guid, use `category_guid` for subcategory guid. For example, `?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
564
+ top_level_category_guid2: ['inner_example'], # Array<String> | Filter transactions belonging to any specified `top_level_category_guid[]` in url. This must be top level category guid(s), use `category_guid` for subcategory guid(s). For example, `?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
565
+ use_case: 'MONEY_MOVEMENT', # String | The use case associated with the member. Valid values are `PFM` and `MONEY_MOVEMENT`. For example, you can append either `?use_case=PFM` or `?use_case=MONEY_MOVEMENT`.
566
+ includes: 'repeating_transactions,merchants,classifications,geolocations' # String | Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append: `?includes=repeating_transactions,merchants,classifications,geolocations`. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: `?includes=repeating_transactions,geolocations`. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata.
567
+ }
568
+
569
+ begin
570
+ # List transactions
571
+ result = api_instance.list_transactions(user_guid, opts)
572
+ p result
573
+ rescue MxPlatformRuby::ApiError => e
574
+ puts "Error when calling TransactionsApi->list_transactions: #{e}"
575
+ end
576
+ ```
577
+
578
+ #### Using the list_transactions_with_http_info variant
579
+
580
+ This returns an Array which contains the response data, status code and headers.
581
+
582
+ > <Array(<TransactionsResponseBodyIncludes>, Integer, Hash)> list_transactions_with_http_info(user_guid, opts)
583
+
584
+ ```ruby
585
+ begin
586
+ # List transactions
587
+ data, status_code, headers = api_instance.list_transactions_with_http_info(user_guid, opts)
588
+ p status_code # => 2xx
589
+ p headers # => { ... }
590
+ p data # => <TransactionsResponseBodyIncludes>
591
+ rescue MxPlatformRuby::ApiError => e
592
+ puts "Error when calling TransactionsApi->list_transactions_with_http_info: #{e}"
593
+ end
594
+ ```
595
+
596
+ ### Parameters
597
+
598
+ | Name | Type | Description | Notes |
599
+ | ---- | ---- | ----------- | ----- |
600
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
601
+ | **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
602
+ | **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;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead. | [optional] |
603
+ | **from_date** | **String** | Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided. | [optional] |
604
+ | **to_date** | **String** | Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions. | [optional] |
605
+ | **from_created_at** | **String** | Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months. | [optional] |
606
+ | **to_created_at** | **String** | Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months. | [optional] |
607
+ | **from_updated_at** | **String** | Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months. | [optional] |
608
+ | **to_updated_at** | **String** | Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months. | [optional] |
609
+ | **category_guid** | **String** | Filter transactions belonging to specified &#x60;category_guid&#x60;. For example, &#x60;?category_guid&#x3D;CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874&#x60;. | [optional] |
610
+ | **category_guid2** | [**Array&lt;String&gt;**](String.md) | Filter transactions belonging to any specified &#x60;category_guid[]&#x60; in url. For example, &#x60;?category_guid[]&#x3D;CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874&#x60;. | [optional] |
611
+ | **top_level_category_guid** | **String** | Filter transactions belonging to specified &#x60;top_level_category_guid&#x60;. This must be top level category guid, use &#x60;category_guid&#x60; for subcategory guid. For example, &#x60;?top_level_category_guid&#x3D;CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874&#x60;. | [optional] |
612
+ | **top_level_category_guid2** | [**Array&lt;String&gt;**](String.md) | Filter transactions belonging to any specified &#x60;top_level_category_guid[]&#x60; in url. This must be top level category guid(s), use &#x60;category_guid&#x60; for subcategory guid(s). For example, &#x60;?top_level_category_guid[]&#x3D;CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874&#x60;. | [optional] |
613
+ | **use_case** | **String** | The use case associated with the member. Valid values are &#x60;PFM&#x60; and &#x60;MONEY_MOVEMENT&#x60;. For example, you can append either &#x60;?use_case&#x3D;PFM&#x60; or &#x60;?use_case&#x3D;MONEY_MOVEMENT&#x60;. | [optional] |
614
+ | **includes** | **String** | Options for enhanced transactions. This query parameter is optional. Possible additional metadata: &#x60;repeating_transactions&#x60;, &#x60;merchants&#x60;, &#x60;classifications&#x60;, &#x60;geolocations&#x60;. The query value is format sensitive. To retrieve all available enhancements, append: &#x60;?includes&#x3D;repeating_transactions,merchants,classifications,geolocations&#x60;. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: &#x60;?includes&#x3D;repeating_transactions,geolocations&#x60;. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata. | [optional] |
615
+
616
+ ### Return type
617
+
618
+ [**TransactionsResponseBodyIncludes**](TransactionsResponseBodyIncludes.md)
619
+
620
+ ### Authorization
621
+
622
+ [basicAuth](../README.md#basicAuth)
623
+
624
+ ### HTTP request headers
625
+
626
+ - **Content-Type**: Not defined
627
+ - **Accept**: application/vnd.mx.api.v1+json
628
+
629
+
630
+ ## list_transactions_by_account
631
+
632
+ > <TransactionsResponseBodyIncludes> list_transactions_by_account(account_guid, user_guid, opts)
633
+
634
+ List transactions by account
635
+
636
+ Requests to this endpoint return a list of transactions associated with the specified account. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
637
+
638
+ ### Examples
639
+
640
+ ```ruby
641
+ require 'time'
642
+ require 'mx-platform-ruby'
643
+ # setup authorization
644
+ MxPlatformRuby.configure do |config|
645
+ # Configure HTTP basic authorization: basicAuth
646
+ config.username = 'YOUR USERNAME'
647
+ config.password = 'YOUR PASSWORD'
648
+ end
649
+
650
+ api_instance = MxPlatformRuby::TransactionsApi.new
651
+ account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
652
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
653
+ opts = {
654
+ page: 1, # Integer | Results are paginated. Specify current page.
655
+ 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 `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
656
+ from_date: '2024-01-01', # String | Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
657
+ to_date: '2024-03-31', # String | Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.
658
+ from_created_at: '2024-01-01', # String | Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
659
+ to_created_at: '2024-03-31', # String | Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
660
+ from_updated_at: '2024-01-01', # String | Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
661
+ to_updated_at: '2024-03-31', # String | Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
662
+ category_guid: 'category_guid_example', # String | Filter transactions belonging to specified `category_guid`. For example, `?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
663
+ category_guid2: ['inner_example'], # Array<String> | Filter transactions belonging to any specified `category_guid[]` in url. For example, `?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
664
+ top_level_category_guid: 'top_level_category_guid_example', # String | Filter transactions belonging to specified `top_level_category_guid`. This must be top level category guid, use `category_guid` for subcategory guid. For example, `?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
665
+ top_level_category_guid2: ['inner_example'], # Array<String> | Filter transactions belonging to any specified `top_level_category_guid[]` in url. This must be top level category guid(s), use `category_guid` for subcategory guid(s). For example, `?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
666
+ includes: 'repeating_transactions,merchants,classifications,geolocations' # String | Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append: `?includes=repeating_transactions,merchants,classifications,geolocations`. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: `?includes=repeating_transactions,geolocations`. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata.
667
+ }
668
+
669
+ begin
670
+ # List transactions by account
671
+ result = api_instance.list_transactions_by_account(account_guid, user_guid, opts)
672
+ p result
673
+ rescue MxPlatformRuby::ApiError => e
674
+ puts "Error when calling TransactionsApi->list_transactions_by_account: #{e}"
675
+ end
676
+ ```
677
+
678
+ #### Using the list_transactions_by_account_with_http_info variant
679
+
680
+ This returns an Array which contains the response data, status code and headers.
681
+
682
+ > <Array(<TransactionsResponseBodyIncludes>, Integer, Hash)> list_transactions_by_account_with_http_info(account_guid, user_guid, opts)
683
+
684
+ ```ruby
685
+ begin
686
+ # List transactions by account
687
+ data, status_code, headers = api_instance.list_transactions_by_account_with_http_info(account_guid, user_guid, opts)
688
+ p status_code # => 2xx
689
+ p headers # => { ... }
690
+ p data # => <TransactionsResponseBodyIncludes>
691
+ rescue MxPlatformRuby::ApiError => e
692
+ puts "Error when calling TransactionsApi->list_transactions_by_account_with_http_info: #{e}"
693
+ end
694
+ ```
695
+
696
+ ### Parameters
697
+
698
+ | Name | Type | Description | Notes |
699
+ | ---- | ---- | ----------- | ----- |
700
+ | **account_guid** | **String** | The unique id for an &#x60;account&#x60;. | |
701
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
702
+ | **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
703
+ | **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;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead. | [optional] |
704
+ | **from_date** | **String** | Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided. | [optional] |
705
+ | **to_date** | **String** | Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions. | [optional] |
706
+ | **from_created_at** | **String** | Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months. | [optional] |
707
+ | **to_created_at** | **String** | Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months. | [optional] |
708
+ | **from_updated_at** | **String** | Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months. | [optional] |
709
+ | **to_updated_at** | **String** | Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months. | [optional] |
710
+ | **category_guid** | **String** | Filter transactions belonging to specified &#x60;category_guid&#x60;. For example, &#x60;?category_guid&#x3D;CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874&#x60;. | [optional] |
711
+ | **category_guid2** | [**Array&lt;String&gt;**](String.md) | Filter transactions belonging to any specified &#x60;category_guid[]&#x60; in url. For example, &#x60;?category_guid[]&#x3D;CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874&#x60;. | [optional] |
712
+ | **top_level_category_guid** | **String** | Filter transactions belonging to specified &#x60;top_level_category_guid&#x60;. This must be top level category guid, use &#x60;category_guid&#x60; for subcategory guid. For example, &#x60;?top_level_category_guid&#x3D;CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874&#x60;. | [optional] |
713
+ | **top_level_category_guid2** | [**Array&lt;String&gt;**](String.md) | Filter transactions belonging to any specified &#x60;top_level_category_guid[]&#x60; in url. This must be top level category guid(s), use &#x60;category_guid&#x60; for subcategory guid(s). For example, &#x60;?top_level_category_guid[]&#x3D;CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874&#x60;. | [optional] |
714
+ | **includes** | **String** | Options for enhanced transactions. This query parameter is optional. Possible additional metadata: &#x60;repeating_transactions&#x60;, &#x60;merchants&#x60;, &#x60;classifications&#x60;, &#x60;geolocations&#x60;. The query value is format sensitive. To retrieve all available enhancements, append: &#x60;?includes&#x3D;repeating_transactions,merchants,classifications,geolocations&#x60;. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: &#x60;?includes&#x3D;repeating_transactions,geolocations&#x60;. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata. | [optional] |
715
+
716
+ ### Return type
717
+
718
+ [**TransactionsResponseBodyIncludes**](TransactionsResponseBodyIncludes.md)
719
+
720
+ ### Authorization
721
+
722
+ [basicAuth](../README.md#basicAuth)
723
+
724
+ ### HTTP request headers
725
+
726
+ - **Content-Type**: Not defined
727
+ - **Accept**: application/vnd.mx.api.v1+json
728
+
729
+
730
+ ## list_transactions_by_member
731
+
732
+ > <TransactionsResponseBodyIncludes> list_transactions_by_member(member_guid, user_guid, opts)
733
+
734
+ List transactions by member
735
+
736
+ Requests to this endpoint return a list of transactions associated with the specified `member`, across all accounts associated with that `member`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
737
+
738
+ ### Examples
739
+
740
+ ```ruby
741
+ require 'time'
742
+ require 'mx-platform-ruby'
743
+ # setup authorization
744
+ MxPlatformRuby.configure do |config|
745
+ # Configure HTTP basic authorization: basicAuth
746
+ config.username = 'YOUR USERNAME'
747
+ config.password = 'YOUR PASSWORD'
748
+ end
749
+
750
+ api_instance = MxPlatformRuby::TransactionsApi.new
751
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
752
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
753
+ opts = {
754
+ page: 1, # Integer | Results are paginated. Specify current page.
755
+ 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 `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
756
+ from_date: '2024-01-01', # String | Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
757
+ to_date: '2024-03-31', # String | Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.
758
+ from_created_at: '2024-01-01', # String | Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
759
+ to_created_at: '2024-03-31', # String | Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
760
+ from_updated_at: '2024-01-01', # String | Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
761
+ to_updated_at: '2024-03-31', # String | Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
762
+ category_guid: 'category_guid_example', # String | Filter transactions belonging to specified `category_guid`. For example, `?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
763
+ category_guid2: ['inner_example'], # Array<String> | Filter transactions belonging to any specified `category_guid[]` in url. For example, `?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
764
+ top_level_category_guid: 'top_level_category_guid_example', # String | Filter transactions belonging to specified `top_level_category_guid`. This must be top level category guid, use `category_guid` for subcategory guid. For example, `?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
765
+ top_level_category_guid2: ['inner_example'], # Array<String> | Filter transactions belonging to any specified `top_level_category_guid[]` in url. This must be top level category guid(s), use `category_guid` for subcategory guid(s). For example, `?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
766
+ includes: 'repeating_transactions,merchants,classifications,geolocations' # String | Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append: `?includes=repeating_transactions,merchants,classifications,geolocations`. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: `?includes=repeating_transactions,geolocations`. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata.
767
+ }
768
+
769
+ begin
770
+ # List transactions by member
771
+ result = api_instance.list_transactions_by_member(member_guid, user_guid, opts)
772
+ p result
773
+ rescue MxPlatformRuby::ApiError => e
774
+ puts "Error when calling TransactionsApi->list_transactions_by_member: #{e}"
775
+ end
776
+ ```
777
+
778
+ #### Using the list_transactions_by_member_with_http_info variant
779
+
780
+ This returns an Array which contains the response data, status code and headers.
781
+
782
+ > <Array(<TransactionsResponseBodyIncludes>, Integer, Hash)> list_transactions_by_member_with_http_info(member_guid, user_guid, opts)
783
+
784
+ ```ruby
785
+ begin
786
+ # List transactions by member
787
+ data, status_code, headers = api_instance.list_transactions_by_member_with_http_info(member_guid, user_guid, opts)
788
+ p status_code # => 2xx
789
+ p headers # => { ... }
790
+ p data # => <TransactionsResponseBodyIncludes>
791
+ rescue MxPlatformRuby::ApiError => e
792
+ puts "Error when calling TransactionsApi->list_transactions_by_member_with_http_info: #{e}"
793
+ end
794
+ ```
795
+
796
+ ### Parameters
797
+
798
+ | Name | Type | Description | Notes |
799
+ | ---- | ---- | ----------- | ----- |
800
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
801
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
802
+ | **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
803
+ | **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;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead. | [optional] |
804
+ | **from_date** | **String** | Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided. | [optional] |
805
+ | **to_date** | **String** | Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions. | [optional] |
806
+ | **from_created_at** | **String** | Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months. | [optional] |
807
+ | **to_created_at** | **String** | Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months. | [optional] |
808
+ | **from_updated_at** | **String** | Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months. | [optional] |
809
+ | **to_updated_at** | **String** | Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months. | [optional] |
810
+ | **category_guid** | **String** | Filter transactions belonging to specified &#x60;category_guid&#x60;. For example, &#x60;?category_guid&#x3D;CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874&#x60;. | [optional] |
811
+ | **category_guid2** | [**Array&lt;String&gt;**](String.md) | Filter transactions belonging to any specified &#x60;category_guid[]&#x60; in url. For example, &#x60;?category_guid[]&#x3D;CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874&#x60;. | [optional] |
812
+ | **top_level_category_guid** | **String** | Filter transactions belonging to specified &#x60;top_level_category_guid&#x60;. This must be top level category guid, use &#x60;category_guid&#x60; for subcategory guid. For example, &#x60;?top_level_category_guid&#x3D;CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874&#x60;. | [optional] |
813
+ | **top_level_category_guid2** | [**Array&lt;String&gt;**](String.md) | Filter transactions belonging to any specified &#x60;top_level_category_guid[]&#x60; in url. This must be top level category guid(s), use &#x60;category_guid&#x60; for subcategory guid(s). For example, &#x60;?top_level_category_guid[]&#x3D;CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874&#x60;. | [optional] |
814
+ | **includes** | **String** | Options for enhanced transactions. This query parameter is optional. Possible additional metadata: &#x60;repeating_transactions&#x60;, &#x60;merchants&#x60;, &#x60;classifications&#x60;, &#x60;geolocations&#x60;. The query value is format sensitive. To retrieve all available enhancements, append: &#x60;?includes&#x3D;repeating_transactions,merchants,classifications,geolocations&#x60;. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: &#x60;?includes&#x3D;repeating_transactions,geolocations&#x60;. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata. | [optional] |
815
+
816
+ ### Return type
817
+
818
+ [**TransactionsResponseBodyIncludes**](TransactionsResponseBodyIncludes.md)
819
+
820
+ ### Authorization
821
+
822
+ [basicAuth](../README.md#basicAuth)
823
+
824
+ ### HTTP request headers
825
+
826
+ - **Content-Type**: Not defined
827
+ - **Accept**: application/vnd.mx.api.v1+json
828
+
829
+
830
+ ## list_transactions_by_tag
831
+
832
+ > <TransactionsResponseBodyIncludes> list_transactions_by_tag(user_guid, tag_guid, opts)
833
+
834
+ List transactions by tag
835
+
836
+ Use this endpoint to get a list of all transactions associated with a particular tag according to the tag's unique GUID. This lists all transactions that have been assigned to a particular tag using the create tagging endpoint. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
837
+
838
+ ### Examples
839
+
840
+ ```ruby
841
+ require 'time'
842
+ require 'mx-platform-ruby'
843
+ # setup authorization
844
+ MxPlatformRuby.configure do |config|
845
+ # Configure HTTP basic authorization: basicAuth
846
+ config.username = 'YOUR USERNAME'
847
+ config.password = 'YOUR PASSWORD'
848
+ end
849
+
850
+ api_instance = MxPlatformRuby::TransactionsApi.new
851
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
852
+ tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # String | The unique id for a `tag`.
853
+ opts = {
854
+ page: 1, # Integer | Results are paginated. Specify current page.
855
+ 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 `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
856
+ from_date: '2024-01-01', # String | Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
857
+ to_date: '2024-03-31', # String | Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.
858
+ from_created_at: '2024-01-01', # String | Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
859
+ to_created_at: '2024-03-31', # String | Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
860
+ from_updated_at: '2024-01-01', # String | Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
861
+ to_updated_at: '2024-03-31', # String | Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
862
+ category_guid: 'category_guid_example', # String | Filter transactions belonging to specified `category_guid`. For example, `?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
863
+ category_guid2: ['inner_example'], # Array<String> | Filter transactions belonging to any specified `category_guid[]` in url. For example, `?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
864
+ top_level_category_guid: 'top_level_category_guid_example', # String | Filter transactions belonging to specified `top_level_category_guid`. This must be top level category guid, use `category_guid` for subcategory guid. For example, `?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
865
+ top_level_category_guid2: ['inner_example'], # Array<String> | Filter transactions belonging to any specified `top_level_category_guid[]` in url. This must be top level category guid(s), use `category_guid` for subcategory guid(s). For example, `?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874`.
866
+ use_case: 'MONEY_MOVEMENT', # String | The use case associated with the member. Valid values are `PFM` and `MONEY_MOVEMENT`. For example, you can append either `?use_case=PFM` or `?use_case=MONEY_MOVEMENT`.
867
+ includes: 'repeating_transactions,merchants,classifications,geolocations' # String | Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append: `?includes=repeating_transactions,merchants,classifications,geolocations`. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: `?includes=repeating_transactions,geolocations`. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata.
868
+ }
869
+
870
+ begin
871
+ # List transactions by tag
872
+ result = api_instance.list_transactions_by_tag(user_guid, tag_guid, opts)
873
+ p result
874
+ rescue MxPlatformRuby::ApiError => e
875
+ puts "Error when calling TransactionsApi->list_transactions_by_tag: #{e}"
876
+ end
877
+ ```
878
+
879
+ #### Using the list_transactions_by_tag_with_http_info variant
880
+
881
+ This returns an Array which contains the response data, status code and headers.
882
+
883
+ > <Array(<TransactionsResponseBodyIncludes>, Integer, Hash)> list_transactions_by_tag_with_http_info(user_guid, tag_guid, opts)
884
+
885
+ ```ruby
886
+ begin
887
+ # List transactions by tag
888
+ data, status_code, headers = api_instance.list_transactions_by_tag_with_http_info(user_guid, tag_guid, opts)
889
+ p status_code # => 2xx
890
+ p headers # => { ... }
891
+ p data # => <TransactionsResponseBodyIncludes>
892
+ rescue MxPlatformRuby::ApiError => e
893
+ puts "Error when calling TransactionsApi->list_transactions_by_tag_with_http_info: #{e}"
894
+ end
895
+ ```
896
+
897
+ ### Parameters
898
+
899
+ | Name | Type | Description | Notes |
900
+ | ---- | ---- | ----------- | ----- |
901
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
902
+ | **tag_guid** | **String** | The unique id for a &#x60;tag&#x60;. | |
903
+ | **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
904
+ | **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;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead. | [optional] |
905
+ | **from_date** | **String** | Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided. | [optional] |
906
+ | **to_date** | **String** | Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions. | [optional] |
907
+ | **from_created_at** | **String** | Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months. | [optional] |
908
+ | **to_created_at** | **String** | Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months. | [optional] |
909
+ | **from_updated_at** | **String** | Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months. | [optional] |
910
+ | **to_updated_at** | **String** | Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months. | [optional] |
911
+ | **category_guid** | **String** | Filter transactions belonging to specified &#x60;category_guid&#x60;. For example, &#x60;?category_guid&#x3D;CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874&#x60;. | [optional] |
912
+ | **category_guid2** | [**Array&lt;String&gt;**](String.md) | Filter transactions belonging to any specified &#x60;category_guid[]&#x60; in url. For example, &#x60;?category_guid[]&#x3D;CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874&#x60;. | [optional] |
913
+ | **top_level_category_guid** | **String** | Filter transactions belonging to specified &#x60;top_level_category_guid&#x60;. This must be top level category guid, use &#x60;category_guid&#x60; for subcategory guid. For example, &#x60;?top_level_category_guid&#x3D;CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874&#x60;. | [optional] |
914
+ | **top_level_category_guid2** | [**Array&lt;String&gt;**](String.md) | Filter transactions belonging to any specified &#x60;top_level_category_guid[]&#x60; in url. This must be top level category guid(s), use &#x60;category_guid&#x60; for subcategory guid(s). For example, &#x60;?top_level_category_guid[]&#x3D;CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874&#x60;. | [optional] |
915
+ | **use_case** | **String** | The use case associated with the member. Valid values are &#x60;PFM&#x60; and &#x60;MONEY_MOVEMENT&#x60;. For example, you can append either &#x60;?use_case&#x3D;PFM&#x60; or &#x60;?use_case&#x3D;MONEY_MOVEMENT&#x60;. | [optional] |
916
+ | **includes** | **String** | Options for enhanced transactions. This query parameter is optional. Possible additional metadata: &#x60;repeating_transactions&#x60;, &#x60;merchants&#x60;, &#x60;classifications&#x60;, &#x60;geolocations&#x60;. The query value is format sensitive. To retrieve all available enhancements, append: &#x60;?includes&#x3D;repeating_transactions,merchants,classifications,geolocations&#x60;. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: &#x60;?includes&#x3D;repeating_transactions,geolocations&#x60;. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata. | [optional] |
917
+
918
+ ### Return type
919
+
920
+ [**TransactionsResponseBodyIncludes**](TransactionsResponseBodyIncludes.md)
921
+
922
+ ### Authorization
923
+
924
+ [basicAuth](../README.md#basicAuth)
925
+
926
+ ### HTTP request headers
927
+
928
+ - **Content-Type**: Not defined
929
+ - **Accept**: application/vnd.mx.api.v1+json
930
+
931
+
932
+ ## read_transaction
933
+
934
+ > <TransactionsResponseBodyIncludes> read_transaction(user_guid, transaction_guid, opts)
935
+
936
+ Read transaction
937
+
938
+ Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
939
+
940
+ ### Examples
941
+
942
+ ```ruby
943
+ require 'time'
944
+ require 'mx-platform-ruby'
945
+ # setup authorization
946
+ MxPlatformRuby.configure do |config|
947
+ # Configure HTTP basic authorization: basicAuth
948
+ config.username = 'YOUR USERNAME'
949
+ config.password = 'YOUR PASSWORD'
950
+ end
951
+
952
+ api_instance = MxPlatformRuby::TransactionsApi.new
953
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
954
+ transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
955
+ opts = {
956
+ includes: 'repeating_transactions,merchants,classifications,geolocations' # String | Options for enhanced transactions. This query parameter is optional. Possible additional metadata: `repeating_transactions`, `merchants`, `classifications`, `geolocations`. The query value is format sensitive. To retrieve all available enhancements, append: `?includes=repeating_transactions,merchants,classifications,geolocations`. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: `?includes=repeating_transactions,geolocations`. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata.
957
+ }
958
+
959
+ begin
960
+ # Read transaction
961
+ result = api_instance.read_transaction(user_guid, transaction_guid, opts)
962
+ p result
963
+ rescue MxPlatformRuby::ApiError => e
964
+ puts "Error when calling TransactionsApi->read_transaction: #{e}"
965
+ end
966
+ ```
967
+
968
+ #### Using the read_transaction_with_http_info variant
969
+
970
+ This returns an Array which contains the response data, status code and headers.
971
+
972
+ > <Array(<TransactionsResponseBodyIncludes>, Integer, Hash)> read_transaction_with_http_info(user_guid, transaction_guid, opts)
973
+
974
+ ```ruby
975
+ begin
976
+ # Read transaction
977
+ data, status_code, headers = api_instance.read_transaction_with_http_info(user_guid, transaction_guid, opts)
978
+ p status_code # => 2xx
979
+ p headers # => { ... }
980
+ p data # => <TransactionsResponseBodyIncludes>
981
+ rescue MxPlatformRuby::ApiError => e
982
+ puts "Error when calling TransactionsApi->read_transaction_with_http_info: #{e}"
983
+ end
984
+ ```
985
+
986
+ ### Parameters
987
+
988
+ | Name | Type | Description | Notes |
989
+ | ---- | ---- | ----------- | ----- |
990
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
991
+ | **transaction_guid** | **String** | The unique id for a &#x60;transaction&#x60;. | |
992
+ | **includes** | **String** | Options for enhanced transactions. This query parameter is optional. Possible additional metadata: &#x60;repeating_transactions&#x60;, &#x60;merchants&#x60;, &#x60;classifications&#x60;, &#x60;geolocations&#x60;. The query value is format sensitive. To retrieve all available enhancements, append: &#x60;?includes&#x3D;repeating_transactions,merchants,classifications,geolocations&#x60;. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: &#x60;?includes&#x3D;repeating_transactions,geolocations&#x60;. - Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). - Merchants: Enriches transactions with merchant name. - Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. - Geolocation: Provides geographic metadata. | [optional] |
993
+
994
+ ### Return type
995
+
996
+ [**TransactionsResponseBodyIncludes**](TransactionsResponseBodyIncludes.md)
997
+
998
+ ### Authorization
999
+
1000
+ [basicAuth](../README.md#basicAuth)
1001
+
1002
+ ### HTTP request headers
1003
+
1004
+ - **Content-Type**: Not defined
1005
+ - **Accept**: application/vnd.mx.api.v1+json
1006
+
1007
+
1008
+ ## repeating_transactions
1009
+
1010
+ > <RepeatingTransactionsResponseBody> repeating_transactions(user_guid)
1011
+
1012
+ List Repeating Transactions
1013
+
1014
+ Retrieve a list of all recurring transactions for a user. <br /><br />For more see the [Repeating Transactions guide](repeating-transactions-overview.mdx).
1015
+
1016
+ ### Examples
1017
+
1018
+ ```ruby
1019
+ require 'time'
1020
+ require 'mx-platform-ruby'
1021
+ # setup authorization
1022
+ MxPlatformRuby.configure do |config|
1023
+ # Configure HTTP basic authorization: basicAuth
1024
+ config.username = 'YOUR USERNAME'
1025
+ config.password = 'YOUR PASSWORD'
1026
+ end
1027
+
1028
+ api_instance = MxPlatformRuby::TransactionsApi.new
1029
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
1030
+
1031
+ begin
1032
+ # List Repeating Transactions
1033
+ result = api_instance.repeating_transactions(user_guid)
1034
+ p result
1035
+ rescue MxPlatformRuby::ApiError => e
1036
+ puts "Error when calling TransactionsApi->repeating_transactions: #{e}"
1037
+ end
1038
+ ```
1039
+
1040
+ #### Using the repeating_transactions_with_http_info variant
1041
+
1042
+ This returns an Array which contains the response data, status code and headers.
1043
+
1044
+ > <Array(<RepeatingTransactionsResponseBody>, Integer, Hash)> repeating_transactions_with_http_info(user_guid)
1045
+
1046
+ ```ruby
1047
+ begin
1048
+ # List Repeating Transactions
1049
+ data, status_code, headers = api_instance.repeating_transactions_with_http_info(user_guid)
1050
+ p status_code # => 2xx
1051
+ p headers # => { ... }
1052
+ p data # => <RepeatingTransactionsResponseBody>
1053
+ rescue MxPlatformRuby::ApiError => e
1054
+ puts "Error when calling TransactionsApi->repeating_transactions_with_http_info: #{e}"
1055
+ end
1056
+ ```
1057
+
1058
+ ### Parameters
1059
+
1060
+ | Name | Type | Description | Notes |
1061
+ | ---- | ---- | ----------- | ----- |
1062
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
1063
+
1064
+ ### Return type
1065
+
1066
+ [**RepeatingTransactionsResponseBody**](RepeatingTransactionsResponseBody.md)
1067
+
1068
+ ### Authorization
1069
+
1070
+ [basicAuth](../README.md#basicAuth)
1071
+
1072
+ ### HTTP request headers
1073
+
1074
+ - **Content-Type**: Not defined
1075
+ - **Accept**: application/vnd.mx.api.v1+json
1076
+
1077
+
1078
+ ## specific_repeating_transaction
1079
+
1080
+ > <RepeatingTransactionsResponseBody> specific_repeating_transaction(user_guid, repeating_transaction_guid)
1081
+
1082
+ Get a Repeating Transaction
1083
+
1084
+ Get a Specific Repeating Transaction. <br /><br />List For more see the [Repeating Transactions guide](repeating-transactions-overview.mdx)
1085
+
1086
+ ### Examples
1087
+
1088
+ ```ruby
1089
+ require 'time'
1090
+ require 'mx-platform-ruby'
1091
+ # setup authorization
1092
+ MxPlatformRuby.configure do |config|
1093
+ # Configure HTTP basic authorization: basicAuth
1094
+ config.username = 'YOUR USERNAME'
1095
+ config.password = 'YOUR PASSWORD'
1096
+ end
1097
+
1098
+ api_instance = MxPlatformRuby::TransactionsApi.new
1099
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
1100
+ repeating_transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a recurring transaction.
1101
+
1102
+ begin
1103
+ # Get a Repeating Transaction
1104
+ result = api_instance.specific_repeating_transaction(user_guid, repeating_transaction_guid)
1105
+ p result
1106
+ rescue MxPlatformRuby::ApiError => e
1107
+ puts "Error when calling TransactionsApi->specific_repeating_transaction: #{e}"
1108
+ end
1109
+ ```
1110
+
1111
+ #### Using the specific_repeating_transaction_with_http_info variant
1112
+
1113
+ This returns an Array which contains the response data, status code and headers.
1114
+
1115
+ > <Array(<RepeatingTransactionsResponseBody>, Integer, Hash)> specific_repeating_transaction_with_http_info(user_guid, repeating_transaction_guid)
1116
+
1117
+ ```ruby
1118
+ begin
1119
+ # Get a Repeating Transaction
1120
+ data, status_code, headers = api_instance.specific_repeating_transaction_with_http_info(user_guid, repeating_transaction_guid)
1121
+ p status_code # => 2xx
1122
+ p headers # => { ... }
1123
+ p data # => <RepeatingTransactionsResponseBody>
1124
+ rescue MxPlatformRuby::ApiError => e
1125
+ puts "Error when calling TransactionsApi->specific_repeating_transaction_with_http_info: #{e}"
1126
+ end
1127
+ ```
1128
+
1129
+ ### Parameters
1130
+
1131
+ | Name | Type | Description | Notes |
1132
+ | ---- | ---- | ----------- | ----- |
1133
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
1134
+ | **repeating_transaction_guid** | **String** | The unique id for a recurring transaction. | |
1135
+
1136
+ ### Return type
1137
+
1138
+ [**RepeatingTransactionsResponseBody**](RepeatingTransactionsResponseBody.md)
1139
+
1140
+ ### Authorization
1141
+
1142
+ [basicAuth](../README.md#basicAuth)
1143
+
1144
+ ### HTTP request headers
1145
+
1146
+ - **Content-Type**: Not defined
1147
+ - **Accept**: application/vnd.mx.api.v1+json
1148
+
1149
+
1150
+ ## update_transaction
1151
+
1152
+ > <TransactionResponseBody> update_transaction(user_guid, transaction_guid, transaction_update_request_body)
1153
+
1154
+ Update transaction
1155
+
1156
+ Use this endpoint to update a specific transaction according to its unique GUID.
1157
+
1158
+ ### Examples
1159
+
1160
+ ```ruby
1161
+ require 'time'
1162
+ require 'mx-platform-ruby'
1163
+ # setup authorization
1164
+ MxPlatformRuby.configure do |config|
1165
+ # Configure HTTP basic authorization: basicAuth
1166
+ config.username = 'YOUR USERNAME'
1167
+ config.password = 'YOUR PASSWORD'
1168
+ end
1169
+
1170
+ api_instance = MxPlatformRuby::TransactionsApi.new
1171
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
1172
+ transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
1173
+ transaction_update_request_body = MxPlatformRuby::TransactionUpdateRequestBody.new # TransactionUpdateRequestBody | Transaction object with the fields to be updated.
1174
+
1175
+ begin
1176
+ # Update transaction
1177
+ result = api_instance.update_transaction(user_guid, transaction_guid, transaction_update_request_body)
1178
+ p result
1179
+ rescue MxPlatformRuby::ApiError => e
1180
+ puts "Error when calling TransactionsApi->update_transaction: #{e}"
1181
+ end
1182
+ ```
1183
+
1184
+ #### Using the update_transaction_with_http_info variant
1185
+
1186
+ This returns an Array which contains the response data, status code and headers.
1187
+
1188
+ > <Array(<TransactionResponseBody>, Integer, Hash)> update_transaction_with_http_info(user_guid, transaction_guid, transaction_update_request_body)
1189
+
1190
+ ```ruby
1191
+ begin
1192
+ # Update transaction
1193
+ data, status_code, headers = api_instance.update_transaction_with_http_info(user_guid, transaction_guid, transaction_update_request_body)
1194
+ p status_code # => 2xx
1195
+ p headers # => { ... }
1196
+ p data # => <TransactionResponseBody>
1197
+ rescue MxPlatformRuby::ApiError => e
1198
+ puts "Error when calling TransactionsApi->update_transaction_with_http_info: #{e}"
1199
+ end
1200
+ ```
1201
+
1202
+ ### Parameters
1203
+
1204
+ | Name | Type | Description | Notes |
1205
+ | ---- | ---- | ----------- | ----- |
1206
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
1207
+ | **transaction_guid** | **String** | The unique id for a &#x60;transaction&#x60;. | |
1208
+ | **transaction_update_request_body** | [**TransactionUpdateRequestBody**](TransactionUpdateRequestBody.md) | Transaction object with the fields to be updated. | |
1209
+
1210
+ ### Return type
1211
+
1212
+ [**TransactionResponseBody**](TransactionResponseBody.md)
1213
+
1214
+ ### Authorization
1215
+
1216
+ [basicAuth](../README.md#basicAuth)
1217
+
1218
+ ### HTTP request headers
1219
+
1220
+ - **Content-Type**: application/json
1221
+ - **Accept**: application/vnd.mx.api.v1+json
1222
+
1223
+
1224
+ ## update_transaction_by_account
1225
+
1226
+ > <TransactionResponseBody> update_transaction_by_account(user_guid, member_guid, account_guid, transaction_guid, transaction_update_request_body)
1227
+
1228
+ Update Transaction by Account
1229
+
1230
+ Use this endpoint to update a specific transaction according to its unique GUID.
1231
+
1232
+ ### Examples
1233
+
1234
+ ```ruby
1235
+ require 'time'
1236
+ require 'mx-platform-ruby'
1237
+ # setup authorization
1238
+ MxPlatformRuby.configure do |config|
1239
+ # Configure HTTP basic authorization: basicAuth
1240
+ config.username = 'YOUR USERNAME'
1241
+ config.password = 'YOUR PASSWORD'
1242
+ end
1243
+
1244
+ api_instance = MxPlatformRuby::TransactionsApi.new
1245
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
1246
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
1247
+ account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
1248
+ transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
1249
+ transaction_update_request_body = MxPlatformRuby::TransactionUpdateRequestBody.new # TransactionUpdateRequestBody | Transaction object to be updated
1250
+
1251
+ begin
1252
+ # Update Transaction by Account
1253
+ result = api_instance.update_transaction_by_account(user_guid, member_guid, account_guid, transaction_guid, transaction_update_request_body)
1254
+ p result
1255
+ rescue MxPlatformRuby::ApiError => e
1256
+ puts "Error when calling TransactionsApi->update_transaction_by_account: #{e}"
1257
+ end
1258
+ ```
1259
+
1260
+ #### Using the update_transaction_by_account_with_http_info variant
1261
+
1262
+ This returns an Array which contains the response data, status code and headers.
1263
+
1264
+ > <Array(<TransactionResponseBody>, Integer, Hash)> update_transaction_by_account_with_http_info(user_guid, member_guid, account_guid, transaction_guid, transaction_update_request_body)
1265
+
1266
+ ```ruby
1267
+ begin
1268
+ # Update Transaction by Account
1269
+ data, status_code, headers = api_instance.update_transaction_by_account_with_http_info(user_guid, member_guid, account_guid, transaction_guid, transaction_update_request_body)
1270
+ p status_code # => 2xx
1271
+ p headers # => { ... }
1272
+ p data # => <TransactionResponseBody>
1273
+ rescue MxPlatformRuby::ApiError => e
1274
+ puts "Error when calling TransactionsApi->update_transaction_by_account_with_http_info: #{e}"
1275
+ end
1276
+ ```
1277
+
1278
+ ### Parameters
1279
+
1280
+ | Name | Type | Description | Notes |
1281
+ | ---- | ---- | ----------- | ----- |
1282
+ | **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. | |
1283
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
1284
+ | **account_guid** | **String** | The unique id for an &#x60;account&#x60;. | |
1285
+ | **transaction_guid** | **String** | The unique id for a &#x60;transaction&#x60;. | |
1286
+ | **transaction_update_request_body** | [**TransactionUpdateRequestBody**](TransactionUpdateRequestBody.md) | Transaction object to be updated | |
1287
+
1288
+ ### Return type
1289
+
1290
+ [**TransactionResponseBody**](TransactionResponseBody.md)
1291
+
1292
+ ### Authorization
1293
+
1294
+ [basicAuth](../README.md#basicAuth)
1295
+
1296
+ ### HTTP request headers
1297
+
1298
+ - **Content-Type**: application/json
1299
+ - **Accept**: application/json
1300
+