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,1519 +0,0 @@
1
- =begin
2
- #MX Platform API
3
-
4
- #The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.
5
-
6
- The version of the OpenAPI document: 0.1.0
7
-
8
- Generated by: https://openapi-generator.tech
9
- Generator version: 7.8.0
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
-
16
- # Unit tests for MxPlatformRuby::MxPlatformApi
17
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
- # Please update as you see appropriate
19
- describe 'MxPlatformApi' do
20
- before do
21
- # run before each test
22
- @api_instance = MxPlatformRuby::MxPlatformApi.new
23
- end
24
-
25
- after do
26
- # run after each test
27
- end
28
-
29
- describe 'test an instance of MxPlatformApi' do
30
- it 'should create an instance of MxPlatformApi' do
31
- expect(@api_instance).to be_instance_of(MxPlatformRuby::MxPlatformApi)
32
- end
33
- end
34
-
35
- # unit tests for aggregate_member
36
- # Aggregate member
37
- # Calling this endpoint initiates an aggregation event for the member. This brings in the latest account and transaction data from the connected institution. If this data has recently been updated, MX may not initiate an aggregation event.
38
- # @param member_guid The unique id for a `member`.
39
- # @param user_guid The unique id for a `user`.
40
- # @param [Hash] opts the optional parameters
41
- # @option opts [Boolean] :include_holdings When set to `false`, the aggregation will not gather holdings data. Defaults to `true`.
42
- # @option opts [Boolean] :include_transactions When set to `false`, the aggregation will not gather transactions data. Defaults to `true`.
43
- # @return [MemberResponseBody]
44
- describe 'aggregate_member test' do
45
- it 'should work' do
46
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
47
- end
48
- end
49
-
50
- # unit tests for check_balances
51
- # Check balances
52
- # This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data.
53
- # @param member_guid The unique id for a `member`.
54
- # @param user_guid The unique id for a `user`.
55
- # @param [Hash] opts the optional parameters
56
- # @return [MemberResponseBody]
57
- describe 'check_balances test' do
58
- it 'should work' do
59
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
60
- end
61
- end
62
-
63
- # unit tests for create_category
64
- # Create category
65
- # Use this endpoint to create a new custom category for a specific `user`.
66
- # @param user_guid The unique id for a `user`.
67
- # @param category_create_request_body Custom category object to be created
68
- # @param [Hash] opts the optional parameters
69
- # @return [CategoryResponseBody]
70
- describe 'create_category test' do
71
- it 'should work' do
72
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
73
- end
74
- end
75
-
76
- # unit tests for create_managed_account
77
- # Create managed account
78
- # Use this endpoint to create a partner-managed account.
79
- # @param member_guid The unique id for a `member`.
80
- # @param user_guid The unique id for a `user`.
81
- # @param managed_account_create_request_body Managed account to be created.
82
- # @param [Hash] opts the optional parameters
83
- # @return [AccountResponseBody]
84
- describe 'create_managed_account test' do
85
- it 'should work' do
86
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
87
- end
88
- end
89
-
90
- # unit tests for create_managed_member
91
- # Create managed member
92
- # Use this endpoint to create a new partner-managed `member`.
93
- # @param user_guid The unique id for a `user`.
94
- # @param managed_member_create_request_body Managed member to be created.
95
- # @param [Hash] opts the optional parameters
96
- # @return [MemberResponseBody]
97
- describe 'create_managed_member test' do
98
- it 'should work' do
99
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
100
- end
101
- end
102
-
103
- # unit tests for create_managed_transaction
104
- # Create managed transaction
105
- # Use this endpoint to create a new partner-managed `transaction`.
106
- # @param account_guid The unique id for an `account`.
107
- # @param member_guid The unique id for a `member`.
108
- # @param user_guid The unique id for a `user`.
109
- # @param managed_transaction_create_request_body Managed transaction to be created.
110
- # @param [Hash] opts the optional parameters
111
- # @return [TransactionResponseBody]
112
- describe 'create_managed_transaction test' do
113
- it 'should work' do
114
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
115
- end
116
- end
117
-
118
- # unit tests for create_manual_account
119
- # Create manual account
120
- # This endpoint can only be used to create manual accounts. Creating a manual account will automatically create it under the Manual Institution member. Since a manual account has no credentials tied to the member, the account will never aggregate or include data from a data feed.
121
- # @param user_guid The unique id for a `user`.
122
- # @param account_create_request_body Manual account object to be created.
123
- # @param [Hash] opts the optional parameters
124
- # @return [AccountResponseBody]
125
- describe 'create_manual_account test' do
126
- it 'should work' do
127
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
128
- end
129
- end
130
-
131
- # unit tests for create_member
132
- # Create member
133
- # This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters id and metadata. When creating a member, youll need to include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the `/institutions/{institution_code}/credentials` endpoint. If successful, the MX Platform API will respond with the newly-created member object. Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data for accounts and transactions.
134
- # @param user_guid The unique id for a `user`.
135
- # @param member_create_request_body Member object to be created with optional parameters (id and metadata) and required parameters (credentials and institution_code)
136
- # @param [Hash] opts the optional parameters
137
- # @return [MemberResponseBody]
138
- describe 'create_member test' do
139
- it 'should work' do
140
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
141
- end
142
- end
143
-
144
- # unit tests for create_tag
145
- # Create tag
146
- # Use this endpoint to create a new custom tag.
147
- # @param user_guid The unique id for a `user`.
148
- # @param tag_create_request_body Tag object to be created with required parameters (tag_guid)
149
- # @param [Hash] opts the optional parameters
150
- # @return [TagResponseBody]
151
- describe 'create_tag test' do
152
- it 'should work' do
153
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
154
- end
155
- end
156
-
157
- # unit tests for create_tagging
158
- # Create tagging
159
- # Use this endpoint to create a new association between a tag and a particular transaction, according to their unique GUIDs.
160
- # @param user_guid The unique id for a `user`.
161
- # @param tagging_create_request_body Tagging object to be created with required parameters (tag_guid and transaction_guid)
162
- # @param [Hash] opts the optional parameters
163
- # @return [TaggingResponseBody]
164
- describe 'create_tagging test' do
165
- it 'should work' do
166
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
167
- end
168
- end
169
-
170
- # unit tests for create_transaction_rule
171
- # Create transaction rule
172
- # Use this endpoint to create a new transaction rule. The newly-created `transaction_rule` object will be returned if successful.
173
- # @param user_guid The unique id for a `user`.
174
- # @param transaction_rule_create_request_body TransactionRule object to be created with optional parameters (description) and required parameters (category_guid and match_description)
175
- # @param [Hash] opts the optional parameters
176
- # @return [TransactionRuleResponseBody]
177
- describe 'create_transaction_rule test' do
178
- it 'should work' do
179
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
180
- end
181
- end
182
-
183
- # unit tests for create_user
184
- # Create user
185
- # Use this endpoint to create a new user. The API will respond with the newly-created user object if successful. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user’s data until they are no longer disabled.
186
- # @param user_create_request_body User object to be created. (None of these parameters are required, but the user object cannot be empty)
187
- # @param [Hash] opts the optional parameters
188
- # @return [UserResponseBody]
189
- describe 'create_user test' do
190
- it 'should work' do
191
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
192
- end
193
- end
194
-
195
- # unit tests for credit_card
196
- # Read a Credit Card Product
197
- # This endpoint returns the specified `credit_card_product` according to the unique GUID.
198
- # @param credit_card_product_guid The required `credit_card_product_guid` can be found on the `account` object.
199
- # @param [Hash] opts the optional parameters
200
- # @return [CreditCardProductResponse]
201
- describe 'credit_card test' do
202
- it 'should work' do
203
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
204
- end
205
- end
206
-
207
- # unit tests for delete_category
208
- # Delete category
209
- # Use this endpoint to delete a specific custom category according to its unique GUID. The API will respond with an empty object and a status of `204 No Content`.
210
- # @param category_guid The unique id for a `category`.
211
- # @param user_guid The unique id for a `user`.
212
- # @param [Hash] opts the optional parameters
213
- # @return [nil]
214
- describe 'delete_category test' do
215
- it 'should work' do
216
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
217
- end
218
- end
219
-
220
- # unit tests for delete_managed_account
221
- # Delete managed account
222
- # Use this endpoint to delete a partner-managed account according to its unique GUID. If successful, the API will respond with a status of `204 No Content`.
223
- # @param account_guid The unique id for an `account`.
224
- # @param member_guid The unique id for a `member`.
225
- # @param user_guid The unique id for a `user`.
226
- # @param [Hash] opts the optional parameters
227
- # @return [nil]
228
- describe 'delete_managed_account test' do
229
- it 'should work' do
230
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
231
- end
232
- end
233
-
234
- # unit tests for delete_managed_member
235
- # Delete managed member
236
- # Use this endpoint to delete the specified partner-managed `member`. The endpoint will respond with a status of `204 No Content` without a resource.
237
- # @param member_guid The unique id for a `member`.
238
- # @param user_guid The unique id for a `user`.
239
- # @param [Hash] opts the optional parameters
240
- # @return [nil]
241
- describe 'delete_managed_member test' do
242
- it 'should work' do
243
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
244
- end
245
- end
246
-
247
- # unit tests for delete_managed_transaction
248
- # Delete managed transaction
249
- # Use this endpoint to delete the specified partner-managed `transaction`. The endpoint will respond with a status of `204 No Content` without a resource.
250
- # @param account_guid The unique id for an `account`.
251
- # @param member_guid The unique id for a `member`.
252
- # @param transaction_guid The unique id for a `transaction`.
253
- # @param user_guid The unique id for a `user`.
254
- # @param [Hash] opts the optional parameters
255
- # @return [nil]
256
- describe 'delete_managed_transaction test' do
257
- it 'should work' do
258
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
259
- end
260
- end
261
-
262
- # unit tests for delete_manual_account
263
- # Delete manual account
264
- # This endpoint deletes accounts that were manually created. The API will respond with an empty object and a status of `204 No Content`.
265
- # @param account_guid The unique id for an `account`.
266
- # @param user_guid The unique id for a `user`.
267
- # @param [Hash] opts the optional parameters
268
- # @return [nil]
269
- describe 'delete_manual_account test' do
270
- it 'should work' do
271
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
272
- end
273
- end
274
-
275
- # unit tests for delete_member
276
- # Delete member
277
- # Accessing this endpoint will permanently delete a member.
278
- # @param member_guid The unique id for a `member`.
279
- # @param user_guid The unique id for a `user`.
280
- # @param [Hash] opts the optional parameters
281
- # @return [nil]
282
- describe 'delete_member test' do
283
- it 'should work' do
284
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
285
- end
286
- end
287
-
288
- # unit tests for delete_tag
289
- # Delete tag
290
- # Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of `204 No Content`.
291
- # @param tag_guid The unique id for a `tag`.
292
- # @param user_guid The unique id for a `user`.
293
- # @param [Hash] opts the optional parameters
294
- # @return [nil]
295
- describe 'delete_tag test' do
296
- it 'should work' do
297
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
298
- end
299
- end
300
-
301
- # unit tests for delete_tagging
302
- # Delete tagging
303
- # Use this endpoint to delete a tagging according to its unique GUID. If successful, the API will respond with an empty body and a status of 204 NO Content.
304
- # @param tagging_guid The unique id for a `tagging`.
305
- # @param user_guid The unique id for a `user`.
306
- # @param [Hash] opts the optional parameters
307
- # @return [nil]
308
- describe 'delete_tagging test' do
309
- it 'should work' do
310
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
311
- end
312
- end
313
-
314
- # unit tests for delete_transaction_rule
315
- # Delete transaction rule
316
- # Use this endpoint to permanently delete a transaction rule based on its unique GUID.
317
- # @param transaction_rule_guid The unique id for a `transaction_rule`.
318
- # @param user_guid The unique id for a `user`.
319
- # @param [Hash] opts the optional parameters
320
- # @return [nil]
321
- describe 'delete_transaction_rule test' do
322
- it 'should work' do
323
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
324
- end
325
- end
326
-
327
- # unit tests for delete_user
328
- # Delete user
329
- # Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object.
330
- # @param user_guid The unique id for a `user`.
331
- # @param [Hash] opts the optional parameters
332
- # @return [nil]
333
- describe 'delete_user test' do
334
- it 'should work' do
335
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
336
- end
337
- end
338
-
339
- # unit tests for deprecated_request_payment_processor_authorization_code
340
- # (Deprecated) Request an authorization code.
341
- # (This endpoint is deprecated. Clients should use `/authorization_code`.) Clients use this endpoint to request an authorization_code according to a user, member, and account specified in the request body. Clients then pass this code to processors. Processor access is scoped only to the user/member/account specified in this request. Before requesting an authorization_code, clients must have verified the specified member.
342
- # @param payment_processor_authorization_code_request_body The scope for the authorization code.
343
- # @param [Hash] opts the optional parameters
344
- # @return [PaymentProcessorAuthorizationCodeResponseBody]
345
- describe 'deprecated_request_payment_processor_authorization_code test' do
346
- it 'should work' do
347
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
348
- end
349
- end
350
-
351
- # unit tests for download_statement_pdf
352
- # Download statement pdf
353
- # Use this endpoint to download a specified statement PDF.
354
- # @param member_guid The unique id for a `member`.
355
- # @param statement_guid The unique id for a `statement`.
356
- # @param user_guid The unique id for a `user`.
357
- # @param [Hash] opts the optional parameters
358
- # @return [File]
359
- describe 'download_statement_pdf test' do
360
- it 'should work' do
361
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
362
- end
363
- end
364
-
365
- # unit tests for download_tax_document
366
- # Download a Tax Document PDF
367
- # Use this endpoint to download a PDF version of the specified tax document. The endpoint URL is the base URL appended with the uri of the tax_document.
368
- # @param tax_document_guid The unique id for a `tax_document`.
369
- # @param member_guid The unique id for a `member`.
370
- # @param user_guid The unique id for a `user`.
371
- # @param [Hash] opts the optional parameters
372
- # @return [File]
373
- describe 'download_tax_document test' do
374
- it 'should work' do
375
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
376
- end
377
- end
378
-
379
- # unit tests for enhance_transactions
380
- # Enhance transactions
381
- # Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform.
382
- # @param enhance_transactions_request_body Transaction object to be enhanced
383
- # @param [Hash] opts the optional parameters
384
- # @return [EnhanceTransactionsResponseBody]
385
- describe 'enhance_transactions test' do
386
- it 'should work' do
387
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
388
- end
389
- end
390
-
391
- # unit tests for extend_history
392
- # Extend history
393
- # 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.
394
- # @param member_guid The unique identifier for a `member`.
395
- # @param user_guid The unique identifier for a `user`.
396
- # @param [Hash] opts the optional parameters
397
- # @return [MemberResponseBody]
398
- describe 'extend_history test' do
399
- it 'should work' do
400
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
401
- end
402
- end
403
-
404
- # unit tests for fetch_rewards
405
- # Fetch Rewards
406
- # Calling this endpoint initiates an aggregation-type event which will gather the member's rewards information, as well as account and transaction information. Rewards data is also gathered with daily background aggregations.
407
- # @param user_guid The unique id for a `user`.
408
- # @param member_guid The unique identifier for the member. Defined by MX.
409
- # @param [Hash] opts the optional parameters
410
- # @return [MemberResponseBody]
411
- describe 'fetch_rewards test' do
412
- it 'should work' do
413
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
414
- end
415
- end
416
-
417
- # unit tests for fetch_statements
418
- # Fetch statements
419
- # Use this endpoint to fetch the statements associated with a particular member.
420
- # @param member_guid The unique id for a `member`.
421
- # @param user_guid The unique id for a `user`.
422
- # @param [Hash] opts the optional parameters
423
- # @return [MemberResponseBody]
424
- describe 'fetch_statements test' do
425
- it 'should work' do
426
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
427
- end
428
- end
429
-
430
- # unit tests for fetch_tax_documents
431
- # Fetch Tax Documents
432
- # Use this endpoint to fetch (aggregate) the tax documents associated with the specified member. This request **does not** return the latest tax documents. It just starts the document aggregation process and returns the initial state of the process. You must interact with the newly aggregated data using the other document endpoints in this reference. This request may also trigger multi-factor authentication which requires end-user input and a specific process for answering authentication challenges.
433
- # @param member_guid The unique id for a `member`.
434
- # @param user_guid The unique id for a `user`.
435
- # @param [Hash] opts the optional parameters
436
- # @return [MemberResponseBody]
437
- describe 'fetch_tax_documents test' do
438
- it 'should work' do
439
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
440
- end
441
- end
442
-
443
- # unit tests for identify_member
444
- # Identify member
445
- # The identify endpoint begins an identification process for an already-existing member.
446
- # @param member_guid The unique id for a `member`.
447
- # @param user_guid The unique id for a `user`.
448
- # @param [Hash] opts the optional parameters
449
- # @return [MemberResponseBody]
450
- describe 'identify_member test' do
451
- it 'should work' do
452
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
453
- end
454
- end
455
-
456
- # unit tests for list_account_numbers_by_account
457
- # List account numbers by account
458
- # This endpoint returns a list of account numbers associated with the specified `account`.
459
- # @param account_guid The unique id for an `account`.
460
- # @param user_guid The unique id for a `user`.
461
- # @param [Hash] opts the optional parameters
462
- # @option opts [Integer] :page Specify current page.
463
- # @option opts [Integer] :records_per_page Specify records per page.
464
- # @return [AccountNumbersResponseBody]
465
- describe 'list_account_numbers_by_account test' do
466
- it 'should work' do
467
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
468
- end
469
- end
470
-
471
- # unit tests for list_account_numbers_by_member
472
- # List account numbers by member
473
- # This endpoint returns a list of account numbers associated with the specified `member`.
474
- # @param member_guid The unique id for a `member`.
475
- # @param user_guid The unique id for a `user`.
476
- # @param [Hash] opts the optional parameters
477
- # @option opts [Integer] :page Specify current page.
478
- # @option opts [Integer] :records_per_page Specify records per page.
479
- # @return [AccountNumbersResponseBody]
480
- describe 'list_account_numbers_by_member test' do
481
- it 'should work' do
482
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
483
- end
484
- end
485
-
486
- # unit tests for list_account_owners_by_member
487
- # List account owners by member
488
- # This endpoint returns an array with information about every account associated with a particular member.
489
- # @param member_guid The unique id for a `member`.
490
- # @param user_guid The unique id for a `user`.
491
- # @param [Hash] opts the optional parameters
492
- # @option opts [Integer] :page Specify current page.
493
- # @option opts [Integer] :records_per_page Specify records per page.
494
- # @return [AccountOwnersResponseBody]
495
- describe 'list_account_owners_by_member test' do
496
- it 'should work' do
497
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
498
- end
499
- end
500
-
501
- # unit tests for list_categories
502
- # List categories
503
- # Use this endpoint to list all categories associated with a `user`, including both default and custom categories.
504
- # @param user_guid The unique id for a `user`.
505
- # @param [Hash] opts the optional parameters
506
- # @option opts [Integer] :page Specify current page.
507
- # @option opts [Integer] :records_per_page Specify records per page.
508
- # @return [CategoriesResponseBody]
509
- describe 'list_categories test' do
510
- it 'should work' do
511
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
512
- end
513
- end
514
-
515
- # unit tests for list_default_categories
516
- # List default categories
517
- # Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
518
- # @param [Hash] opts the optional parameters
519
- # @option opts [Integer] :page Specify current page.
520
- # @option opts [Integer] :records_per_page Specify records per page.
521
- # @return [CategoriesResponseBody]
522
- describe 'list_default_categories test' do
523
- it 'should work' do
524
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
525
- end
526
- end
527
-
528
- # unit tests for list_default_categories_by_user
529
- # List default categories by user
530
- # Use this endpoint to retrieve a list of all the default categories and subcategories, scoped by user, offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
531
- # @param user_guid The unique id for a `user`.
532
- # @param [Hash] opts the optional parameters
533
- # @option opts [Integer] :page Specify current page.
534
- # @option opts [Integer] :records_per_page Specify records per page.
535
- # @return [CategoriesResponseBody]
536
- describe 'list_default_categories_by_user test' do
537
- it 'should work' do
538
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
539
- end
540
- end
541
-
542
- # unit tests for list_favorite_institutions
543
- # List favorite institutions
544
- # This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity. Please contact MX to set a list of favorites.
545
- # @param [Hash] opts the optional parameters
546
- # @option opts [Integer] :page Specify current page.
547
- # @option opts [Integer] :records_per_page Specify records per page.
548
- # @return [InstitutionsResponseBody]
549
- describe 'list_favorite_institutions test' do
550
- it 'should work' do
551
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
552
- end
553
- end
554
-
555
- # unit tests for list_holdings
556
- # List holdings
557
- # This endpoint returns all holdings associated with the specified `user` across all accounts and members.
558
- # @param user_guid The unique id for a `user`.
559
- # @param [Hash] opts the optional parameters
560
- # @option opts [String] :from_date Filter holdings from this date.
561
- # @option opts [Integer] :page Specify current page.
562
- # @option opts [Integer] :records_per_page Specify records per page.
563
- # @option opts [String] :to_date Filter holdings to this date.
564
- # @return [HoldingsResponseBody]
565
- describe 'list_holdings test' do
566
- it 'should work' do
567
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
568
- end
569
- end
570
-
571
- # unit tests for list_holdings_by_account
572
- # List holdings by account
573
- # This endpoint returns all holdings associated with the specified `account`.
574
- # @param account_guid The unique id for the `account`.
575
- # @param user_guid The unique id for the `user`.
576
- # @param [Hash] opts the optional parameters
577
- # @option opts [String] :from_date Filter holdings from this date.
578
- # @option opts [Integer] :page Specify current page.
579
- # @option opts [Integer] :records_per_page Specify records per page.
580
- # @option opts [String] :to_date Filter holdings to this date.
581
- # @return [HoldingsResponseBody]
582
- describe 'list_holdings_by_account test' do
583
- it 'should work' do
584
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
585
- end
586
- end
587
-
588
- # unit tests for list_holdings_by_member
589
- # List holdings by member
590
- # This endpoint returns all holdings associated with the specified `member` across all accounts.
591
- # @param member_guid The unique id for a `member`.
592
- # @param user_guid The unique id for a `user`.
593
- # @param [Hash] opts the optional parameters
594
- # @option opts [String] :from_date Filter holdings from this date.
595
- # @option opts [Integer] :page Specify current page.
596
- # @option opts [Integer] :records_per_page Specify records per page.
597
- # @option opts [String] :to_date Filter holdings to this date.
598
- # @return [HoldingsResponseBody]
599
- describe 'list_holdings_by_member test' do
600
- it 'should work' do
601
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
602
- end
603
- end
604
-
605
- # unit tests for list_institution_credentials
606
- # List institution credentials
607
- # Use this endpoint to see which credentials will be needed to create a member for a specific institution.
608
- # @param institution_code The institution_code of the institution.
609
- # @param [Hash] opts the optional parameters
610
- # @option opts [Integer] :page Specify current page.
611
- # @option opts [Integer] :records_per_page Specify records per page.
612
- # @return [CredentialsResponseBody]
613
- describe 'list_institution_credentials test' do
614
- it 'should work' do
615
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
616
- end
617
- end
618
-
619
- # unit tests for list_institutions
620
- # List institutions
621
- # This endpoint returns a list of institutions based on the specified search term or parameter.
622
- # @param [Hash] opts the optional parameters
623
- # @option opts [String] :name This will list only institutions in which the appended string appears.
624
- # @option opts [Integer] :page Specify current page.
625
- # @option opts [Integer] :records_per_page Specify records per page.
626
- # @option opts [Boolean] :supports_account_identification Filter only institutions which support account identification.
627
- # @option opts [Boolean] :supports_account_statement Filter only institutions which support account statements.
628
- # @option opts [Boolean] :supports_account_verification Filter only institutions which support account verification.
629
- # @option opts [Boolean] :supports_transaction_history Filter only institutions which support extended transaction history.
630
- # @return [InstitutionsResponseBody]
631
- describe 'list_institutions test' do
632
- it 'should work' do
633
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
634
- end
635
- end
636
-
637
- # unit tests for list_managed_accounts
638
- # List managed accounts
639
- # Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-manage member.
640
- # @param member_guid The unique id for a `member`.
641
- # @param user_guid The unique id for a `user`.
642
- # @param [Hash] opts the optional parameters
643
- # @option opts [Integer] :page Specify current page.
644
- # @option opts [Integer] :records_per_page Specify records per page.
645
- # @return [AccountsResponseBody]
646
- describe 'list_managed_accounts test' do
647
- it 'should work' do
648
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
649
- end
650
- end
651
-
652
- # unit tests for list_managed_institutions
653
- # List managed institutions
654
- # This endpoint returns a list of institutions which can be used to create partner-managed members.
655
- # @param [Hash] opts the optional parameters
656
- # @option opts [Integer] :page Specify current page.
657
- # @option opts [Integer] :records_per_page Specify records per page.
658
- # @return [InstitutionsResponseBody]
659
- describe 'list_managed_institutions test' do
660
- it 'should work' do
661
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
662
- end
663
- end
664
-
665
- # unit tests for list_managed_members
666
- # List managed members
667
- # This endpoint returns a list of all the partner-managed members associated with the specified `user`.
668
- # @param user_guid The unique id for a `user`.
669
- # @param [Hash] opts the optional parameters
670
- # @option opts [Integer] :page Specify current page.
671
- # @option opts [Integer] :records_per_page Specify records per page.
672
- # @return [MembersResponseBody]
673
- describe 'list_managed_members test' do
674
- it 'should work' do
675
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
676
- end
677
- end
678
-
679
- # unit tests for list_managed_transactions
680
- # List managed transactions
681
- # This endpoint returns a list of all the partner-managed transactions associated with the specified `account`, scoped through a `user` and a `member`.
682
- # @param account_guid The unique id for an `account`.
683
- # @param member_guid The unique id for a `member`.
684
- # @param user_guid The unique id for a `user`.
685
- # @param [Hash] opts the optional parameters
686
- # @option opts [Integer] :page Specify current page.
687
- # @option opts [Integer] :records_per_page Specify records per page.
688
- # @return [TransactionsResponseBody]
689
- describe 'list_managed_transactions test' do
690
- it 'should work' do
691
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
692
- end
693
- end
694
-
695
- # unit tests for list_member_accounts
696
- # List accounts by member
697
- # This endpoint returns a list of all the accounts associated with the specified `member`.
698
- # @param user_guid The unique id for a `user`.
699
- # @param member_guid The unique id for a `member`.
700
- # @param [Hash] opts the optional parameters
701
- # @option opts [Boolean] :member_is_managed_by_user List only accounts whose member is managed by the user.
702
- # @option opts [Integer] :page Specify current page.
703
- # @option opts [Integer] :records_per_page Specify records per page.
704
- # @return [AccountsResponseBody]
705
- describe 'list_member_accounts test' do
706
- it 'should work' do
707
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
708
- end
709
- end
710
-
711
- # unit tests for list_member_challenges
712
- # List member challenges
713
- # Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member. If the aggregation is not challenged, i.e., the member does not have a connection status of `CHALLENGED`, then code `204 No Content` will be returned. If the aggregation has been challenged, i.e., the member does have a connection status of `CHALLENGED`, then code `200 OK` will be returned - along with the corresponding credentials.
714
- # @param member_guid The unique id for a `member`.
715
- # @param user_guid The unique id for a `user`.
716
- # @param [Hash] opts the optional parameters
717
- # @option opts [Integer] :page Specify current page.
718
- # @option opts [Integer] :records_per_page Specify records per page.
719
- # @return [ChallengesResponseBody]
720
- describe 'list_member_challenges test' do
721
- it 'should work' do
722
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
723
- end
724
- end
725
-
726
- # unit tests for list_member_credentials
727
- # List member credentials
728
- # This endpoint returns an array which contains information on every non-MFA credential associated with a specific member.
729
- # @param member_guid The unique id for a `member`.
730
- # @param user_guid The unique id for a `user`.
731
- # @param [Hash] opts the optional parameters
732
- # @option opts [Integer] :page Specify current page.
733
- # @option opts [Integer] :records_per_page Specify records per page.
734
- # @return [CredentialsResponseBody]
735
- describe 'list_member_credentials test' do
736
- it 'should work' do
737
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
738
- end
739
- end
740
-
741
- # unit tests for list_members
742
- # List members
743
- # This endpoint returns an array which contains information on every member associated with a specific user.
744
- # @param user_guid The unique id for a `user`.
745
- # @param [Hash] opts the optional parameters
746
- # @option opts [Integer] :page Specify current page.
747
- # @option opts [Integer] :records_per_page Specify records per page.
748
- # @return [MembersResponseBody]
749
- describe 'list_members test' do
750
- it 'should work' do
751
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
752
- end
753
- end
754
-
755
- # unit tests for list_merchants
756
- # List merchants
757
- # This endpoint returns a paginated list of all the merchants in the MX system.
758
- # @param [Hash] opts the optional parameters
759
- # @option opts [Integer] :page Specify current page.
760
- # @option opts [Integer] :records_per_page Specify records per page.
761
- # @return [MerchantsResponseBody]
762
- describe 'list_merchants test' do
763
- it 'should work' do
764
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
765
- end
766
- end
767
-
768
- # unit tests for list_rewards
769
- # List Rewards
770
- # Use this endpoint to list all the `rewards` associated with a specified `member`.
771
- # @param user_guid The unique id for a `user`.
772
- # @param member_guid The unique identifier for the member. Defined by MX.
773
- # @param [Hash] opts the optional parameters
774
- # @return [RewardsResponseBody]
775
- describe 'list_rewards test' do
776
- it 'should work' do
777
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
778
- end
779
- end
780
-
781
- # unit tests for list_statements_by_member
782
- # List statements by member
783
- # Use this endpoint to get an array of available statements.
784
- # @param member_guid The unique id for a `member`.
785
- # @param user_guid The unique id for a `user`.
786
- # @param [Hash] opts the optional parameters
787
- # @option opts [Integer] :page Specify current page.
788
- # @option opts [Integer] :records_per_page Specify records per page.
789
- # @return [StatementsResponseBody]
790
- describe 'list_statements_by_member test' do
791
- it 'should work' do
792
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
793
- end
794
- end
795
-
796
- # unit tests for list_taggings
797
- # List taggings
798
- # Use this endpoint to retrieve a list of all the taggings associated with a specific user.
799
- # @param user_guid The unique id for a `user`.
800
- # @param [Hash] opts the optional parameters
801
- # @option opts [Integer] :page Specify current page.
802
- # @option opts [Integer] :records_per_page Specify records per page.
803
- # @return [TaggingsResponseBody]
804
- describe 'list_taggings test' do
805
- it 'should work' do
806
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
807
- end
808
- end
809
-
810
- # unit tests for list_tags
811
- # List tags
812
- # Use this endpoint to list all tags associated with the specified `user`. Each user includes the `Business` tag by default.
813
- # @param user_guid The unique id for a `user`.
814
- # @param [Hash] opts the optional parameters
815
- # @option opts [Integer] :page Specify current page.
816
- # @option opts [Integer] :records_per_page Specify records per page.
817
- # @return [TagsResponseBody]
818
- describe 'list_tags test' do
819
- it 'should work' do
820
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
821
- end
822
- end
823
-
824
- # unit tests for list_tax_documents
825
- # List Tax Documents
826
- # Use this endpoint to get a paginated list of tax documents.
827
- # @param member_guid The unique id for a `member`.
828
- # @param user_guid The unique id for a `user`.
829
- # @param [Hash] opts the optional parameters
830
- # @option opts [Integer] :page Specify current page.
831
- # @option opts [Integer] :records_per_page Specify records per page.
832
- # @return [TaxDocumentsResponseBody]
833
- describe 'list_tax_documents test' do
834
- it 'should work' do
835
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
836
- end
837
- end
838
-
839
- # unit tests for list_transaction_rules
840
- # List transaction rules
841
- # Use this endpoint to read the attributes of all existing transaction rules belonging to the user.
842
- # @param user_guid The unique id for a `user`.
843
- # @param [Hash] opts the optional parameters
844
- # @option opts [Integer] :page Specify current page.
845
- # @option opts [Integer] :records_per_page Specify records per page.
846
- # @return [TransactionRulesResponseBody]
847
- describe 'list_transaction_rules test' do
848
- it 'should work' do
849
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
850
- end
851
- end
852
-
853
- # unit tests for list_transactions
854
- # List transactions
855
- # Requests to this endpoint return a list of transactions associated with the specified `user`, accross all members and accounts associated with that `user`.
856
- # @param user_guid The unique id for a `user`.
857
- # @param [Hash] opts the optional parameters
858
- # @option opts [String] :from_date Filter transactions from this date.
859
- # @option opts [Integer] :page Specify current page.
860
- # @option opts [Integer] :records_per_page Specify records per page.
861
- # @option opts [String] :to_date Filter transactions to this date.
862
- # @return [TransactionsResponseBody]
863
- describe 'list_transactions test' do
864
- it 'should work' do
865
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
866
- end
867
- end
868
-
869
- # unit tests for list_transactions_by_account
870
- # List transactions by account
871
- # This endpoint returns a list of the last 90 days of transactions associated with the specified account.
872
- # @param account_guid The unique id for an `account`.
873
- # @param user_guid The unique id for a `user`.
874
- # @param [Hash] opts the optional parameters
875
- # @option opts [String] :from_date Filter transactions from this date.
876
- # @option opts [Integer] :page Specify current page.
877
- # @option opts [Integer] :records_per_page Specify records per page.
878
- # @option opts [String] :to_date Filter transactions to this date.
879
- # @return [TransactionsResponseBody]
880
- describe 'list_transactions_by_account test' do
881
- it 'should work' do
882
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
883
- end
884
- end
885
-
886
- # unit tests for list_transactions_by_member
887
- # List transactions by member
888
- # Requests to this endpoint return a list of transactions associated with the specified `member`, accross all accounts associated with that `member`.
889
- # @param member_guid The unique id for a `member`.
890
- # @param user_guid The unique id for a `user`.
891
- # @param [Hash] opts the optional parameters
892
- # @option opts [String] :from_date Filter transactions from this date.
893
- # @option opts [Integer] :page Specify current page.
894
- # @option opts [Integer] :records_per_page Specify records per page.
895
- # @option opts [String] :to_date Filter transactions to this date.
896
- # @return [TransactionsResponseBody]
897
- describe 'list_transactions_by_member test' do
898
- it 'should work' do
899
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
900
- end
901
- end
902
-
903
- # unit tests for list_transactions_by_tag
904
- # List transactions by tag
905
- # Use this endpoint to get a list of all transactions associated with a particular tag according to the tag’s unique GUID. In other words, a list of all transactions that have been assigned to a particular tag using the create a tagging endpoint.
906
- # @param tag_guid The unique id for a `tag`.
907
- # @param user_guid The unique id for a `user`.
908
- # @param [Hash] opts the optional parameters
909
- # @option opts [String] :from_date Filter transactions from this date.
910
- # @option opts [Integer] :page Specify current page.
911
- # @option opts [Integer] :records_per_page Specify records per page.
912
- # @option opts [String] :to_date Filter transactions to this date.
913
- # @return [TransactionsResponseBody]
914
- describe 'list_transactions_by_tag test' do
915
- it 'should work' do
916
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
917
- end
918
- end
919
-
920
- # unit tests for list_user_accounts
921
- # List accounts
922
- # This endpoint returns a list of all the accounts associated with the specified `user`.
923
- # @param user_guid The unique id for a `user`.
924
- # @param [Hash] opts the optional parameters
925
- # @option opts [Boolean] :member_is_managed_by_user List only accounts whose member is managed by the user.
926
- # @option opts [Integer] :page Specify current page.
927
- # @option opts [Boolean] :is_manual List only accounts that were manually created.
928
- # @option opts [Integer] :records_per_page Specify records per page.
929
- # @return [AccountsResponseBody]
930
- describe 'list_user_accounts test' do
931
- it 'should work' do
932
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
933
- end
934
- end
935
-
936
- # unit tests for list_users
937
- # List users
938
- # Use this endpoint to list every user you've created in the MX Platform API.
939
- # @param [Hash] opts the optional parameters
940
- # @option opts [Integer] :page Specify current page.
941
- # @option opts [Integer] :records_per_page Specify records per page.
942
- # @option opts [String] :id The user `id` to search for.
943
- # @option opts [String] :email The user `email` to search for.
944
- # @option opts [Boolean] :is_disabled Search for users that are diabled.
945
- # @return [UsersResponseBody]
946
- describe 'list_users test' do
947
- it 'should work' do
948
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
949
- end
950
- end
951
-
952
- # unit tests for read_account
953
- # Read account
954
- # This endpoint returns the specified `account` resource.
955
- # @param account_guid The unique id for an `account`.
956
- # @param user_guid The unique id for a `user`.
957
- # @param [Hash] opts the optional parameters
958
- # @return [AccountResponseBody]
959
- describe 'read_account test' do
960
- it 'should work' do
961
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
962
- end
963
- end
964
-
965
- # unit tests for read_account_by_member
966
- # Read account by member
967
- # This endpoint allows you to read the attributes of an `account` resource.
968
- # @param account_guid The unique id for an `account`.
969
- # @param member_guid The unique id for a `member`.
970
- # @param user_guid The unique id for a `user`.
971
- # @param [Hash] opts the optional parameters
972
- # @return [AccountResponseBody]
973
- describe 'read_account_by_member test' do
974
- it 'should work' do
975
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
976
- end
977
- end
978
-
979
- # unit tests for read_category
980
- # Read a custom category
981
- # Use this endpoint to read the attributes of either a default category or a custom category.
982
- # @param category_guid The unique id for a `category`.
983
- # @param user_guid The unique id for a `user`.
984
- # @param [Hash] opts the optional parameters
985
- # @return [CategoryResponseBody]
986
- describe 'read_category test' do
987
- it 'should work' do
988
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
989
- end
990
- end
991
-
992
- # unit tests for read_default_category
993
- # Read a default category
994
- # Use this endpoint to read the attributes of a default category.
995
- # @param category_guid The unique id for a `category`.
996
- # @param [Hash] opts the optional parameters
997
- # @return [CategoryResponseBody]
998
- describe 'read_default_category test' do
999
- it 'should work' do
1000
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1001
- end
1002
- end
1003
-
1004
- # unit tests for read_holding
1005
- # Read holding
1006
- # Use this endpoint to read the attributes of a specific `holding`.
1007
- # @param holding_guid The unique id for a `holding`.
1008
- # @param user_guid The unique id for a `user`.
1009
- # @param [Hash] opts the optional parameters
1010
- # @return [HoldingResponseBody]
1011
- describe 'read_holding test' do
1012
- it 'should work' do
1013
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1014
- end
1015
- end
1016
-
1017
- # unit tests for read_institution
1018
- # Read institution
1019
- # This endpoint returns information about the institution specified by `institution_code`.
1020
- # @param institution_code The institution_code of the institution.
1021
- # @param [Hash] opts the optional parameters
1022
- # @return [InstitutionResponseBody]
1023
- describe 'read_institution test' do
1024
- it 'should work' do
1025
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1026
- end
1027
- end
1028
-
1029
- # unit tests for read_managed_account
1030
- # Read managed account
1031
- # Use this endpoint to read the attributes of a partner-managed account according to its unique guid.
1032
- # @param account_guid The unique id for an `account`.
1033
- # @param member_guid The unique id for a `member`.
1034
- # @param user_guid The unique id for a `user`.
1035
- # @param [Hash] opts the optional parameters
1036
- # @return [AccountResponseBody]
1037
- describe 'read_managed_account test' do
1038
- it 'should work' do
1039
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1040
- end
1041
- end
1042
-
1043
- # unit tests for read_managed_member
1044
- # Read managed member
1045
- # This endpoint returns the attributes of the specified partner-managed `member`.
1046
- # @param member_guid The unique id for a `member`.
1047
- # @param user_guid The unique id for a `user`.
1048
- # @param [Hash] opts the optional parameters
1049
- # @return [MemberResponseBody]
1050
- describe 'read_managed_member test' do
1051
- it 'should work' do
1052
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1053
- end
1054
- end
1055
-
1056
- # unit tests for read_managed_transaction
1057
- # Read managed transaction
1058
- # Requests to this endpoint will return the attributes of the specified partner-managed `transaction`.
1059
- # @param account_guid The unique id for an `account`.
1060
- # @param member_guid The unique id for a `member`.
1061
- # @param transaction_guid The unique id for a `transaction`.
1062
- # @param user_guid The unique id for a `user`.
1063
- # @param [Hash] opts the optional parameters
1064
- # @return [TransactionResponseBody]
1065
- describe 'read_managed_transaction test' do
1066
- it 'should work' do
1067
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1068
- end
1069
- end
1070
-
1071
- # unit tests for read_member
1072
- # Read member
1073
- # Use this endpoint to read the attributes of a specific member.
1074
- # @param member_guid The unique id for a `member`.
1075
- # @param user_guid The unique id for a `user`.
1076
- # @param [Hash] opts the optional parameters
1077
- # @return [MemberResponseBody]
1078
- describe 'read_member test' do
1079
- it 'should work' do
1080
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1081
- end
1082
- end
1083
-
1084
- # unit tests for read_member_status
1085
- # Read member status
1086
- # This endpoint provides the status of the members most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member. MX has introduced new, more detailed information on the current status of a members connection to a financial institution and the state of its aggregation - the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being.
1087
- # @param member_guid The unique id for a `member`.
1088
- # @param user_guid The unique id for a `user`.
1089
- # @param [Hash] opts the optional parameters
1090
- # @return [MemberStatusResponseBody]
1091
- describe 'read_member_status test' do
1092
- it 'should work' do
1093
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1094
- end
1095
- end
1096
-
1097
- # unit tests for read_merchant
1098
- # Read merchant
1099
- # Returns information about a particular merchant, such as a logo, name, and website.
1100
- # @param merchant_guid The unique id for a `merchant`.
1101
- # @param [Hash] opts the optional parameters
1102
- # @return [MerchantResponseBody]
1103
- describe 'read_merchant test' do
1104
- it 'should work' do
1105
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1106
- end
1107
- end
1108
-
1109
- # unit tests for read_merchant_location
1110
- # Read merchant location
1111
- # This endpoint returns the specified merchant_location resource.
1112
- # @param merchant_location_guid The unique id for a `merchant_location`.
1113
- # @param [Hash] opts the optional parameters
1114
- # @return [MerchantLocationResponseBody]
1115
- describe 'read_merchant_location test' do
1116
- it 'should work' do
1117
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1118
- end
1119
- end
1120
-
1121
- # unit tests for read_rewards
1122
- # Read Reward
1123
- # Use this endpoint to read a specific `reward` based on its unique GUID..
1124
- # @param user_guid The unique id for a `user`.
1125
- # @param member_guid The unique identifier for the member. Defined by MX.
1126
- # @param reward_guid The unique identifier for the rewards. Defined by MX.
1127
- # @param [Hash] opts the optional parameters
1128
- # @return [RewardResponseBody]
1129
- describe 'read_rewards test' do
1130
- it 'should work' do
1131
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1132
- end
1133
- end
1134
-
1135
- # unit tests for read_statement_by_member
1136
- # Read statement by member
1137
- # Use this endpoint to read a JSON representation of the statement.
1138
- # @param member_guid The unique id for a `member`.
1139
- # @param statement_guid The unique id for a `statement`.
1140
- # @param user_guid The unique id for a `user`.
1141
- # @param [Hash] opts the optional parameters
1142
- # @return [StatementResponseBody]
1143
- describe 'read_statement_by_member test' do
1144
- it 'should work' do
1145
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1146
- end
1147
- end
1148
-
1149
- # unit tests for read_tag
1150
- # Read tag
1151
- # Use this endpoint to read the attributes of a particular tag according to its unique GUID.
1152
- # @param tag_guid The unique id for a `tag`.
1153
- # @param user_guid The unique id for a `user`.
1154
- # @param [Hash] opts the optional parameters
1155
- # @return [TagResponseBody]
1156
- describe 'read_tag test' do
1157
- it 'should work' do
1158
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1159
- end
1160
- end
1161
-
1162
- # unit tests for read_tagging
1163
- # Read tagging
1164
- # Use this endpoint to read the attributes of a `tagging` according to its unique GUID.
1165
- # @param tagging_guid The unique id for a `tagging`.
1166
- # @param user_guid The unique id for a `user`.
1167
- # @param [Hash] opts the optional parameters
1168
- # @return [TaggingResponseBody]
1169
- describe 'read_tagging test' do
1170
- it 'should work' do
1171
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1172
- end
1173
- end
1174
-
1175
- # unit tests for read_tax_document
1176
- # Read a Tax Document
1177
- # Use this endpoint to read the attributes of the specified tax document.
1178
- # @param tax_document_guid The unique id for a `tax_document`.
1179
- # @param member_guid The unique id for a `member`.
1180
- # @param user_guid The unique id for a `user`.
1181
- # @param [Hash] opts the optional parameters
1182
- # @return [TaxDocumentResponseBody]
1183
- describe 'read_tax_document test' do
1184
- it 'should work' do
1185
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1186
- end
1187
- end
1188
-
1189
- # unit tests for read_transaction
1190
- # Read transaction
1191
- # Requests to this endpoint will return the attributes of the specified `transaction`.
1192
- # @param transaction_guid The unique id for a `transaction`.
1193
- # @param user_guid The unique id for a `user`.
1194
- # @param [Hash] opts the optional parameters
1195
- # @return [TransactionResponseBody]
1196
- describe 'read_transaction test' do
1197
- it 'should work' do
1198
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1199
- end
1200
- end
1201
-
1202
- # unit tests for read_transaction_rule
1203
- # Read transaction rule
1204
- # Use this endpoint to read the attributes of an existing transaction rule based on the rule’s unique GUID.
1205
- # @param transaction_rule_guid The unique id for a `transaction_rule`.
1206
- # @param user_guid The unique id for a `user`.
1207
- # @param [Hash] opts the optional parameters
1208
- # @return [TransactionRuleResponseBody]
1209
- describe 'read_transaction_rule test' do
1210
- it 'should work' do
1211
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1212
- end
1213
- end
1214
-
1215
- # unit tests for read_user
1216
- # Read user
1217
- # Use this endpoint to read the attributes of a specific user.
1218
- # @param user_guid The unique id for a `user`.
1219
- # @param [Hash] opts the optional parameters
1220
- # @return [UserResponseBody]
1221
- describe 'read_user test' do
1222
- it 'should work' do
1223
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1224
- end
1225
- end
1226
-
1227
- # unit tests for request_authorization_code
1228
- # Request an authorization code.
1229
- # Clients use this endpoint to request an authorization code according to the parameters specified in the scope. Clients then pass this code to processors. Processor access is scoped only to the GUIDs and features specified in this request. Before requesting an authorization code which includes a member in the scope, clients must have verified that member.
1230
- # @param authorization_code_request_body The scope for the authorization code.
1231
- # @param [Hash] opts the optional parameters
1232
- # @return [AuthorizationCodeResponseBody]
1233
- describe 'request_authorization_code test' do
1234
- it 'should work' do
1235
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1236
- end
1237
- end
1238
-
1239
- # unit tests for request_connect_widget_url
1240
- # Request connect widget url
1241
- # This endpoint will return a URL for an embeddable version of MX Connect.
1242
- # @param user_guid The unique id for a `user`.
1243
- # @param connect_widget_request_body Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)
1244
- # @param [Hash] opts the optional parameters
1245
- # @return [ConnectWidgetResponseBody]
1246
- describe 'request_connect_widget_url test' do
1247
- it 'should work' do
1248
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1249
- end
1250
- end
1251
-
1252
- # unit tests for request_o_auth_window_uri
1253
- # Request oauth window uri
1254
- # This endpoint will generate an `oauth_window_uri` for the specified `member`.
1255
- # @param member_guid The unique id for a `member`.
1256
- # @param user_guid The unique id for a `user`.
1257
- # @param [Hash] opts the optional parameters
1258
- # @option opts [String] :client_redirect_url A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with `referral_source=APP`.
1259
- # @option opts [String] :enable_app2app This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to `true`. This setting is not persistent.
1260
- # @option opts [String] :referral_source Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`.
1261
- # @option opts [Boolean] :skip_aggregation Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page.
1262
- # @option opts [String] :ui_message_webview_url_scheme A scheme for routing the user back to the application state they were previously in. Only available with `referral_source=APP`.
1263
- # @return [OAuthWindowResponseBody]
1264
- describe 'request_o_auth_window_uri test' do
1265
- it 'should work' do
1266
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1267
- end
1268
- end
1269
-
1270
- # unit tests for request_widget_url
1271
- # Request widget url
1272
- # This endpoint allows partners to get a URL by passing the `widget_type` in the request body, as well as configuring it in several different ways. In the case of Connect, that means setting the `widget_type` to `connect_widget`. Partners may also pass an optional `Accept-Language` header as well as a number of configuration options. Note that this is a `POST` request.
1273
- # @param user_guid The unique id for a `user`.
1274
- # @param widget_request_body The widget url configuration options.
1275
- # @param [Hash] opts the optional parameters
1276
- # @option opts [String] :accept_language The desired language of the widget.
1277
- # @return [WidgetResponseBody]
1278
- describe 'request_widget_url test' do
1279
- it 'should work' do
1280
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1281
- end
1282
- end
1283
-
1284
- # unit tests for resume_aggregation
1285
- # Resume aggregation
1286
- # This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.
1287
- # @param member_guid The unique id for a `member`.
1288
- # @param user_guid The unique id for a `user`.
1289
- # @param member_resume_request_body Member object with MFA challenge answers
1290
- # @param [Hash] opts the optional parameters
1291
- # @return [MemberResponseBody]
1292
- describe 'resume_aggregation test' do
1293
- it 'should work' do
1294
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1295
- end
1296
- end
1297
-
1298
- # unit tests for update_account_by_member
1299
- # Update account by member
1300
- # This endpoint allows you to update certain attributes of an `account` resource, including manual accounts. For manual accounts, you can update every field listed. For aggregated accounts, you can only update `is_business`, `is_hidden` and `metadata`.
1301
- # @param account_guid The unique id for an `account`.
1302
- # @param member_guid The unique id for a `member`.
1303
- # @param user_guid The unique id for a `user`.
1304
- # @param account_update_request_body
1305
- # @param [Hash] opts the optional parameters
1306
- # @return [AccountResponseBody]
1307
- describe 'update_account_by_member test' do
1308
- it 'should work' do
1309
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1310
- end
1311
- end
1312
-
1313
- # unit tests for update_category
1314
- # Update category
1315
- # Use this endpoint to update the attributes of a custom category according to its unique GUID.
1316
- # @param category_guid The unique id for a `category`.
1317
- # @param user_guid The unique id for a `user`.
1318
- # @param category_update_request_body Category object to be updated (While no single parameter is required, the `category` object cannot be empty)
1319
- # @param [Hash] opts the optional parameters
1320
- # @return [CategoryResponseBody]
1321
- describe 'update_category test' do
1322
- it 'should work' do
1323
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1324
- end
1325
- end
1326
-
1327
- # unit tests for update_managed_account
1328
- # Update managed account
1329
- # Use this endpoint to update the attributes of a partner-managed account according to its unique GUID.
1330
- # @param account_guid The unique id for an `account`.
1331
- # @param member_guid The unique id for a `member`.
1332
- # @param user_guid The unique id for a `user`.
1333
- # @param managed_account_update_request_body Managed account object to be updated (While no single parameter is required, the request body can't be empty)
1334
- # @param [Hash] opts the optional parameters
1335
- # @return [AccountResponseBody]
1336
- describe 'update_managed_account test' do
1337
- it 'should work' do
1338
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1339
- end
1340
- end
1341
-
1342
- # unit tests for update_managed_member
1343
- # Update managed member
1344
- # Use this endpoint to update the attributes of the specified partner_managed `member`.
1345
- # @param member_guid The unique id for a `member`.
1346
- # @param user_guid The unique id for a `user`.
1347
- # @param managed_member_update_request_body Managed member object to be updated (While no single parameter is required, the request body can't be empty)
1348
- # @param [Hash] opts the optional parameters
1349
- # @return [MemberResponseBody]
1350
- describe 'update_managed_member test' do
1351
- it 'should work' do
1352
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1353
- end
1354
- end
1355
-
1356
- # unit tests for update_managed_transaction
1357
- # Update managed transaction
1358
- # Use this endpoint to update the attributes of the specified partner_managed `transaction`.
1359
- # @param account_guid The unique id for an `account`.
1360
- # @param member_guid The unique id for a `member`.
1361
- # @param transaction_guid The unique id for a `transaction`.
1362
- # @param user_guid The unique id for a `user`.
1363
- # @param managed_transaction_update_request_body Managed transaction object to be updated (While no single parameter is required, the request body can't be empty)
1364
- # @param [Hash] opts the optional parameters
1365
- # @return [TransactionResponseBody]
1366
- describe 'update_managed_transaction test' do
1367
- it 'should work' do
1368
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1369
- end
1370
- end
1371
-
1372
- # unit tests for update_member
1373
- # Update member
1374
- # Use this endpoint to update a members attributes. Only the credentials, id, and metadata parameters can be updated. To get a list of the required credentials for the member, use the list member credentials endpoint.
1375
- # @param member_guid The unique id for a `member`.
1376
- # @param user_guid The unique id for a `user`.
1377
- # @param member_update_request_body Member object to be updated (While no single parameter is required, the request body can't be empty)
1378
- # @param [Hash] opts the optional parameters
1379
- # @return [MemberResponseBody]
1380
- describe 'update_member test' do
1381
- it 'should work' do
1382
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1383
- end
1384
- end
1385
-
1386
- # unit tests for update_tag
1387
- # Update tag
1388
- # Use this endpoint to update the name of a specific tag according to its unique GUID.
1389
- # @param tag_guid The unique id for a `tag`.
1390
- # @param user_guid The unique id for a `user`.
1391
- # @param tag_update_request_body Tag object to be updated with required parameter (tag_guid)
1392
- # @param [Hash] opts the optional parameters
1393
- # @return [TagResponseBody]
1394
- describe 'update_tag test' do
1395
- it 'should work' do
1396
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1397
- end
1398
- end
1399
-
1400
- # unit tests for update_tagging
1401
- # Update tagging
1402
- # Use this endpoint to update a tagging.
1403
- # @param tagging_guid The unique id for a `tagging`.
1404
- # @param user_guid The unique id for a `user`.
1405
- # @param tagging_update_request_body Tagging object to be updated with required parameter (tag_guid)
1406
- # @param [Hash] opts the optional parameters
1407
- # @return [TaggingResponseBody]
1408
- describe 'update_tagging test' do
1409
- it 'should work' do
1410
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1411
- end
1412
- end
1413
-
1414
- # unit tests for update_transaction
1415
- # Update transaction
1416
- # Use this endpoint to update the `description` of a specific transaction according to its unique GUID.
1417
- # @param transaction_guid The unique id for a `transaction`.
1418
- # @param user_guid The unique id for a `user`.
1419
- # @param transaction_update_request_body Transaction object to be updated with a new description
1420
- # @param [Hash] opts the optional parameters
1421
- # @return [TransactionResponseBody]
1422
- describe 'update_transaction test' do
1423
- it 'should work' do
1424
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1425
- end
1426
- end
1427
-
1428
- # unit tests for update_transaction_rule
1429
- # Update transaction_rule
1430
- # Use this endpoint to update the attributes of a specific transaction rule based on its unique GUID. The API will respond with the updated transaction_rule object. Any attributes not provided will be left unchanged.
1431
- # @param transaction_rule_guid The unique id for a `transaction_rule`.
1432
- # @param user_guid The unique id for a `user`.
1433
- # @param transaction_rule_update_request_body TransactionRule object to be updated
1434
- # @param [Hash] opts the optional parameters
1435
- # @return [TransactionRuleResponseBody]
1436
- describe 'update_transaction_rule test' do
1437
- it 'should work' do
1438
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1439
- end
1440
- end
1441
-
1442
- # unit tests for update_user
1443
- # Update user
1444
- # Use this endpoint to update the attributes of the specified user.
1445
- # @param user_guid The unique id for a `user`.
1446
- # @param user_update_request_body User object to be updated (None of these parameters are required, but the user object cannot be empty.)
1447
- # @param [Hash] opts the optional parameters
1448
- # @return [UserResponseBody]
1449
- describe 'update_user test' do
1450
- it 'should work' do
1451
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1452
- end
1453
- end
1454
-
1455
- # unit tests for users_user_guid_monthly_cash_flow_profile_get
1456
- # Read monthly cash flow profile
1457
- # @param user_guid The unique identifier for the user.
1458
- # @param [Hash] opts the optional parameters
1459
- # @return [MonthlyCashFlowResponseBody]
1460
- describe 'users_user_guid_monthly_cash_flow_profile_get test' do
1461
- it 'should work' do
1462
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1463
- end
1464
- end
1465
-
1466
- # unit tests for users_user_guid_monthly_cash_flow_profile_put
1467
- # Update monthly cash flow profile
1468
- # Use this endpoint to update the attributes of a `monthly_cash_flow_profile`.
1469
- # @param user_guid The unique identifier for the user.
1470
- # @param monthly_cash_flow_profile_request_body
1471
- # @param [Hash] opts the optional parameters
1472
- # @return [MonthlyCashFlowResponseBody]
1473
- describe 'users_user_guid_monthly_cash_flow_profile_put test' do
1474
- it 'should work' do
1475
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1476
- end
1477
- end
1478
-
1479
- # unit tests for users_user_guid_transactions_transaction_guid_split_delete
1480
- # Delete split transactions
1481
- # 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.
1482
- # @param transaction_guid The unique id for a `transaction`.
1483
- # @param user_guid The unique id for a `user`.
1484
- # @param [Hash] opts the optional parameters
1485
- # @return [nil]
1486
- describe 'users_user_guid_transactions_transaction_guid_split_delete test' do
1487
- it 'should work' do
1488
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1489
- end
1490
- end
1491
-
1492
- # unit tests for users_user_guid_transactions_transaction_guid_split_post
1493
- # Create split transactions
1494
- # 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.
1495
- # @param user_guid The unique identifier for the user. Defined by MX.
1496
- # @param transaction_guid The unique identifier for the transaction. Defined by MX.
1497
- # @param [Hash] opts the optional parameters
1498
- # @option opts [SplitTransactionRequestBody] :split_transaction_request_body
1499
- # @return [SplitTransactionsResponseBody]
1500
- describe 'users_user_guid_transactions_transaction_guid_split_post test' do
1501
- it 'should work' do
1502
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1503
- end
1504
- end
1505
-
1506
- # unit tests for verify_member
1507
- # Verify member
1508
- # The verify endpoint begins a verification process for a member.
1509
- # @param member_guid The unique id for a `member`.
1510
- # @param user_guid The unique id for a `user`.
1511
- # @param [Hash] opts the optional parameters
1512
- # @return [MemberResponseBody]
1513
- describe 'verify_member test' do
1514
- it 'should work' do
1515
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
1516
- end
1517
- end
1518
-
1519
- end