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
@@ -0,0 +1,977 @@
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. Just getting started? See our [use case guides](/use-cases/).
5
+
6
+ The version of the OpenAPI document: 20111101
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.8.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module MxPlatformRuby
16
+ class MembersApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Aggregate member
23
+ # 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.
24
+ # @param member_guid [String] The unique id for a `member`.
25
+ # @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
26
+ # @param [Hash] opts the optional parameters
27
+ # @option opts [String] :x_callback_payload The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.
28
+ # @option opts [Boolean] :include_holdings When set to `false`, the aggregation will not gather holdings data. Defaults to `true`.
29
+ # @option opts [Boolean] :include_transactions When set to `false`, the aggregation will not gather transactions data. Defaults to `true`.
30
+ # @return [MemberResponseBody]
31
+ def aggregate_member(member_guid, user_guid, opts = {})
32
+ data, _status_code, _headers = aggregate_member_with_http_info(member_guid, user_guid, opts)
33
+ data
34
+ end
35
+
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 [String] The unique id for a `member`.
39
+ # @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
40
+ # @param [Hash] opts the optional parameters
41
+ # @option opts [String] :x_callback_payload The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.
42
+ # @option opts [Boolean] :include_holdings When set to `false`, the aggregation will not gather holdings data. Defaults to `true`.
43
+ # @option opts [Boolean] :include_transactions When set to `false`, the aggregation will not gather transactions data. Defaults to `true`.
44
+ # @return [Array<(MemberResponseBody, Integer, Hash)>] MemberResponseBody data, response status code and response headers
45
+ def aggregate_member_with_http_info(member_guid, user_guid, opts = {})
46
+ if @api_client.config.debugging
47
+ @api_client.config.logger.debug 'Calling API: MembersApi.aggregate_member ...'
48
+ end
49
+ # verify the required parameter 'member_guid' is set
50
+ if @api_client.config.client_side_validation && member_guid.nil?
51
+ fail ArgumentError, "Missing the required parameter 'member_guid' when calling MembersApi.aggregate_member"
52
+ end
53
+ # verify the required parameter 'user_guid' is set
54
+ if @api_client.config.client_side_validation && user_guid.nil?
55
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling MembersApi.aggregate_member"
56
+ end
57
+ # resource path
58
+ local_var_path = '/users/{user_guid}/members/{member_guid}/aggregate'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
59
+
60
+ # query parameters
61
+ query_params = opts[:query_params] || {}
62
+ query_params[:'include_holdings'] = opts[:'include_holdings'] if !opts[:'include_holdings'].nil?
63
+ query_params[:'include_transactions'] = opts[:'include_transactions'] if !opts[:'include_transactions'].nil?
64
+
65
+ # header parameters
66
+ header_params = opts[:header_params] || {}
67
+ # HTTP header 'Accept' (if needed)
68
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
69
+ header_params[:'X-CALLBACK-PAYLOAD'] = opts[:'x_callback_payload'] if !opts[:'x_callback_payload'].nil?
70
+
71
+ # form parameters
72
+ form_params = opts[:form_params] || {}
73
+
74
+ # http body (model)
75
+ post_body = opts[:debug_body]
76
+
77
+ # return_type
78
+ return_type = opts[:debug_return_type] || 'MemberResponseBody'
79
+
80
+ # auth_names
81
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
82
+
83
+ new_options = opts.merge(
84
+ :operation => :"MembersApi.aggregate_member",
85
+ :header_params => header_params,
86
+ :query_params => query_params,
87
+ :form_params => form_params,
88
+ :body => post_body,
89
+ :auth_names => auth_names,
90
+ :return_type => return_type
91
+ )
92
+
93
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
94
+ if @api_client.config.debugging
95
+ @api_client.config.logger.debug "API called: MembersApi#aggregate_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
96
+ end
97
+ return data, status_code, headers
98
+ end
99
+
100
+ # Check balances
101
+ # This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data.
102
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
103
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
104
+ # @param [Hash] opts the optional parameters
105
+ # @return [MemberResponseBody]
106
+ def check_balances(member_guid, user_guid, opts = {})
107
+ data, _status_code, _headers = check_balances_with_http_info(member_guid, user_guid, opts)
108
+ data
109
+ end
110
+
111
+ # Check balances
112
+ # This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data.
113
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
114
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
115
+ # @param [Hash] opts the optional parameters
116
+ # @return [Array<(MemberResponseBody, Integer, Hash)>] MemberResponseBody data, response status code and response headers
117
+ def check_balances_with_http_info(member_guid, user_guid, opts = {})
118
+ if @api_client.config.debugging
119
+ @api_client.config.logger.debug 'Calling API: MembersApi.check_balances ...'
120
+ end
121
+ # verify the required parameter 'member_guid' is set
122
+ if @api_client.config.client_side_validation && member_guid.nil?
123
+ fail ArgumentError, "Missing the required parameter 'member_guid' when calling MembersApi.check_balances"
124
+ end
125
+ # verify the required parameter 'user_guid' is set
126
+ if @api_client.config.client_side_validation && user_guid.nil?
127
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling MembersApi.check_balances"
128
+ end
129
+ # resource path
130
+ local_var_path = '/users/{user_guid}/members/{member_guid}/check_balance'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
131
+
132
+ # query parameters
133
+ query_params = opts[:query_params] || {}
134
+
135
+ # header parameters
136
+ header_params = opts[:header_params] || {}
137
+ # HTTP header 'Accept' (if needed)
138
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
139
+
140
+ # form parameters
141
+ form_params = opts[:form_params] || {}
142
+
143
+ # http body (model)
144
+ post_body = opts[:debug_body]
145
+
146
+ # return_type
147
+ return_type = opts[:debug_return_type] || 'MemberResponseBody'
148
+
149
+ # auth_names
150
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
151
+
152
+ new_options = opts.merge(
153
+ :operation => :"MembersApi.check_balances",
154
+ :header_params => header_params,
155
+ :query_params => query_params,
156
+ :form_params => form_params,
157
+ :body => post_body,
158
+ :auth_names => auth_names,
159
+ :return_type => return_type
160
+ )
161
+
162
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
163
+ if @api_client.config.debugging
164
+ @api_client.config.logger.debug "API called: MembersApi#check_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
165
+ end
166
+ return data, status_code, headers
167
+ end
168
+
169
+ # Create member
170
+ # 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.
171
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
172
+ # @param member_create_request_body [MemberCreateRequestBody] Member object to be created with optional parameters (id and metadata) and required parameters (credentials and institution_code)
173
+ # @param [Hash] opts the optional parameters
174
+ # @option opts [String] :x_callback_payload The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.
175
+ # @return [MemberResponseBody]
176
+ def create_member(user_guid, member_create_request_body, opts = {})
177
+ data, _status_code, _headers = create_member_with_http_info(user_guid, member_create_request_body, opts)
178
+ data
179
+ end
180
+
181
+ # Create member
182
+ # 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 &#x60;/institutions/{institution_code}/credentials&#x60; 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.
183
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
184
+ # @param member_create_request_body [MemberCreateRequestBody] Member object to be created with optional parameters (id and metadata) and required parameters (credentials and institution_code)
185
+ # @param [Hash] opts the optional parameters
186
+ # @option opts [String] :x_callback_payload The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.
187
+ # @return [Array<(MemberResponseBody, Integer, Hash)>] MemberResponseBody data, response status code and response headers
188
+ def create_member_with_http_info(user_guid, member_create_request_body, opts = {})
189
+ if @api_client.config.debugging
190
+ @api_client.config.logger.debug 'Calling API: MembersApi.create_member ...'
191
+ end
192
+ # verify the required parameter 'user_guid' is set
193
+ if @api_client.config.client_side_validation && user_guid.nil?
194
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling MembersApi.create_member"
195
+ end
196
+ # verify the required parameter 'member_create_request_body' is set
197
+ if @api_client.config.client_side_validation && member_create_request_body.nil?
198
+ fail ArgumentError, "Missing the required parameter 'member_create_request_body' when calling MembersApi.create_member"
199
+ end
200
+ # resource path
201
+ local_var_path = '/users/{user_guid}/members'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
202
+
203
+ # query parameters
204
+ query_params = opts[:query_params] || {}
205
+
206
+ # header parameters
207
+ header_params = opts[:header_params] || {}
208
+ # HTTP header 'Accept' (if needed)
209
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
210
+ # HTTP header 'Content-Type'
211
+ content_type = @api_client.select_header_content_type(['application/json'])
212
+ if !content_type.nil?
213
+ header_params['Content-Type'] = content_type
214
+ end
215
+ header_params[:'X-CALLBACK-PAYLOAD'] = opts[:'x_callback_payload'] if !opts[:'x_callback_payload'].nil?
216
+
217
+ # form parameters
218
+ form_params = opts[:form_params] || {}
219
+
220
+ # http body (model)
221
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(member_create_request_body)
222
+
223
+ # return_type
224
+ return_type = opts[:debug_return_type] || 'MemberResponseBody'
225
+
226
+ # auth_names
227
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
228
+
229
+ new_options = opts.merge(
230
+ :operation => :"MembersApi.create_member",
231
+ :header_params => header_params,
232
+ :query_params => query_params,
233
+ :form_params => form_params,
234
+ :body => post_body,
235
+ :auth_names => auth_names,
236
+ :return_type => return_type
237
+ )
238
+
239
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
240
+ if @api_client.config.debugging
241
+ @api_client.config.logger.debug "API called: MembersApi#create_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
242
+ end
243
+ return data, status_code, headers
244
+ end
245
+
246
+ # Delete member
247
+ # Accessing this endpoint will permanently delete a member.
248
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
249
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
250
+ # @param [Hash] opts the optional parameters
251
+ # @return [nil]
252
+ def delete_member(member_guid, user_guid, opts = {})
253
+ delete_member_with_http_info(member_guid, user_guid, opts)
254
+ nil
255
+ end
256
+
257
+ # Delete member
258
+ # Accessing this endpoint will permanently delete a member.
259
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
260
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
261
+ # @param [Hash] opts the optional parameters
262
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
263
+ def delete_member_with_http_info(member_guid, user_guid, opts = {})
264
+ if @api_client.config.debugging
265
+ @api_client.config.logger.debug 'Calling API: MembersApi.delete_member ...'
266
+ end
267
+ # verify the required parameter 'member_guid' is set
268
+ if @api_client.config.client_side_validation && member_guid.nil?
269
+ fail ArgumentError, "Missing the required parameter 'member_guid' when calling MembersApi.delete_member"
270
+ end
271
+ # verify the required parameter 'user_guid' is set
272
+ if @api_client.config.client_side_validation && user_guid.nil?
273
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling MembersApi.delete_member"
274
+ end
275
+ # resource path
276
+ local_var_path = '/users/{user_guid}/members/{member_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
277
+
278
+ # query parameters
279
+ query_params = opts[:query_params] || {}
280
+
281
+ # header parameters
282
+ header_params = opts[:header_params] || {}
283
+
284
+ # form parameters
285
+ form_params = opts[:form_params] || {}
286
+
287
+ # http body (model)
288
+ post_body = opts[:debug_body]
289
+
290
+ # return_type
291
+ return_type = opts[:debug_return_type]
292
+
293
+ # auth_names
294
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
295
+
296
+ new_options = opts.merge(
297
+ :operation => :"MembersApi.delete_member",
298
+ :header_params => header_params,
299
+ :query_params => query_params,
300
+ :form_params => form_params,
301
+ :body => post_body,
302
+ :auth_names => auth_names,
303
+ :return_type => return_type
304
+ )
305
+
306
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
307
+ if @api_client.config.debugging
308
+ @api_client.config.logger.debug "API called: MembersApi#delete_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
309
+ end
310
+ return data, status_code, headers
311
+ end
312
+
313
+ # Identify member
314
+ # The identify endpoint begins an identification process for an already-existing member.
315
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
316
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
317
+ # @param [Hash] opts the optional parameters
318
+ # @return [MemberResponseBody]
319
+ def identify_member(member_guid, user_guid, opts = {})
320
+ data, _status_code, _headers = identify_member_with_http_info(member_guid, user_guid, opts)
321
+ data
322
+ end
323
+
324
+ # Identify member
325
+ # The identify endpoint begins an identification process for an already-existing member.
326
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
327
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
328
+ # @param [Hash] opts the optional parameters
329
+ # @return [Array<(MemberResponseBody, Integer, Hash)>] MemberResponseBody data, response status code and response headers
330
+ def identify_member_with_http_info(member_guid, user_guid, opts = {})
331
+ if @api_client.config.debugging
332
+ @api_client.config.logger.debug 'Calling API: MembersApi.identify_member ...'
333
+ end
334
+ # verify the required parameter 'member_guid' is set
335
+ if @api_client.config.client_side_validation && member_guid.nil?
336
+ fail ArgumentError, "Missing the required parameter 'member_guid' when calling MembersApi.identify_member"
337
+ end
338
+ # verify the required parameter 'user_guid' is set
339
+ if @api_client.config.client_side_validation && user_guid.nil?
340
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling MembersApi.identify_member"
341
+ end
342
+ # resource path
343
+ local_var_path = '/users/{user_guid}/members/{member_guid}/identify'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
344
+
345
+ # query parameters
346
+ query_params = opts[:query_params] || {}
347
+
348
+ # header parameters
349
+ header_params = opts[:header_params] || {}
350
+ # HTTP header 'Accept' (if needed)
351
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
352
+
353
+ # form parameters
354
+ form_params = opts[:form_params] || {}
355
+
356
+ # http body (model)
357
+ post_body = opts[:debug_body]
358
+
359
+ # return_type
360
+ return_type = opts[:debug_return_type] || 'MemberResponseBody'
361
+
362
+ # auth_names
363
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
364
+
365
+ new_options = opts.merge(
366
+ :operation => :"MembersApi.identify_member",
367
+ :header_params => header_params,
368
+ :query_params => query_params,
369
+ :form_params => form_params,
370
+ :body => post_body,
371
+ :auth_names => auth_names,
372
+ :return_type => return_type
373
+ )
374
+
375
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
376
+ if @api_client.config.debugging
377
+ @api_client.config.logger.debug "API called: MembersApi#identify_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
378
+ end
379
+ return data, status_code, headers
380
+ end
381
+
382
+ # List member challenges
383
+ # 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.
384
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
385
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
386
+ # @param [Hash] opts the optional parameters
387
+ # @option opts [Integer] :page Results are paginated. Specify current page.
388
+ # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
389
+ # @return [ChallengesResponseBody]
390
+ def list_member_challenges(member_guid, user_guid, opts = {})
391
+ data, _status_code, _headers = list_member_challenges_with_http_info(member_guid, user_guid, opts)
392
+ data
393
+ end
394
+
395
+ # List member challenges
396
+ # 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 &#x60;CHALLENGED&#x60;, then code &#x60;204 No Content&#x60; will be returned. If the aggregation has been challenged, i.e., the member does have a connection status of &#x60;CHALLENGED&#x60;, then code &#x60;200 OK&#x60; will be returned - along with the corresponding credentials.
397
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
398
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
399
+ # @param [Hash] opts the optional parameters
400
+ # @option opts [Integer] :page Results are paginated. Specify current page.
401
+ # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
402
+ # @return [Array<(ChallengesResponseBody, Integer, Hash)>] ChallengesResponseBody data, response status code and response headers
403
+ def list_member_challenges_with_http_info(member_guid, user_guid, opts = {})
404
+ if @api_client.config.debugging
405
+ @api_client.config.logger.debug 'Calling API: MembersApi.list_member_challenges ...'
406
+ end
407
+ # verify the required parameter 'member_guid' is set
408
+ if @api_client.config.client_side_validation && member_guid.nil?
409
+ fail ArgumentError, "Missing the required parameter 'member_guid' when calling MembersApi.list_member_challenges"
410
+ end
411
+ # verify the required parameter 'user_guid' is set
412
+ if @api_client.config.client_side_validation && user_guid.nil?
413
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling MembersApi.list_member_challenges"
414
+ end
415
+ # resource path
416
+ local_var_path = '/users/{user_guid}/members/{member_guid}/challenges'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
417
+
418
+ # query parameters
419
+ query_params = opts[:query_params] || {}
420
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
421
+ query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
422
+
423
+ # header parameters
424
+ header_params = opts[:header_params] || {}
425
+ # HTTP header 'Accept' (if needed)
426
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
427
+
428
+ # form parameters
429
+ form_params = opts[:form_params] || {}
430
+
431
+ # http body (model)
432
+ post_body = opts[:debug_body]
433
+
434
+ # return_type
435
+ return_type = opts[:debug_return_type] || 'ChallengesResponseBody'
436
+
437
+ # auth_names
438
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
439
+
440
+ new_options = opts.merge(
441
+ :operation => :"MembersApi.list_member_challenges",
442
+ :header_params => header_params,
443
+ :query_params => query_params,
444
+ :form_params => form_params,
445
+ :body => post_body,
446
+ :auth_names => auth_names,
447
+ :return_type => return_type
448
+ )
449
+
450
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
451
+ if @api_client.config.debugging
452
+ @api_client.config.logger.debug "API called: MembersApi#list_member_challenges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
453
+ end
454
+ return data, status_code, headers
455
+ end
456
+
457
+ # List member credentials
458
+ # This endpoint returns an array which contains information on every non-MFA credential associated with a specific member.
459
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
460
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
461
+ # @param [Hash] opts the optional parameters
462
+ # @option opts [Integer] :page Results are paginated. Specify current page.
463
+ # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
464
+ # @return [CredentialsResponseBody]
465
+ def list_member_credentials(member_guid, user_guid, opts = {})
466
+ data, _status_code, _headers = list_member_credentials_with_http_info(member_guid, user_guid, opts)
467
+ data
468
+ end
469
+
470
+ # List member credentials
471
+ # This endpoint returns an array which contains information on every non-MFA credential associated with a specific member.
472
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
473
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
474
+ # @param [Hash] opts the optional parameters
475
+ # @option opts [Integer] :page Results are paginated. Specify current page.
476
+ # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
477
+ # @return [Array<(CredentialsResponseBody, Integer, Hash)>] CredentialsResponseBody data, response status code and response headers
478
+ def list_member_credentials_with_http_info(member_guid, user_guid, opts = {})
479
+ if @api_client.config.debugging
480
+ @api_client.config.logger.debug 'Calling API: MembersApi.list_member_credentials ...'
481
+ end
482
+ # verify the required parameter 'member_guid' is set
483
+ if @api_client.config.client_side_validation && member_guid.nil?
484
+ fail ArgumentError, "Missing the required parameter 'member_guid' when calling MembersApi.list_member_credentials"
485
+ end
486
+ # verify the required parameter 'user_guid' is set
487
+ if @api_client.config.client_side_validation && user_guid.nil?
488
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling MembersApi.list_member_credentials"
489
+ end
490
+ # resource path
491
+ local_var_path = '/users/{user_guid}/members/{member_guid}/credentials'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
492
+
493
+ # query parameters
494
+ query_params = opts[:query_params] || {}
495
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
496
+ query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
497
+
498
+ # header parameters
499
+ header_params = opts[:header_params] || {}
500
+ # HTTP header 'Accept' (if needed)
501
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
502
+
503
+ # form parameters
504
+ form_params = opts[:form_params] || {}
505
+
506
+ # http body (model)
507
+ post_body = opts[:debug_body]
508
+
509
+ # return_type
510
+ return_type = opts[:debug_return_type] || 'CredentialsResponseBody'
511
+
512
+ # auth_names
513
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
514
+
515
+ new_options = opts.merge(
516
+ :operation => :"MembersApi.list_member_credentials",
517
+ :header_params => header_params,
518
+ :query_params => query_params,
519
+ :form_params => form_params,
520
+ :body => post_body,
521
+ :auth_names => auth_names,
522
+ :return_type => return_type
523
+ )
524
+
525
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
526
+ if @api_client.config.debugging
527
+ @api_client.config.logger.debug "API called: MembersApi#list_member_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
528
+ end
529
+ return data, status_code, headers
530
+ end
531
+
532
+ # List members
533
+ # This endpoint returns an array which contains information on every member associated with a specific user.
534
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
535
+ # @param [Hash] opts the optional parameters
536
+ # @option opts [Integer] :page Results are paginated. Specify current page.
537
+ # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
538
+ # @option opts [String] :use_case The use case associated with the member. Valid values are &#x60;PFM&#x60; and &#x60;MONEY_MOVEMENT&#x60;. For example, you can append either &#x60;?use_case&#x3D;PFM&#x60; or &#x60;?use_case&#x3D;MONEY_MOVEMENT&#x60;.
539
+ # @return [MembersResponseBody]
540
+ def list_members(user_guid, opts = {})
541
+ data, _status_code, _headers = list_members_with_http_info(user_guid, opts)
542
+ data
543
+ end
544
+
545
+ # List members
546
+ # This endpoint returns an array which contains information on every member associated with a specific user.
547
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
548
+ # @param [Hash] opts the optional parameters
549
+ # @option opts [Integer] :page Results are paginated. Specify current page.
550
+ # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
551
+ # @option opts [String] :use_case The use case associated with the member. Valid values are &#x60;PFM&#x60; and &#x60;MONEY_MOVEMENT&#x60;. For example, you can append either &#x60;?use_case&#x3D;PFM&#x60; or &#x60;?use_case&#x3D;MONEY_MOVEMENT&#x60;.
552
+ # @return [Array<(MembersResponseBody, Integer, Hash)>] MembersResponseBody data, response status code and response headers
553
+ def list_members_with_http_info(user_guid, opts = {})
554
+ if @api_client.config.debugging
555
+ @api_client.config.logger.debug 'Calling API: MembersApi.list_members ...'
556
+ end
557
+ # verify the required parameter 'user_guid' is set
558
+ if @api_client.config.client_side_validation && user_guid.nil?
559
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling MembersApi.list_members"
560
+ end
561
+ # resource path
562
+ local_var_path = '/users/{user_guid}/members'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
563
+
564
+ # query parameters
565
+ query_params = opts[:query_params] || {}
566
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
567
+ query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
568
+ query_params[:'use_case'] = opts[:'use_case'] if !opts[:'use_case'].nil?
569
+
570
+ # header parameters
571
+ header_params = opts[:header_params] || {}
572
+ # HTTP header 'Accept' (if needed)
573
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
574
+
575
+ # form parameters
576
+ form_params = opts[:form_params] || {}
577
+
578
+ # http body (model)
579
+ post_body = opts[:debug_body]
580
+
581
+ # return_type
582
+ return_type = opts[:debug_return_type] || 'MembersResponseBody'
583
+
584
+ # auth_names
585
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
586
+
587
+ new_options = opts.merge(
588
+ :operation => :"MembersApi.list_members",
589
+ :header_params => header_params,
590
+ :query_params => query_params,
591
+ :form_params => form_params,
592
+ :body => post_body,
593
+ :auth_names => auth_names,
594
+ :return_type => return_type
595
+ )
596
+
597
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
598
+ if @api_client.config.debugging
599
+ @api_client.config.logger.debug "API called: MembersApi#list_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
600
+ end
601
+ return data, status_code, headers
602
+ end
603
+
604
+ # Read member
605
+ # Use this endpoint to read the attributes of a specific member.
606
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
607
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
608
+ # @param [Hash] opts the optional parameters
609
+ # @return [MemberResponseBody]
610
+ def read_member(member_guid, user_guid, opts = {})
611
+ data, _status_code, _headers = read_member_with_http_info(member_guid, user_guid, opts)
612
+ data
613
+ end
614
+
615
+ # Read member
616
+ # Use this endpoint to read the attributes of a specific member.
617
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
618
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
619
+ # @param [Hash] opts the optional parameters
620
+ # @return [Array<(MemberResponseBody, Integer, Hash)>] MemberResponseBody data, response status code and response headers
621
+ def read_member_with_http_info(member_guid, user_guid, opts = {})
622
+ if @api_client.config.debugging
623
+ @api_client.config.logger.debug 'Calling API: MembersApi.read_member ...'
624
+ end
625
+ # verify the required parameter 'member_guid' is set
626
+ if @api_client.config.client_side_validation && member_guid.nil?
627
+ fail ArgumentError, "Missing the required parameter 'member_guid' when calling MembersApi.read_member"
628
+ end
629
+ # verify the required parameter 'user_guid' is set
630
+ if @api_client.config.client_side_validation && user_guid.nil?
631
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling MembersApi.read_member"
632
+ end
633
+ # resource path
634
+ local_var_path = '/users/{user_guid}/members/{member_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
635
+
636
+ # query parameters
637
+ query_params = opts[:query_params] || {}
638
+
639
+ # header parameters
640
+ header_params = opts[:header_params] || {}
641
+ # HTTP header 'Accept' (if needed)
642
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
643
+
644
+ # form parameters
645
+ form_params = opts[:form_params] || {}
646
+
647
+ # http body (model)
648
+ post_body = opts[:debug_body]
649
+
650
+ # return_type
651
+ return_type = opts[:debug_return_type] || 'MemberResponseBody'
652
+
653
+ # auth_names
654
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
655
+
656
+ new_options = opts.merge(
657
+ :operation => :"MembersApi.read_member",
658
+ :header_params => header_params,
659
+ :query_params => query_params,
660
+ :form_params => form_params,
661
+ :body => post_body,
662
+ :auth_names => auth_names,
663
+ :return_type => return_type
664
+ )
665
+
666
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
667
+ if @api_client.config.debugging
668
+ @api_client.config.logger.debug "API called: MembersApi#read_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
669
+ end
670
+ return data, status_code, headers
671
+ end
672
+
673
+ # Read member status
674
+ # 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.
675
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
676
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
677
+ # @param [Hash] opts the optional parameters
678
+ # @return [MemberStatusResponseBody]
679
+ def read_member_status(member_guid, user_guid, opts = {})
680
+ data, _status_code, _headers = read_member_status_with_http_info(member_guid, user_guid, opts)
681
+ data
682
+ end
683
+
684
+ # Read member status
685
+ # 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.
686
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
687
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
688
+ # @param [Hash] opts the optional parameters
689
+ # @return [Array<(MemberStatusResponseBody, Integer, Hash)>] MemberStatusResponseBody data, response status code and response headers
690
+ def read_member_status_with_http_info(member_guid, user_guid, opts = {})
691
+ if @api_client.config.debugging
692
+ @api_client.config.logger.debug 'Calling API: MembersApi.read_member_status ...'
693
+ end
694
+ # verify the required parameter 'member_guid' is set
695
+ if @api_client.config.client_side_validation && member_guid.nil?
696
+ fail ArgumentError, "Missing the required parameter 'member_guid' when calling MembersApi.read_member_status"
697
+ end
698
+ # verify the required parameter 'user_guid' is set
699
+ if @api_client.config.client_side_validation && user_guid.nil?
700
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling MembersApi.read_member_status"
701
+ end
702
+ # resource path
703
+ local_var_path = '/users/{user_guid}/members/{member_guid}/status'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
704
+
705
+ # query parameters
706
+ query_params = opts[:query_params] || {}
707
+
708
+ # header parameters
709
+ header_params = opts[:header_params] || {}
710
+ # HTTP header 'Accept' (if needed)
711
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
712
+
713
+ # form parameters
714
+ form_params = opts[:form_params] || {}
715
+
716
+ # http body (model)
717
+ post_body = opts[:debug_body]
718
+
719
+ # return_type
720
+ return_type = opts[:debug_return_type] || 'MemberStatusResponseBody'
721
+
722
+ # auth_names
723
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
724
+
725
+ new_options = opts.merge(
726
+ :operation => :"MembersApi.read_member_status",
727
+ :header_params => header_params,
728
+ :query_params => query_params,
729
+ :form_params => form_params,
730
+ :body => post_body,
731
+ :auth_names => auth_names,
732
+ :return_type => return_type
733
+ )
734
+
735
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
736
+ if @api_client.config.debugging
737
+ @api_client.config.logger.debug "API called: MembersApi#read_member_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
738
+ end
739
+ return data, status_code, headers
740
+ end
741
+
742
+ # Resume aggregation
743
+ # This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.
744
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
745
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
746
+ # @param member_resume_request_body [MemberResumeRequestBody] Member object with MFA challenge answers
747
+ # @param [Hash] opts the optional parameters
748
+ # @return [MemberResponseBody]
749
+ def resume_aggregation(member_guid, user_guid, member_resume_request_body, opts = {})
750
+ data, _status_code, _headers = resume_aggregation_with_http_info(member_guid, user_guid, member_resume_request_body, opts)
751
+ data
752
+ end
753
+
754
+ # Resume aggregation
755
+ # This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.
756
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
757
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
758
+ # @param member_resume_request_body [MemberResumeRequestBody] Member object with MFA challenge answers
759
+ # @param [Hash] opts the optional parameters
760
+ # @return [Array<(MemberResponseBody, Integer, Hash)>] MemberResponseBody data, response status code and response headers
761
+ def resume_aggregation_with_http_info(member_guid, user_guid, member_resume_request_body, opts = {})
762
+ if @api_client.config.debugging
763
+ @api_client.config.logger.debug 'Calling API: MembersApi.resume_aggregation ...'
764
+ end
765
+ # verify the required parameter 'member_guid' is set
766
+ if @api_client.config.client_side_validation && member_guid.nil?
767
+ fail ArgumentError, "Missing the required parameter 'member_guid' when calling MembersApi.resume_aggregation"
768
+ end
769
+ # verify the required parameter 'user_guid' is set
770
+ if @api_client.config.client_side_validation && user_guid.nil?
771
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling MembersApi.resume_aggregation"
772
+ end
773
+ # verify the required parameter 'member_resume_request_body' is set
774
+ if @api_client.config.client_side_validation && member_resume_request_body.nil?
775
+ fail ArgumentError, "Missing the required parameter 'member_resume_request_body' when calling MembersApi.resume_aggregation"
776
+ end
777
+ # resource path
778
+ local_var_path = '/users/{user_guid}/members/{member_guid}/resume'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
779
+
780
+ # query parameters
781
+ query_params = opts[:query_params] || {}
782
+
783
+ # header parameters
784
+ header_params = opts[:header_params] || {}
785
+ # HTTP header 'Accept' (if needed)
786
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
787
+ # HTTP header 'Content-Type'
788
+ content_type = @api_client.select_header_content_type(['application/json'])
789
+ if !content_type.nil?
790
+ header_params['Content-Type'] = content_type
791
+ end
792
+
793
+ # form parameters
794
+ form_params = opts[:form_params] || {}
795
+
796
+ # http body (model)
797
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(member_resume_request_body)
798
+
799
+ # return_type
800
+ return_type = opts[:debug_return_type] || 'MemberResponseBody'
801
+
802
+ # auth_names
803
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
804
+
805
+ new_options = opts.merge(
806
+ :operation => :"MembersApi.resume_aggregation",
807
+ :header_params => header_params,
808
+ :query_params => query_params,
809
+ :form_params => form_params,
810
+ :body => post_body,
811
+ :auth_names => auth_names,
812
+ :return_type => return_type
813
+ )
814
+
815
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
816
+ if @api_client.config.debugging
817
+ @api_client.config.logger.debug "API called: MembersApi#resume_aggregation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
818
+ end
819
+ return data, status_code, headers
820
+ end
821
+
822
+ # Update member
823
+ # 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.
824
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
825
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
826
+ # @param member_update_request_body [MemberUpdateRequestBody] Member object to be updated (While no single parameter is required, the request body can&#39;t be empty)
827
+ # @param [Hash] opts the optional parameters
828
+ # @option opts [String] :x_callback_payload The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.
829
+ # @return [MemberResponseBody]
830
+ def update_member(member_guid, user_guid, member_update_request_body, opts = {})
831
+ data, _status_code, _headers = update_member_with_http_info(member_guid, user_guid, member_update_request_body, opts)
832
+ data
833
+ end
834
+
835
+ # Update member
836
+ # 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.
837
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
838
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
839
+ # @param member_update_request_body [MemberUpdateRequestBody] Member object to be updated (While no single parameter is required, the request body can&#39;t be empty)
840
+ # @param [Hash] opts the optional parameters
841
+ # @option opts [String] :x_callback_payload The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.
842
+ # @return [Array<(MemberResponseBody, Integer, Hash)>] MemberResponseBody data, response status code and response headers
843
+ def update_member_with_http_info(member_guid, user_guid, member_update_request_body, opts = {})
844
+ if @api_client.config.debugging
845
+ @api_client.config.logger.debug 'Calling API: MembersApi.update_member ...'
846
+ end
847
+ # verify the required parameter 'member_guid' is set
848
+ if @api_client.config.client_side_validation && member_guid.nil?
849
+ fail ArgumentError, "Missing the required parameter 'member_guid' when calling MembersApi.update_member"
850
+ end
851
+ # verify the required parameter 'user_guid' is set
852
+ if @api_client.config.client_side_validation && user_guid.nil?
853
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling MembersApi.update_member"
854
+ end
855
+ # verify the required parameter 'member_update_request_body' is set
856
+ if @api_client.config.client_side_validation && member_update_request_body.nil?
857
+ fail ArgumentError, "Missing the required parameter 'member_update_request_body' when calling MembersApi.update_member"
858
+ end
859
+ # resource path
860
+ local_var_path = '/users/{user_guid}/members/{member_guid}'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
861
+
862
+ # query parameters
863
+ query_params = opts[:query_params] || {}
864
+
865
+ # header parameters
866
+ header_params = opts[:header_params] || {}
867
+ # HTTP header 'Accept' (if needed)
868
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
869
+ # HTTP header 'Content-Type'
870
+ content_type = @api_client.select_header_content_type(['application/json'])
871
+ if !content_type.nil?
872
+ header_params['Content-Type'] = content_type
873
+ end
874
+ header_params[:'X-CALLBACK-PAYLOAD'] = opts[:'x_callback_payload'] if !opts[:'x_callback_payload'].nil?
875
+
876
+ # form parameters
877
+ form_params = opts[:form_params] || {}
878
+
879
+ # http body (model)
880
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(member_update_request_body)
881
+
882
+ # return_type
883
+ return_type = opts[:debug_return_type] || 'MemberResponseBody'
884
+
885
+ # auth_names
886
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
887
+
888
+ new_options = opts.merge(
889
+ :operation => :"MembersApi.update_member",
890
+ :header_params => header_params,
891
+ :query_params => query_params,
892
+ :form_params => form_params,
893
+ :body => post_body,
894
+ :auth_names => auth_names,
895
+ :return_type => return_type
896
+ )
897
+
898
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
899
+ if @api_client.config.debugging
900
+ @api_client.config.logger.debug "API called: MembersApi#update_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
901
+ end
902
+ return data, status_code, headers
903
+ end
904
+
905
+ # Verify member
906
+ # The verify endpoint begins a verification process for a member.
907
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
908
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
909
+ # @param [Hash] opts the optional parameters
910
+ # @option opts [String] :x_callback_payload The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.
911
+ # @return [MemberResponseBody]
912
+ def verify_member(member_guid, user_guid, opts = {})
913
+ data, _status_code, _headers = verify_member_with_http_info(member_guid, user_guid, opts)
914
+ data
915
+ end
916
+
917
+ # Verify member
918
+ # The verify endpoint begins a verification process for a member.
919
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
920
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
921
+ # @param [Hash] opts the optional parameters
922
+ # @option opts [String] :x_callback_payload The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.
923
+ # @return [Array<(MemberResponseBody, Integer, Hash)>] MemberResponseBody data, response status code and response headers
924
+ def verify_member_with_http_info(member_guid, user_guid, opts = {})
925
+ if @api_client.config.debugging
926
+ @api_client.config.logger.debug 'Calling API: MembersApi.verify_member ...'
927
+ end
928
+ # verify the required parameter 'member_guid' is set
929
+ if @api_client.config.client_side_validation && member_guid.nil?
930
+ fail ArgumentError, "Missing the required parameter 'member_guid' when calling MembersApi.verify_member"
931
+ end
932
+ # verify the required parameter 'user_guid' is set
933
+ if @api_client.config.client_side_validation && user_guid.nil?
934
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling MembersApi.verify_member"
935
+ end
936
+ # resource path
937
+ local_var_path = '/users/{user_guid}/members/{member_guid}/verify'.sub('{' + 'member_guid' + '}', CGI.escape(member_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
938
+
939
+ # query parameters
940
+ query_params = opts[:query_params] || {}
941
+
942
+ # header parameters
943
+ header_params = opts[:header_params] || {}
944
+ # HTTP header 'Accept' (if needed)
945
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
946
+ header_params[:'X-CALLBACK-PAYLOAD'] = opts[:'x_callback_payload'] if !opts[:'x_callback_payload'].nil?
947
+
948
+ # form parameters
949
+ form_params = opts[:form_params] || {}
950
+
951
+ # http body (model)
952
+ post_body = opts[:debug_body]
953
+
954
+ # return_type
955
+ return_type = opts[:debug_return_type] || 'MemberResponseBody'
956
+
957
+ # auth_names
958
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
959
+
960
+ new_options = opts.merge(
961
+ :operation => :"MembersApi.verify_member",
962
+ :header_params => header_params,
963
+ :query_params => query_params,
964
+ :form_params => form_params,
965
+ :body => post_body,
966
+ :auth_names => auth_names,
967
+ :return_type => return_type
968
+ )
969
+
970
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
971
+ if @api_client.config.debugging
972
+ @api_client.config.logger.debug "API called: MembersApi#verify_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
973
+ end
974
+ return data, status_code, headers
975
+ end
976
+ end
977
+ end