mx-platform-ruby 0.4.2 → 0.6.2

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 (251) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +6 -6
  3. data/README.md +4 -6
  4. data/docs/AccountResponse.md +15 -1
  5. data/docs/ManagedAccountCreateRequest.md +78 -0
  6. data/docs/ManagedAccountCreateRequestBody.md +18 -0
  7. data/docs/ManagedAccountUpdateRequest.md +78 -0
  8. data/docs/ManagedAccountUpdateRequestBody.md +18 -0
  9. data/docs/ManagedMemberCreateRequest.md +24 -0
  10. data/docs/ManagedMemberCreateRequestBody.md +18 -0
  11. data/docs/ManagedMemberUpdateRequest.md +22 -0
  12. data/docs/ManagedMemberUpdateRequestBody.md +18 -0
  13. data/docs/ManagedTransactionCreateRequest.md +56 -0
  14. data/docs/ManagedTransactionCreateRequestBody.md +18 -0
  15. data/docs/ManagedTransactionUpdateRequest.md +56 -0
  16. data/docs/ManagedTransactionUpdateRequestBody.md +18 -0
  17. data/docs/MemberResponse.md +5 -1
  18. data/docs/MerchantLocationResponse.md +40 -0
  19. data/docs/MerchantLocationResponseBody.md +18 -0
  20. data/docs/MxPlatformApi.md +1415 -117
  21. data/docs/TransactionResponse.md +11 -1
  22. data/lib/mx-platform-ruby/api/mx_platform_api.rb +1474 -124
  23. data/lib/mx-platform-ruby/api_client.rb +7 -9
  24. data/lib/mx-platform-ruby/api_error.rb +1 -1
  25. data/lib/mx-platform-ruby/configuration.rb +35 -2
  26. data/lib/mx-platform-ruby/models/account_number_response.rb +5 -1
  27. data/lib/mx-platform-ruby/models/account_numbers_response_body.rb +1 -1
  28. data/lib/mx-platform-ruby/models/account_owner_response.rb +9 -1
  29. data/lib/mx-platform-ruby/models/account_owners_response_body.rb +1 -1
  30. data/lib/mx-platform-ruby/models/account_response.rb +112 -5
  31. data/lib/mx-platform-ruby/models/account_response_body.rb +1 -1
  32. data/lib/mx-platform-ruby/models/account_update_request.rb +1 -1
  33. data/lib/mx-platform-ruby/models/account_update_request_body.rb +1 -1
  34. data/lib/mx-platform-ruby/models/accounts_response_body.rb +1 -1
  35. data/lib/mx-platform-ruby/models/categories_response_body.rb +1 -1
  36. data/lib/mx-platform-ruby/models/category_create_request.rb +1 -1
  37. data/lib/mx-platform-ruby/models/category_create_request_body.rb +1 -1
  38. data/lib/mx-platform-ruby/models/category_response.rb +7 -1
  39. data/lib/mx-platform-ruby/models/category_response_body.rb +1 -1
  40. data/lib/mx-platform-ruby/models/category_update_request.rb +1 -1
  41. data/lib/mx-platform-ruby/models/category_update_request_body.rb +1 -1
  42. data/lib/mx-platform-ruby/models/challenge_response.rb +5 -1
  43. data/lib/mx-platform-ruby/models/challenges_response_body.rb +1 -1
  44. data/lib/mx-platform-ruby/models/connect_widget_request.rb +1 -1
  45. data/lib/mx-platform-ruby/models/connect_widget_request_body.rb +1 -1
  46. data/lib/mx-platform-ruby/models/connect_widget_response.rb +2 -1
  47. data/lib/mx-platform-ruby/models/connect_widget_response_body.rb +1 -1
  48. data/lib/mx-platform-ruby/models/credential_request.rb +2 -1
  49. data/lib/mx-platform-ruby/models/credential_response.rb +4 -1
  50. data/lib/mx-platform-ruby/models/credentials_response_body.rb +1 -1
  51. data/lib/mx-platform-ruby/models/enhance_transaction_response.rb +16 -1
  52. data/lib/mx-platform-ruby/models/enhance_transactions_request.rb +1 -1
  53. data/lib/mx-platform-ruby/models/enhance_transactions_request_body.rb +1 -1
  54. data/lib/mx-platform-ruby/models/enhance_transactions_response_body.rb +1 -1
  55. data/lib/mx-platform-ruby/models/holding_response.rb +15 -1
  56. data/lib/mx-platform-ruby/models/holding_response_body.rb +1 -1
  57. data/lib/mx-platform-ruby/models/holdings_response_body.rb +1 -1
  58. data/lib/mx-platform-ruby/models/image_option_response.rb +4 -1
  59. data/lib/mx-platform-ruby/models/institution_response.rb +11 -1
  60. data/lib/mx-platform-ruby/models/institution_response_body.rb +1 -1
  61. data/lib/mx-platform-ruby/models/institutions_response_body.rb +1 -1
  62. data/lib/mx-platform-ruby/models/managed_account_create_request.rb +503 -0
  63. data/lib/mx-platform-ruby/models/managed_account_create_request_body.rb +218 -0
  64. data/lib/mx-platform-ruby/models/managed_account_update_request.rb +488 -0
  65. data/lib/mx-platform-ruby/models/managed_account_update_request_body.rb +218 -0
  66. data/lib/mx-platform-ruby/models/managed_member_create_request.rb +250 -0
  67. data/lib/mx-platform-ruby/models/managed_member_create_request_body.rb +218 -0
  68. data/lib/mx-platform-ruby/models/managed_member_update_request.rb +236 -0
  69. data/lib/mx-platform-ruby/models/managed_member_update_request_body.rb +218 -0
  70. data/lib/mx-platform-ruby/models/managed_transaction_create_request.rb +414 -0
  71. data/lib/mx-platform-ruby/models/managed_transaction_create_request_body.rb +218 -0
  72. data/lib/mx-platform-ruby/models/managed_transaction_update_request.rb +389 -0
  73. data/lib/mx-platform-ruby/models/managed_transaction_update_request_body.rb +218 -0
  74. data/lib/mx-platform-ruby/models/member_create_request.rb +1 -1
  75. data/lib/mx-platform-ruby/models/member_create_request_body.rb +1 -1
  76. data/lib/mx-platform-ruby/models/member_response.rb +35 -5
  77. data/lib/mx-platform-ruby/models/member_response_body.rb +1 -1
  78. data/lib/mx-platform-ruby/models/member_resume_request.rb +1 -1
  79. data/lib/mx-platform-ruby/models/member_resume_request_body.rb +1 -1
  80. data/lib/mx-platform-ruby/models/member_status_response.rb +8 -1
  81. data/lib/mx-platform-ruby/models/member_status_response_body.rb +1 -1
  82. data/lib/mx-platform-ruby/models/member_update_request.rb +1 -1
  83. data/lib/mx-platform-ruby/models/member_update_request_body.rb +1 -1
  84. data/lib/mx-platform-ruby/models/members_response_body.rb +1 -1
  85. data/lib/mx-platform-ruby/models/merchant_location_response.rb +327 -0
  86. data/lib/mx-platform-ruby/models/merchant_location_response_body.rb +218 -0
  87. data/lib/mx-platform-ruby/models/merchant_response.rb +6 -1
  88. data/lib/mx-platform-ruby/models/merchant_response_body.rb +1 -1
  89. data/lib/mx-platform-ruby/models/merchants_response_body.rb +1 -1
  90. data/lib/mx-platform-ruby/models/o_auth_window_response.rb +2 -1
  91. data/lib/mx-platform-ruby/models/o_auth_window_response_body.rb +1 -1
  92. data/lib/mx-platform-ruby/models/option_response.rb +3 -1
  93. data/lib/mx-platform-ruby/models/pagination_response.rb +1 -1
  94. data/lib/mx-platform-ruby/models/statement_response.rb +5 -1
  95. data/lib/mx-platform-ruby/models/statement_response_body.rb +1 -1
  96. data/lib/mx-platform-ruby/models/statements_response_body.rb +1 -1
  97. data/lib/mx-platform-ruby/models/tag_create_request.rb +1 -1
  98. data/lib/mx-platform-ruby/models/tag_create_request_body.rb +1 -1
  99. data/lib/mx-platform-ruby/models/tag_response.rb +2 -1
  100. data/lib/mx-platform-ruby/models/tag_response_body.rb +1 -1
  101. data/lib/mx-platform-ruby/models/tag_update_request.rb +1 -1
  102. data/lib/mx-platform-ruby/models/tag_update_request_body.rb +1 -1
  103. data/lib/mx-platform-ruby/models/tagging_create_request.rb +1 -1
  104. data/lib/mx-platform-ruby/models/tagging_create_request_body.rb +1 -1
  105. data/lib/mx-platform-ruby/models/tagging_response.rb +2 -1
  106. data/lib/mx-platform-ruby/models/tagging_response_body.rb +1 -1
  107. data/lib/mx-platform-ruby/models/tagging_update_request.rb +1 -1
  108. data/lib/mx-platform-ruby/models/tagging_update_request_body.rb +1 -1
  109. data/lib/mx-platform-ruby/models/taggings_response_body.rb +1 -1
  110. data/lib/mx-platform-ruby/models/tags_response_body.rb +1 -1
  111. data/lib/mx-platform-ruby/models/transaction_response.rb +85 -5
  112. data/lib/mx-platform-ruby/models/transaction_response_body.rb +1 -1
  113. data/lib/mx-platform-ruby/models/transaction_rule_create_request.rb +1 -1
  114. data/lib/mx-platform-ruby/models/transaction_rule_create_request_body.rb +1 -1
  115. data/lib/mx-platform-ruby/models/transaction_rule_response.rb +5 -1
  116. data/lib/mx-platform-ruby/models/transaction_rule_response_body.rb +1 -1
  117. data/lib/mx-platform-ruby/models/transaction_rule_update_request.rb +3 -1
  118. data/lib/mx-platform-ruby/models/transaction_rule_update_request_body.rb +1 -1
  119. data/lib/mx-platform-ruby/models/transaction_rules_response_body.rb +1 -1
  120. data/lib/mx-platform-ruby/models/transaction_update_request.rb +1 -1
  121. data/lib/mx-platform-ruby/models/transaction_update_request_body.rb +1 -1
  122. data/lib/mx-platform-ruby/models/transactions_response_body.rb +1 -1
  123. data/lib/mx-platform-ruby/models/user_create_request.rb +1 -1
  124. data/lib/mx-platform-ruby/models/user_create_request_body.rb +1 -1
  125. data/lib/mx-platform-ruby/models/user_response.rb +5 -1
  126. data/lib/mx-platform-ruby/models/user_response_body.rb +1 -1
  127. data/lib/mx-platform-ruby/models/user_update_request.rb +1 -1
  128. data/lib/mx-platform-ruby/models/user_update_request_body.rb +1 -1
  129. data/lib/mx-platform-ruby/models/users_response_body.rb +1 -1
  130. data/lib/mx-platform-ruby/models/widget_request.rb +1 -1
  131. data/lib/mx-platform-ruby/models/widget_request_body.rb +1 -1
  132. data/lib/mx-platform-ruby/models/widget_response.rb +4 -1
  133. data/lib/mx-platform-ruby/models/widget_response_body.rb +1 -1
  134. data/lib/mx-platform-ruby/version.rb +2 -2
  135. data/lib/mx-platform-ruby.rb +15 -1
  136. data/mx-platform-ruby.gemspec +1 -1
  137. data/openapi/config.yml +1 -1
  138. data/openapi/templates/README.mustache +4 -6
  139. data/spec/api/mx_platform_api_spec.rb +246 -1
  140. data/spec/api_client_spec.rb +3 -3
  141. data/spec/configuration_spec.rb +1 -1
  142. data/spec/models/account_number_response_spec.rb +1 -1
  143. data/spec/models/account_numbers_response_body_spec.rb +1 -1
  144. data/spec/models/account_owner_response_spec.rb +1 -1
  145. data/spec/models/account_owners_response_body_spec.rb +1 -1
  146. data/spec/models/account_response_body_spec.rb +1 -1
  147. data/spec/models/account_response_spec.rb +43 -1
  148. data/spec/models/account_update_request_body_spec.rb +1 -1
  149. data/spec/models/account_update_request_spec.rb +1 -1
  150. data/spec/models/accounts_response_body_spec.rb +1 -1
  151. data/spec/models/categories_response_body_spec.rb +1 -1
  152. data/spec/models/category_create_request_body_spec.rb +1 -1
  153. data/spec/models/category_create_request_spec.rb +1 -1
  154. data/spec/models/category_response_body_spec.rb +1 -1
  155. data/spec/models/category_response_spec.rb +1 -1
  156. data/spec/models/category_update_request_body_spec.rb +1 -1
  157. data/spec/models/category_update_request_spec.rb +1 -1
  158. data/spec/models/challenge_response_spec.rb +1 -1
  159. data/spec/models/challenges_response_body_spec.rb +1 -1
  160. data/spec/models/connect_widget_request_body_spec.rb +1 -1
  161. data/spec/models/connect_widget_request_spec.rb +1 -1
  162. data/spec/models/connect_widget_response_body_spec.rb +1 -1
  163. data/spec/models/connect_widget_response_spec.rb +1 -1
  164. data/spec/models/credential_request_spec.rb +1 -1
  165. data/spec/models/credential_response_spec.rb +1 -1
  166. data/spec/models/credentials_response_body_spec.rb +1 -1
  167. data/spec/models/enhance_transaction_response_spec.rb +1 -1
  168. data/spec/models/enhance_transactions_request_body_spec.rb +1 -1
  169. data/spec/models/enhance_transactions_request_spec.rb +1 -1
  170. data/spec/models/enhance_transactions_response_body_spec.rb +1 -1
  171. data/spec/models/holding_response_body_spec.rb +1 -1
  172. data/spec/models/holding_response_spec.rb +1 -1
  173. data/spec/models/holdings_response_body_spec.rb +1 -1
  174. data/spec/models/image_option_response_spec.rb +1 -1
  175. data/spec/models/institution_response_body_spec.rb +1 -1
  176. data/spec/models/institution_response_spec.rb +1 -1
  177. data/spec/models/institutions_response_body_spec.rb +1 -1
  178. data/spec/models/managed_account_create_request_body_spec.rb +34 -0
  179. data/spec/models/managed_account_create_request_spec.rb +214 -0
  180. data/spec/models/managed_account_update_request_body_spec.rb +34 -0
  181. data/spec/models/managed_account_update_request_spec.rb +214 -0
  182. data/spec/models/managed_member_create_request_body_spec.rb +34 -0
  183. data/spec/models/managed_member_create_request_spec.rb +52 -0
  184. data/spec/models/managed_member_update_request_body_spec.rb +34 -0
  185. data/spec/models/managed_member_update_request_spec.rb +46 -0
  186. data/spec/models/managed_transaction_create_request_body_spec.rb +34 -0
  187. data/spec/models/managed_transaction_create_request_spec.rb +148 -0
  188. data/spec/models/managed_transaction_update_request_body_spec.rb +34 -0
  189. data/spec/models/managed_transaction_update_request_spec.rb +148 -0
  190. data/spec/models/member_create_request_body_spec.rb +1 -1
  191. data/spec/models/member_create_request_spec.rb +1 -1
  192. data/spec/models/member_response_body_spec.rb +1 -1
  193. data/spec/models/member_response_spec.rb +13 -1
  194. data/spec/models/member_resume_request_body_spec.rb +1 -1
  195. data/spec/models/member_resume_request_spec.rb +1 -1
  196. data/spec/models/member_status_response_body_spec.rb +1 -1
  197. data/spec/models/member_status_response_spec.rb +1 -1
  198. data/spec/models/member_update_request_body_spec.rb +1 -1
  199. data/spec/models/member_update_request_spec.rb +1 -1
  200. data/spec/models/members_response_body_spec.rb +1 -1
  201. data/spec/models/merchant_location_response_body_spec.rb +34 -0
  202. data/spec/models/merchant_location_response_spec.rb +100 -0
  203. data/spec/models/merchant_response_body_spec.rb +1 -1
  204. data/spec/models/merchant_response_spec.rb +1 -1
  205. data/spec/models/merchants_response_body_spec.rb +1 -1
  206. data/spec/models/o_auth_window_response_body_spec.rb +1 -1
  207. data/spec/models/o_auth_window_response_spec.rb +1 -1
  208. data/spec/models/option_response_spec.rb +1 -1
  209. data/spec/models/pagination_response_spec.rb +1 -1
  210. data/spec/models/statement_response_body_spec.rb +1 -1
  211. data/spec/models/statement_response_spec.rb +1 -1
  212. data/spec/models/statements_response_body_spec.rb +1 -1
  213. data/spec/models/tag_create_request_body_spec.rb +1 -1
  214. data/spec/models/tag_create_request_spec.rb +1 -1
  215. data/spec/models/tag_response_body_spec.rb +1 -1
  216. data/spec/models/tag_response_spec.rb +1 -1
  217. data/spec/models/tag_update_request_body_spec.rb +1 -1
  218. data/spec/models/tag_update_request_spec.rb +1 -1
  219. data/spec/models/tagging_create_request_body_spec.rb +1 -1
  220. data/spec/models/tagging_create_request_spec.rb +1 -1
  221. data/spec/models/tagging_response_body_spec.rb +1 -1
  222. data/spec/models/tagging_response_spec.rb +1 -1
  223. data/spec/models/tagging_update_request_body_spec.rb +1 -1
  224. data/spec/models/tagging_update_request_spec.rb +1 -1
  225. data/spec/models/taggings_response_body_spec.rb +1 -1
  226. data/spec/models/tags_response_body_spec.rb +1 -1
  227. data/spec/models/transaction_response_body_spec.rb +1 -1
  228. data/spec/models/transaction_response_spec.rb +31 -1
  229. data/spec/models/transaction_rule_create_request_body_spec.rb +1 -1
  230. data/spec/models/transaction_rule_create_request_spec.rb +1 -1
  231. data/spec/models/transaction_rule_response_body_spec.rb +1 -1
  232. data/spec/models/transaction_rule_response_spec.rb +1 -1
  233. data/spec/models/transaction_rule_update_request_body_spec.rb +1 -1
  234. data/spec/models/transaction_rule_update_request_spec.rb +1 -1
  235. data/spec/models/transaction_rules_response_body_spec.rb +1 -1
  236. data/spec/models/transaction_update_request_body_spec.rb +1 -1
  237. data/spec/models/transaction_update_request_spec.rb +1 -1
  238. data/spec/models/transactions_response_body_spec.rb +1 -1
  239. data/spec/models/user_create_request_body_spec.rb +1 -1
  240. data/spec/models/user_create_request_spec.rb +1 -1
  241. data/spec/models/user_response_body_spec.rb +1 -1
  242. data/spec/models/user_response_spec.rb +1 -1
  243. data/spec/models/user_update_request_body_spec.rb +1 -1
  244. data/spec/models/user_update_request_spec.rb +1 -1
  245. data/spec/models/users_response_body_spec.rb +1 -1
  246. data/spec/models/widget_request_body_spec.rb +1 -1
  247. data/spec/models/widget_request_spec.rb +1 -1
  248. data/spec/models/widget_response_body_spec.rb +1 -1
  249. data/spec/models/widget_response_spec.rb +1 -1
  250. data/spec/spec_helper.rb +1 -1
  251. metadata +134 -78
@@ -7,12 +7,18 @@ All URIs are relative to *https://api.mx.com*
7
7
  | [**aggregate_member**](MxPlatformApi.md#aggregate_member) | **POST** /users/{user_guid}/members/{member_guid}/aggregate | Aggregate member |
8
8
  | [**check_balances**](MxPlatformApi.md#check_balances) | **POST** /users/{user_guid}/members/{member_guid}/check_balance | Check balances |
9
9
  | [**create_category**](MxPlatformApi.md#create_category) | **POST** /users/{user_guid}/categories | Create category |
10
+ | [**create_managed_account**](MxPlatformApi.md#create_managed_account) | **POST** /users/{user_guid}/managed_members/{member_guid}/accounts | Create managed account |
11
+ | [**create_managed_member**](MxPlatformApi.md#create_managed_member) | **POST** /users/{user_guid}/managed_members | Create managed member |
12
+ | [**create_managed_transaction**](MxPlatformApi.md#create_managed_transaction) | **POST** /users/{user_guid}/managed_members/{member_guid}/transactions | Create managed transaction |
10
13
  | [**create_member**](MxPlatformApi.md#create_member) | **POST** /users/{user_guid}/members | Create member |
11
14
  | [**create_tag**](MxPlatformApi.md#create_tag) | **POST** /users/{user_guid}/tags | Create tag |
12
15
  | [**create_tagging**](MxPlatformApi.md#create_tagging) | **POST** /users/{user_guid}/taggings | Create tagging |
13
16
  | [**create_transaction_rule**](MxPlatformApi.md#create_transaction_rule) | **POST** /users/{user_guid}/transaction_rules | Create transaction rule |
14
17
  | [**create_user**](MxPlatformApi.md#create_user) | **POST** /users | Create user |
15
18
  | [**delete_category**](MxPlatformApi.md#delete_category) | **DELETE** /users/{user_guid}/categories/{category_guid} | Delete category |
19
+ | [**delete_managed_account**](MxPlatformApi.md#delete_managed_account) | **DELETE** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Delete managed account |
20
+ | [**delete_managed_member**](MxPlatformApi.md#delete_managed_member) | **DELETE** /users/{user_guid}/managed_members/{member_guid} | Delete managed member |
21
+ | [**delete_managed_transaction**](MxPlatformApi.md#delete_managed_transaction) | **DELETE** /users/{user_guid}/managed_members/{member_guid}/transactions/{transaction_guid} | Delete managed transaction |
16
22
  | [**delete_member**](MxPlatformApi.md#delete_member) | **DELETE** /users/{user_guid}/members/{member_guid} | Delete member |
17
23
  | [**delete_tag**](MxPlatformApi.md#delete_tag) | **DELETE** /users/{user_guid}/tags/{tag_guid} | Delete tag |
18
24
  | [**delete_tagging**](MxPlatformApi.md#delete_tagging) | **DELETE** /users/{user_guid}/taggings/{tagging_guid} | Delete tagging |
@@ -33,6 +39,10 @@ All URIs are relative to *https://api.mx.com*
33
39
  | [**list_holdings_by_member**](MxPlatformApi.md#list_holdings_by_member) | **GET** /users/{user_guid}/members/{member_guid}/holdings | List holdings by member |
34
40
  | [**list_institution_credentials**](MxPlatformApi.md#list_institution_credentials) | **GET** /institutions/{institution_code}/credentials | List institution credentials |
35
41
  | [**list_institutions**](MxPlatformApi.md#list_institutions) | **GET** /institutions | List institutions |
42
+ | [**list_managed_accounts**](MxPlatformApi.md#list_managed_accounts) | **GET** /users/{user_guid}/managed_members/{member_guid}/accounts | List managed accounts |
43
+ | [**list_managed_institutions**](MxPlatformApi.md#list_managed_institutions) | **GET** /managed_institutions | List managed institutions |
44
+ | [**list_managed_members**](MxPlatformApi.md#list_managed_members) | **GET** /users/{user_guid}/managed_members | List managed members |
45
+ | [**list_managed_transactions**](MxPlatformApi.md#list_managed_transactions) | **GET** /users/{user_guid}/managed_members/{member_guid}/transactions | List managed transactions |
36
46
  | [**list_member_challenges**](MxPlatformApi.md#list_member_challenges) | **GET** /users/{user_guid}/members/{member_guid}/challenges | List member challenges |
37
47
  | [**list_member_credentials**](MxPlatformApi.md#list_member_credentials) | **GET** /users/{user_guid}/members/{member_guid}/credentials | List member credentials |
38
48
  | [**list_members**](MxPlatformApi.md#list_members) | **GET** /users/{user_guid}/members | List members |
@@ -51,9 +61,13 @@ All URIs are relative to *https://api.mx.com*
51
61
  | [**read_category**](MxPlatformApi.md#read_category) | **GET** /users/{user_guid}/categories/{category_guid} | Read category |
52
62
  | [**read_holding**](MxPlatformApi.md#read_holding) | **GET** /users/{user_guid}/holdings/{holding_guid} | Read holding |
53
63
  | [**read_institution**](MxPlatformApi.md#read_institution) | **GET** /institutions/{institution_code} | Read institution |
64
+ | [**read_managed_account**](MxPlatformApi.md#read_managed_account) | **GET** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Read managed account |
65
+ | [**read_managed_member**](MxPlatformApi.md#read_managed_member) | **GET** /users/{user_guid}/managed_members/{member_guid} | Read managed member |
66
+ | [**read_managed_transaction**](MxPlatformApi.md#read_managed_transaction) | **GET** /users/{user_guid}/managed_members/{member_guid}/transactions/{transaction_guid} | Read managed transaction |
54
67
  | [**read_member**](MxPlatformApi.md#read_member) | **GET** /users/{user_guid}/members/{member_guid} | Read member |
55
68
  | [**read_member_status**](MxPlatformApi.md#read_member_status) | **GET** /users/{user_guid}/members/{member_guid}/status | Read member status |
56
69
  | [**read_merchant**](MxPlatformApi.md#read_merchant) | **GET** /merchants/{merchant_guid} | Read merchant |
70
+ | [**read_merchant_location**](MxPlatformApi.md#read_merchant_location) | **GET** /merchant_locations/{merchant_location_guid} | Read merchant location |
57
71
  | [**read_statement_by_member**](MxPlatformApi.md#read_statement_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid} | Read statement by member |
58
72
  | [**read_tag**](MxPlatformApi.md#read_tag) | **GET** /users/{user_guid}/tags/{tag_guid} | Read tag |
59
73
  | [**read_tagging**](MxPlatformApi.md#read_tagging) | **GET** /users/{user_guid}/taggings/{tagging_guid} | Read tagging |
@@ -66,6 +80,9 @@ All URIs are relative to *https://api.mx.com*
66
80
  | [**resume_aggregation**](MxPlatformApi.md#resume_aggregation) | **PUT** /users/{user_guid}/members/{member_guid}/resume | Resume aggregation |
67
81
  | [**update_account_by_member**](MxPlatformApi.md#update_account_by_member) | **PUT** /users/{user_guid}/members/{member_guid}/accounts/{account_guid} | Update account by member |
68
82
  | [**update_category**](MxPlatformApi.md#update_category) | **PUT** /users/{user_guid}/categories/{category_guid} | Update category |
83
+ | [**update_managed_account**](MxPlatformApi.md#update_managed_account) | **PUT** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Update managed account |
84
+ | [**update_managed_member**](MxPlatformApi.md#update_managed_member) | **PUT** /users/{user_guid}/managed_members/{member_guid} | Update managed member |
85
+ | [**update_managed_transaction**](MxPlatformApi.md#update_managed_transaction) | **PUT** /users/{user_guid}/managed_members/{member_guid}/transactions/{transaction_guid} | Update managed transaction |
69
86
  | [**update_member**](MxPlatformApi.md#update_member) | **PUT** /users/{user_guid}/members/{member_guid} | Update member |
70
87
  | [**update_tag**](MxPlatformApi.md#update_tag) | **PUT** /users/{user_guid}/tags/{tag_guid} | Update tag |
71
88
  | [**update_tagging**](MxPlatformApi.md#update_tagging) | **PUT** /users/{user_guid}/taggings/{tagging_guid} | Update tagging |
@@ -291,6 +308,226 @@ end
291
308
  - **Accept**: application/vnd.mx.api.v1+json
292
309
 
293
310
 
311
+ ## create_managed_account
312
+
313
+ > <AccountResponseBody> create_managed_account(user_guid, member_guid, managed_account_create_request_body)
314
+
315
+ Create managed account
316
+
317
+ Use this endpoint to create a partner-managed account.
318
+
319
+ ### Examples
320
+
321
+ ```ruby
322
+ require 'time'
323
+ require 'mx-platform-ruby'
324
+ # setup authorization
325
+ MxPlatformRuby.configure do |config|
326
+ # Configure HTTP basic authorization: basicAuth
327
+ config.username = 'YOUR USERNAME'
328
+ config.password = 'YOUR PASSWORD'
329
+ end
330
+
331
+ api_instance = MxPlatformRuby::MxPlatformApi.new
332
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
333
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
334
+ managed_account_create_request_body = MxPlatformRuby::ManagedAccountCreateRequestBody.new # ManagedAccountCreateRequestBody | Managed account to be created.
335
+
336
+ begin
337
+ # Create managed account
338
+ result = api_instance.create_managed_account(user_guid, member_guid, managed_account_create_request_body)
339
+ p result
340
+ rescue MxPlatformRuby::ApiError => e
341
+ puts "Error when calling MxPlatformApi->create_managed_account: #{e}"
342
+ end
343
+ ```
344
+
345
+ #### Using the create_managed_account_with_http_info variant
346
+
347
+ This returns an Array which contains the response data, status code and headers.
348
+
349
+ > <Array(<AccountResponseBody>, Integer, Hash)> create_managed_account_with_http_info(user_guid, member_guid, managed_account_create_request_body)
350
+
351
+ ```ruby
352
+ begin
353
+ # Create managed account
354
+ data, status_code, headers = api_instance.create_managed_account_with_http_info(user_guid, member_guid, managed_account_create_request_body)
355
+ p status_code # => 2xx
356
+ p headers # => { ... }
357
+ p data # => <AccountResponseBody>
358
+ rescue MxPlatformRuby::ApiError => e
359
+ puts "Error when calling MxPlatformApi->create_managed_account_with_http_info: #{e}"
360
+ end
361
+ ```
362
+
363
+ ### Parameters
364
+
365
+ | Name | Type | Description | Notes |
366
+ | ---- | ---- | ----------- | ----- |
367
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
368
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
369
+ | **managed_account_create_request_body** | [**ManagedAccountCreateRequestBody**](ManagedAccountCreateRequestBody.md) | Managed account to be created. | |
370
+
371
+ ### Return type
372
+
373
+ [**AccountResponseBody**](AccountResponseBody.md)
374
+
375
+ ### Authorization
376
+
377
+ [basicAuth](../README.md#basicAuth)
378
+
379
+ ### HTTP request headers
380
+
381
+ - **Content-Type**: application/json
382
+ - **Accept**: application/vnd.mx.api.v1+json
383
+
384
+
385
+ ## create_managed_member
386
+
387
+ > <MemberResponseBody> create_managed_member(user_guid, managed_member_create_request_body)
388
+
389
+ Create managed member
390
+
391
+ Use this endpoint to create a new partner-managed `member`.
392
+
393
+ ### Examples
394
+
395
+ ```ruby
396
+ require 'time'
397
+ require 'mx-platform-ruby'
398
+ # setup authorization
399
+ MxPlatformRuby.configure do |config|
400
+ # Configure HTTP basic authorization: basicAuth
401
+ config.username = 'YOUR USERNAME'
402
+ config.password = 'YOUR PASSWORD'
403
+ end
404
+
405
+ api_instance = MxPlatformRuby::MxPlatformApi.new
406
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
407
+ managed_member_create_request_body = MxPlatformRuby::ManagedMemberCreateRequestBody.new # ManagedMemberCreateRequestBody | Managed member to be created.
408
+
409
+ begin
410
+ # Create managed member
411
+ result = api_instance.create_managed_member(user_guid, managed_member_create_request_body)
412
+ p result
413
+ rescue MxPlatformRuby::ApiError => e
414
+ puts "Error when calling MxPlatformApi->create_managed_member: #{e}"
415
+ end
416
+ ```
417
+
418
+ #### Using the create_managed_member_with_http_info variant
419
+
420
+ This returns an Array which contains the response data, status code and headers.
421
+
422
+ > <Array(<MemberResponseBody>, Integer, Hash)> create_managed_member_with_http_info(user_guid, managed_member_create_request_body)
423
+
424
+ ```ruby
425
+ begin
426
+ # Create managed member
427
+ data, status_code, headers = api_instance.create_managed_member_with_http_info(user_guid, managed_member_create_request_body)
428
+ p status_code # => 2xx
429
+ p headers # => { ... }
430
+ p data # => <MemberResponseBody>
431
+ rescue MxPlatformRuby::ApiError => e
432
+ puts "Error when calling MxPlatformApi->create_managed_member_with_http_info: #{e}"
433
+ end
434
+ ```
435
+
436
+ ### Parameters
437
+
438
+ | Name | Type | Description | Notes |
439
+ | ---- | ---- | ----------- | ----- |
440
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
441
+ | **managed_member_create_request_body** | [**ManagedMemberCreateRequestBody**](ManagedMemberCreateRequestBody.md) | Managed member to be created. | |
442
+
443
+ ### Return type
444
+
445
+ [**MemberResponseBody**](MemberResponseBody.md)
446
+
447
+ ### Authorization
448
+
449
+ [basicAuth](../README.md#basicAuth)
450
+
451
+ ### HTTP request headers
452
+
453
+ - **Content-Type**: application/json
454
+ - **Accept**: application/vnd.mx.api.v1+json
455
+
456
+
457
+ ## create_managed_transaction
458
+
459
+ > <TransactionResponseBody> create_managed_transaction(user_guid, member_guid, managed_transaction_create_request_body)
460
+
461
+ Create managed transaction
462
+
463
+ Use this endpoint to create a new partner-managed `transaction`.
464
+
465
+ ### Examples
466
+
467
+ ```ruby
468
+ require 'time'
469
+ require 'mx-platform-ruby'
470
+ # setup authorization
471
+ MxPlatformRuby.configure do |config|
472
+ # Configure HTTP basic authorization: basicAuth
473
+ config.username = 'YOUR USERNAME'
474
+ config.password = 'YOUR PASSWORD'
475
+ end
476
+
477
+ api_instance = MxPlatformRuby::MxPlatformApi.new
478
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
479
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
480
+ managed_transaction_create_request_body = MxPlatformRuby::ManagedTransactionCreateRequestBody.new # ManagedTransactionCreateRequestBody | Managed transaction to be created.
481
+
482
+ begin
483
+ # Create managed transaction
484
+ result = api_instance.create_managed_transaction(user_guid, member_guid, managed_transaction_create_request_body)
485
+ p result
486
+ rescue MxPlatformRuby::ApiError => e
487
+ puts "Error when calling MxPlatformApi->create_managed_transaction: #{e}"
488
+ end
489
+ ```
490
+
491
+ #### Using the create_managed_transaction_with_http_info variant
492
+
493
+ This returns an Array which contains the response data, status code and headers.
494
+
495
+ > <Array(<TransactionResponseBody>, Integer, Hash)> create_managed_transaction_with_http_info(user_guid, member_guid, managed_transaction_create_request_body)
496
+
497
+ ```ruby
498
+ begin
499
+ # Create managed transaction
500
+ data, status_code, headers = api_instance.create_managed_transaction_with_http_info(user_guid, member_guid, managed_transaction_create_request_body)
501
+ p status_code # => 2xx
502
+ p headers # => { ... }
503
+ p data # => <TransactionResponseBody>
504
+ rescue MxPlatformRuby::ApiError => e
505
+ puts "Error when calling MxPlatformApi->create_managed_transaction_with_http_info: #{e}"
506
+ end
507
+ ```
508
+
509
+ ### Parameters
510
+
511
+ | Name | Type | Description | Notes |
512
+ | ---- | ---- | ----------- | ----- |
513
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
514
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
515
+ | **managed_transaction_create_request_body** | [**ManagedTransactionCreateRequestBody**](ManagedTransactionCreateRequestBody.md) | Managed transaction to be created. | |
516
+
517
+ ### Return type
518
+
519
+ [**TransactionResponseBody**](TransactionResponseBody.md)
520
+
521
+ ### Authorization
522
+
523
+ [basicAuth](../README.md#basicAuth)
524
+
525
+ ### HTTP request headers
526
+
527
+ - **Content-Type**: application/json
528
+ - **Accept**: application/vnd.mx.api.v1+json
529
+
530
+
294
531
  ## create_member
295
532
 
296
533
  > <MemberResponseBody> create_member(user_guid, member_create_request_body)
@@ -720,13 +957,13 @@ nil (empty response body)
720
957
  - **Accept**: application/vnd.mx.api.v1+json
721
958
 
722
959
 
723
- ## delete_member
960
+ ## delete_managed_account
724
961
 
725
- > delete_member(member_guid, user_guid)
962
+ > delete_managed_account(member_guid, user_guid, account_guid)
726
963
 
727
- Delete member
964
+ Delete managed account
728
965
 
729
- Accessing this endpoint will permanently delete a member.
966
+ Use this endpoint to delete a partner-managed account according to its unique GUID. If successful, the API will respond with a status of `204 No Content`.
730
967
 
731
968
  ### Examples
732
969
 
@@ -743,30 +980,31 @@ end
743
980
  api_instance = MxPlatformRuby::MxPlatformApi.new
744
981
  member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
745
982
  user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
983
+ account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
746
984
 
747
985
  begin
748
- # Delete member
749
- api_instance.delete_member(member_guid, user_guid)
986
+ # Delete managed account
987
+ api_instance.delete_managed_account(member_guid, user_guid, account_guid)
750
988
  rescue MxPlatformRuby::ApiError => e
751
- puts "Error when calling MxPlatformApi->delete_member: #{e}"
989
+ puts "Error when calling MxPlatformApi->delete_managed_account: #{e}"
752
990
  end
753
991
  ```
754
992
 
755
- #### Using the delete_member_with_http_info variant
993
+ #### Using the delete_managed_account_with_http_info variant
756
994
 
757
995
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
758
996
 
759
- > <Array(nil, Integer, Hash)> delete_member_with_http_info(member_guid, user_guid)
997
+ > <Array(nil, Integer, Hash)> delete_managed_account_with_http_info(member_guid, user_guid, account_guid)
760
998
 
761
999
  ```ruby
762
1000
  begin
763
- # Delete member
764
- data, status_code, headers = api_instance.delete_member_with_http_info(member_guid, user_guid)
1001
+ # Delete managed account
1002
+ data, status_code, headers = api_instance.delete_managed_account_with_http_info(member_guid, user_guid, account_guid)
765
1003
  p status_code # => 2xx
766
1004
  p headers # => { ... }
767
1005
  p data # => nil
768
1006
  rescue MxPlatformRuby::ApiError => e
769
- puts "Error when calling MxPlatformApi->delete_member_with_http_info: #{e}"
1007
+ puts "Error when calling MxPlatformApi->delete_managed_account_with_http_info: #{e}"
770
1008
  end
771
1009
  ```
772
1010
 
@@ -776,6 +1014,7 @@ end
776
1014
  | ---- | ---- | ----------- | ----- |
777
1015
  | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
778
1016
  | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
1017
+ | **account_guid** | **String** | The unique id for an &#x60;account&#x60;. | |
779
1018
 
780
1019
  ### Return type
781
1020
 
@@ -791,13 +1030,13 @@ nil (empty response body)
791
1030
  - **Accept**: application/vnd.mx.api.v1+json
792
1031
 
793
1032
 
794
- ## delete_tag
1033
+ ## delete_managed_member
795
1034
 
796
- > delete_tag(tag_guid, user_guid)
1035
+ > delete_managed_member(member_guid, user_guid)
797
1036
 
798
- Delete tag
1037
+ Delete managed member
799
1038
 
800
- Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of `204 No Content`.
1039
+ Use this endpoint to delete the specified partner-managed `member`. The endpoint will respond with a status of `204 No Content` without a resource.
801
1040
 
802
1041
  ### Examples
803
1042
 
@@ -812,32 +1051,32 @@ MxPlatformRuby.configure do |config|
812
1051
  end
813
1052
 
814
1053
  api_instance = MxPlatformRuby::MxPlatformApi.new
815
- tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # String | The unique id for a `tag`.
1054
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
816
1055
  user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
817
1056
 
818
1057
  begin
819
- # Delete tag
820
- api_instance.delete_tag(tag_guid, user_guid)
1058
+ # Delete managed member
1059
+ api_instance.delete_managed_member(member_guid, user_guid)
821
1060
  rescue MxPlatformRuby::ApiError => e
822
- puts "Error when calling MxPlatformApi->delete_tag: #{e}"
1061
+ puts "Error when calling MxPlatformApi->delete_managed_member: #{e}"
823
1062
  end
824
1063
  ```
825
1064
 
826
- #### Using the delete_tag_with_http_info variant
1065
+ #### Using the delete_managed_member_with_http_info variant
827
1066
 
828
1067
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
829
1068
 
830
- > <Array(nil, Integer, Hash)> delete_tag_with_http_info(tag_guid, user_guid)
1069
+ > <Array(nil, Integer, Hash)> delete_managed_member_with_http_info(member_guid, user_guid)
831
1070
 
832
1071
  ```ruby
833
1072
  begin
834
- # Delete tag
835
- data, status_code, headers = api_instance.delete_tag_with_http_info(tag_guid, user_guid)
1073
+ # Delete managed member
1074
+ data, status_code, headers = api_instance.delete_managed_member_with_http_info(member_guid, user_guid)
836
1075
  p status_code # => 2xx
837
1076
  p headers # => { ... }
838
1077
  p data # => nil
839
1078
  rescue MxPlatformRuby::ApiError => e
840
- puts "Error when calling MxPlatformApi->delete_tag_with_http_info: #{e}"
1079
+ puts "Error when calling MxPlatformApi->delete_managed_member_with_http_info: #{e}"
841
1080
  end
842
1081
  ```
843
1082
 
@@ -845,7 +1084,7 @@ end
845
1084
 
846
1085
  | Name | Type | Description | Notes |
847
1086
  | ---- | ---- | ----------- | ----- |
848
- | **tag_guid** | **String** | The unique id for a &#x60;tag&#x60;. | |
1087
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
849
1088
  | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
850
1089
 
851
1090
  ### Return type
@@ -862,13 +1101,13 @@ nil (empty response body)
862
1101
  - **Accept**: application/vnd.mx.api.v1+json
863
1102
 
864
1103
 
865
- ## delete_tagging
1104
+ ## delete_managed_transaction
866
1105
 
867
- > delete_tagging(tagging_guid, user_guid)
1106
+ > delete_managed_transaction(member_guid, user_guid, transaction_guid)
868
1107
 
869
- Delete tagging
1108
+ Delete managed transaction
870
1109
 
871
- Use this endpoint to delete a tagging according to its unique GUID. If successful, the API will respond with an empty body and a status of 204 NO Content.
1110
+ Use this endpoint to delete the specified partner-managed `transaction`. The endpoint will respond with a status of `204 No Content` without a resource.
872
1111
 
873
1112
  ### Examples
874
1113
 
@@ -883,32 +1122,33 @@ MxPlatformRuby.configure do |config|
883
1122
  end
884
1123
 
885
1124
  api_instance = MxPlatformRuby::MxPlatformApi.new
886
- tagging_guid = 'TGN-007f5486-17e1-45fc-8b87-8f03984430fe' # String | The unique id for a `tagging`.
1125
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
887
1126
  user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
1127
+ transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
888
1128
 
889
1129
  begin
890
- # Delete tagging
891
- api_instance.delete_tagging(tagging_guid, user_guid)
1130
+ # Delete managed transaction
1131
+ api_instance.delete_managed_transaction(member_guid, user_guid, transaction_guid)
892
1132
  rescue MxPlatformRuby::ApiError => e
893
- puts "Error when calling MxPlatformApi->delete_tagging: #{e}"
1133
+ puts "Error when calling MxPlatformApi->delete_managed_transaction: #{e}"
894
1134
  end
895
1135
  ```
896
1136
 
897
- #### Using the delete_tagging_with_http_info variant
1137
+ #### Using the delete_managed_transaction_with_http_info variant
898
1138
 
899
1139
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
900
1140
 
901
- > <Array(nil, Integer, Hash)> delete_tagging_with_http_info(tagging_guid, user_guid)
1141
+ > <Array(nil, Integer, Hash)> delete_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid)
902
1142
 
903
1143
  ```ruby
904
1144
  begin
905
- # Delete tagging
906
- data, status_code, headers = api_instance.delete_tagging_with_http_info(tagging_guid, user_guid)
1145
+ # Delete managed transaction
1146
+ data, status_code, headers = api_instance.delete_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid)
907
1147
  p status_code # => 2xx
908
1148
  p headers # => { ... }
909
1149
  p data # => nil
910
1150
  rescue MxPlatformRuby::ApiError => e
911
- puts "Error when calling MxPlatformApi->delete_tagging_with_http_info: #{e}"
1151
+ puts "Error when calling MxPlatformApi->delete_managed_transaction_with_http_info: #{e}"
912
1152
  end
913
1153
  ```
914
1154
 
@@ -916,8 +1156,9 @@ end
916
1156
 
917
1157
  | Name | Type | Description | Notes |
918
1158
  | ---- | ---- | ----------- | ----- |
919
- | **tagging_guid** | **String** | The unique id for a &#x60;tagging&#x60;. | |
1159
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
920
1160
  | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
1161
+ | **transaction_guid** | **String** | The unique id for a &#x60;transaction&#x60;. | |
921
1162
 
922
1163
  ### Return type
923
1164
 
@@ -933,13 +1174,13 @@ nil (empty response body)
933
1174
  - **Accept**: application/vnd.mx.api.v1+json
934
1175
 
935
1176
 
936
- ## delete_transaction_rule
1177
+ ## delete_member
937
1178
 
938
- > delete_transaction_rule(transaction_rule_guid, user_guid)
1179
+ > delete_member(member_guid, user_guid)
939
1180
 
940
- Delete transaction rule
1181
+ Delete member
941
1182
 
942
- Use this endpoint to permanently delete a transaction rule based on its unique GUID.
1183
+ Accessing this endpoint will permanently delete a member.
943
1184
 
944
1185
  ### Examples
945
1186
 
@@ -954,32 +1195,32 @@ MxPlatformRuby.configure do |config|
954
1195
  end
955
1196
 
956
1197
  api_instance = MxPlatformRuby::MxPlatformApi.new
957
- transaction_rule_guid = 'TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3' # String | The unique id for a `transaction_rule`.
1198
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
958
1199
  user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
959
1200
 
960
1201
  begin
961
- # Delete transaction rule
962
- api_instance.delete_transaction_rule(transaction_rule_guid, user_guid)
1202
+ # Delete member
1203
+ api_instance.delete_member(member_guid, user_guid)
963
1204
  rescue MxPlatformRuby::ApiError => e
964
- puts "Error when calling MxPlatformApi->delete_transaction_rule: #{e}"
1205
+ puts "Error when calling MxPlatformApi->delete_member: #{e}"
965
1206
  end
966
1207
  ```
967
1208
 
968
- #### Using the delete_transaction_rule_with_http_info variant
1209
+ #### Using the delete_member_with_http_info variant
969
1210
 
970
1211
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
971
1212
 
972
- > <Array(nil, Integer, Hash)> delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid)
1213
+ > <Array(nil, Integer, Hash)> delete_member_with_http_info(member_guid, user_guid)
973
1214
 
974
1215
  ```ruby
975
1216
  begin
976
- # Delete transaction rule
977
- data, status_code, headers = api_instance.delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid)
1217
+ # Delete member
1218
+ data, status_code, headers = api_instance.delete_member_with_http_info(member_guid, user_guid)
978
1219
  p status_code # => 2xx
979
1220
  p headers # => { ... }
980
1221
  p data # => nil
981
1222
  rescue MxPlatformRuby::ApiError => e
982
- puts "Error when calling MxPlatformApi->delete_transaction_rule_with_http_info: #{e}"
1223
+ puts "Error when calling MxPlatformApi->delete_member_with_http_info: #{e}"
983
1224
  end
984
1225
  ```
985
1226
 
@@ -987,7 +1228,7 @@ end
987
1228
 
988
1229
  | Name | Type | Description | Notes |
989
1230
  | ---- | ---- | ----------- | ----- |
990
- | **transaction_rule_guid** | **String** | The unique id for a &#x60;transaction_rule&#x60;. | |
1231
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
991
1232
  | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
992
1233
 
993
1234
  ### Return type
@@ -1004,7 +1245,220 @@ nil (empty response body)
1004
1245
  - **Accept**: application/vnd.mx.api.v1+json
1005
1246
 
1006
1247
 
1007
- ## delete_user
1248
+ ## delete_tag
1249
+
1250
+ > delete_tag(tag_guid, user_guid)
1251
+
1252
+ Delete tag
1253
+
1254
+ Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of `204 No Content`.
1255
+
1256
+ ### Examples
1257
+
1258
+ ```ruby
1259
+ require 'time'
1260
+ require 'mx-platform-ruby'
1261
+ # setup authorization
1262
+ MxPlatformRuby.configure do |config|
1263
+ # Configure HTTP basic authorization: basicAuth
1264
+ config.username = 'YOUR USERNAME'
1265
+ config.password = 'YOUR PASSWORD'
1266
+ end
1267
+
1268
+ api_instance = MxPlatformRuby::MxPlatformApi.new
1269
+ tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # String | The unique id for a `tag`.
1270
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
1271
+
1272
+ begin
1273
+ # Delete tag
1274
+ api_instance.delete_tag(tag_guid, user_guid)
1275
+ rescue MxPlatformRuby::ApiError => e
1276
+ puts "Error when calling MxPlatformApi->delete_tag: #{e}"
1277
+ end
1278
+ ```
1279
+
1280
+ #### Using the delete_tag_with_http_info variant
1281
+
1282
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1283
+
1284
+ > <Array(nil, Integer, Hash)> delete_tag_with_http_info(tag_guid, user_guid)
1285
+
1286
+ ```ruby
1287
+ begin
1288
+ # Delete tag
1289
+ data, status_code, headers = api_instance.delete_tag_with_http_info(tag_guid, user_guid)
1290
+ p status_code # => 2xx
1291
+ p headers # => { ... }
1292
+ p data # => nil
1293
+ rescue MxPlatformRuby::ApiError => e
1294
+ puts "Error when calling MxPlatformApi->delete_tag_with_http_info: #{e}"
1295
+ end
1296
+ ```
1297
+
1298
+ ### Parameters
1299
+
1300
+ | Name | Type | Description | Notes |
1301
+ | ---- | ---- | ----------- | ----- |
1302
+ | **tag_guid** | **String** | The unique id for a &#x60;tag&#x60;. | |
1303
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
1304
+
1305
+ ### Return type
1306
+
1307
+ nil (empty response body)
1308
+
1309
+ ### Authorization
1310
+
1311
+ [basicAuth](../README.md#basicAuth)
1312
+
1313
+ ### HTTP request headers
1314
+
1315
+ - **Content-Type**: Not defined
1316
+ - **Accept**: application/vnd.mx.api.v1+json
1317
+
1318
+
1319
+ ## delete_tagging
1320
+
1321
+ > delete_tagging(tagging_guid, user_guid)
1322
+
1323
+ Delete tagging
1324
+
1325
+ Use this endpoint to delete a tagging according to its unique GUID. If successful, the API will respond with an empty body and a status of 204 NO Content.
1326
+
1327
+ ### Examples
1328
+
1329
+ ```ruby
1330
+ require 'time'
1331
+ require 'mx-platform-ruby'
1332
+ # setup authorization
1333
+ MxPlatformRuby.configure do |config|
1334
+ # Configure HTTP basic authorization: basicAuth
1335
+ config.username = 'YOUR USERNAME'
1336
+ config.password = 'YOUR PASSWORD'
1337
+ end
1338
+
1339
+ api_instance = MxPlatformRuby::MxPlatformApi.new
1340
+ tagging_guid = 'TGN-007f5486-17e1-45fc-8b87-8f03984430fe' # String | The unique id for a `tagging`.
1341
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
1342
+
1343
+ begin
1344
+ # Delete tagging
1345
+ api_instance.delete_tagging(tagging_guid, user_guid)
1346
+ rescue MxPlatformRuby::ApiError => e
1347
+ puts "Error when calling MxPlatformApi->delete_tagging: #{e}"
1348
+ end
1349
+ ```
1350
+
1351
+ #### Using the delete_tagging_with_http_info variant
1352
+
1353
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1354
+
1355
+ > <Array(nil, Integer, Hash)> delete_tagging_with_http_info(tagging_guid, user_guid)
1356
+
1357
+ ```ruby
1358
+ begin
1359
+ # Delete tagging
1360
+ data, status_code, headers = api_instance.delete_tagging_with_http_info(tagging_guid, user_guid)
1361
+ p status_code # => 2xx
1362
+ p headers # => { ... }
1363
+ p data # => nil
1364
+ rescue MxPlatformRuby::ApiError => e
1365
+ puts "Error when calling MxPlatformApi->delete_tagging_with_http_info: #{e}"
1366
+ end
1367
+ ```
1368
+
1369
+ ### Parameters
1370
+
1371
+ | Name | Type | Description | Notes |
1372
+ | ---- | ---- | ----------- | ----- |
1373
+ | **tagging_guid** | **String** | The unique id for a &#x60;tagging&#x60;. | |
1374
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
1375
+
1376
+ ### Return type
1377
+
1378
+ nil (empty response body)
1379
+
1380
+ ### Authorization
1381
+
1382
+ [basicAuth](../README.md#basicAuth)
1383
+
1384
+ ### HTTP request headers
1385
+
1386
+ - **Content-Type**: Not defined
1387
+ - **Accept**: application/vnd.mx.api.v1+json
1388
+
1389
+
1390
+ ## delete_transaction_rule
1391
+
1392
+ > delete_transaction_rule(transaction_rule_guid, user_guid)
1393
+
1394
+ Delete transaction rule
1395
+
1396
+ Use this endpoint to permanently delete a transaction rule based on its unique GUID.
1397
+
1398
+ ### Examples
1399
+
1400
+ ```ruby
1401
+ require 'time'
1402
+ require 'mx-platform-ruby'
1403
+ # setup authorization
1404
+ MxPlatformRuby.configure do |config|
1405
+ # Configure HTTP basic authorization: basicAuth
1406
+ config.username = 'YOUR USERNAME'
1407
+ config.password = 'YOUR PASSWORD'
1408
+ end
1409
+
1410
+ api_instance = MxPlatformRuby::MxPlatformApi.new
1411
+ transaction_rule_guid = 'TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3' # String | The unique id for a `transaction_rule`.
1412
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
1413
+
1414
+ begin
1415
+ # Delete transaction rule
1416
+ api_instance.delete_transaction_rule(transaction_rule_guid, user_guid)
1417
+ rescue MxPlatformRuby::ApiError => e
1418
+ puts "Error when calling MxPlatformApi->delete_transaction_rule: #{e}"
1419
+ end
1420
+ ```
1421
+
1422
+ #### Using the delete_transaction_rule_with_http_info variant
1423
+
1424
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1425
+
1426
+ > <Array(nil, Integer, Hash)> delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid)
1427
+
1428
+ ```ruby
1429
+ begin
1430
+ # Delete transaction rule
1431
+ data, status_code, headers = api_instance.delete_transaction_rule_with_http_info(transaction_rule_guid, user_guid)
1432
+ p status_code # => 2xx
1433
+ p headers # => { ... }
1434
+ p data # => nil
1435
+ rescue MxPlatformRuby::ApiError => e
1436
+ puts "Error when calling MxPlatformApi->delete_transaction_rule_with_http_info: #{e}"
1437
+ end
1438
+ ```
1439
+
1440
+ ### Parameters
1441
+
1442
+ | Name | Type | Description | Notes |
1443
+ | ---- | ---- | ----------- | ----- |
1444
+ | **transaction_rule_guid** | **String** | The unique id for a &#x60;transaction_rule&#x60;. | |
1445
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
1446
+
1447
+ ### Return type
1448
+
1449
+ nil (empty response body)
1450
+
1451
+ ### Authorization
1452
+
1453
+ [basicAuth](../README.md#basicAuth)
1454
+
1455
+ ### HTTP request headers
1456
+
1457
+ - **Content-Type**: Not defined
1458
+ - **Accept**: application/vnd.mx.api.v1+json
1459
+
1460
+
1461
+ ## delete_user
1008
1462
 
1009
1463
  > delete_user(user_guid)
1010
1464
 
@@ -1745,7 +2199,7 @@ end
1745
2199
 
1746
2200
  ## list_default_categories
1747
2201
 
1748
- > <CategoriesResponseBody> list_default_categories(user_guid)
2202
+ > <CategoriesResponseBody> list_default_categories(user_guid, opts)
1749
2203
 
1750
2204
  List default categories
1751
2205
 
@@ -1765,10 +2219,14 @@ end
1765
2219
 
1766
2220
  api_instance = MxPlatformRuby::MxPlatformApi.new
1767
2221
  user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
2222
+ opts = {
2223
+ page: 1, # Integer | Specify current page.
2224
+ records_per_page: 10 # Integer | Specify records per page.
2225
+ }
1768
2226
 
1769
2227
  begin
1770
2228
  # List default categories
1771
- result = api_instance.list_default_categories(user_guid)
2229
+ result = api_instance.list_default_categories(user_guid, opts)
1772
2230
  p result
1773
2231
  rescue MxPlatformRuby::ApiError => e
1774
2232
  puts "Error when calling MxPlatformApi->list_default_categories: #{e}"
@@ -1779,12 +2237,12 @@ end
1779
2237
 
1780
2238
  This returns an Array which contains the response data, status code and headers.
1781
2239
 
1782
- > <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_with_http_info(user_guid)
2240
+ > <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_with_http_info(user_guid, opts)
1783
2241
 
1784
2242
  ```ruby
1785
2243
  begin
1786
2244
  # List default categories
1787
- data, status_code, headers = api_instance.list_default_categories_with_http_info(user_guid)
2245
+ data, status_code, headers = api_instance.list_default_categories_with_http_info(user_guid, opts)
1788
2246
  p status_code # => 2xx
1789
2247
  p headers # => { ... }
1790
2248
  p data # => <CategoriesResponseBody>
@@ -1798,6 +2256,8 @@ end
1798
2256
  | Name | Type | Description | Notes |
1799
2257
  | ---- | ---- | ----------- | ----- |
1800
2258
  | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
2259
+ | **page** | **Integer** | Specify current page. | [optional] |
2260
+ | **records_per_page** | **Integer** | Specify records per page. | [optional] |
1801
2261
 
1802
2262
  ### Return type
1803
2263
 
@@ -2033,11 +2493,323 @@ end
2033
2493
  | **from_date** | **String** | Filter holdings from this date. | [optional] |
2034
2494
  | **page** | **Integer** | Specify current page. | [optional] |
2035
2495
  | **records_per_page** | **Integer** | Specify records per page. | [optional] |
2036
- | **to_date** | **String** | Filter holdings to this date. | [optional] |
2496
+ | **to_date** | **String** | Filter holdings to this date. | [optional] |
2497
+
2498
+ ### Return type
2499
+
2500
+ [**HoldingsResponseBody**](HoldingsResponseBody.md)
2501
+
2502
+ ### Authorization
2503
+
2504
+ [basicAuth](../README.md#basicAuth)
2505
+
2506
+ ### HTTP request headers
2507
+
2508
+ - **Content-Type**: Not defined
2509
+ - **Accept**: application/vnd.mx.api.v1+json
2510
+
2511
+
2512
+ ## list_institution_credentials
2513
+
2514
+ > <CredentialsResponseBody> list_institution_credentials(institution_code, opts)
2515
+
2516
+ List institution credentials
2517
+
2518
+ Use this endpoint to see which credentials will be needed to create a member for a specific institution.
2519
+
2520
+ ### Examples
2521
+
2522
+ ```ruby
2523
+ require 'time'
2524
+ require 'mx-platform-ruby'
2525
+ # setup authorization
2526
+ MxPlatformRuby.configure do |config|
2527
+ # Configure HTTP basic authorization: basicAuth
2528
+ config.username = 'YOUR USERNAME'
2529
+ config.password = 'YOUR PASSWORD'
2530
+ end
2531
+
2532
+ api_instance = MxPlatformRuby::MxPlatformApi.new
2533
+ institution_code = 'chase' # String | The institution_code of the institution.
2534
+ opts = {
2535
+ page: 1, # Integer | Specify current page.
2536
+ records_per_page: 10 # Integer | Specify records per page.
2537
+ }
2538
+
2539
+ begin
2540
+ # List institution credentials
2541
+ result = api_instance.list_institution_credentials(institution_code, opts)
2542
+ p result
2543
+ rescue MxPlatformRuby::ApiError => e
2544
+ puts "Error when calling MxPlatformApi->list_institution_credentials: #{e}"
2545
+ end
2546
+ ```
2547
+
2548
+ #### Using the list_institution_credentials_with_http_info variant
2549
+
2550
+ This returns an Array which contains the response data, status code and headers.
2551
+
2552
+ > <Array(<CredentialsResponseBody>, Integer, Hash)> list_institution_credentials_with_http_info(institution_code, opts)
2553
+
2554
+ ```ruby
2555
+ begin
2556
+ # List institution credentials
2557
+ data, status_code, headers = api_instance.list_institution_credentials_with_http_info(institution_code, opts)
2558
+ p status_code # => 2xx
2559
+ p headers # => { ... }
2560
+ p data # => <CredentialsResponseBody>
2561
+ rescue MxPlatformRuby::ApiError => e
2562
+ puts "Error when calling MxPlatformApi->list_institution_credentials_with_http_info: #{e}"
2563
+ end
2564
+ ```
2565
+
2566
+ ### Parameters
2567
+
2568
+ | Name | Type | Description | Notes |
2569
+ | ---- | ---- | ----------- | ----- |
2570
+ | **institution_code** | **String** | The institution_code of the institution. | |
2571
+ | **page** | **Integer** | Specify current page. | [optional] |
2572
+ | **records_per_page** | **Integer** | Specify records per page. | [optional] |
2573
+
2574
+ ### Return type
2575
+
2576
+ [**CredentialsResponseBody**](CredentialsResponseBody.md)
2577
+
2578
+ ### Authorization
2579
+
2580
+ [basicAuth](../README.md#basicAuth)
2581
+
2582
+ ### HTTP request headers
2583
+
2584
+ - **Content-Type**: Not defined
2585
+ - **Accept**: application/vnd.mx.api.v1+json
2586
+
2587
+
2588
+ ## list_institutions
2589
+
2590
+ > <InstitutionsResponseBody> list_institutions(opts)
2591
+
2592
+ List institutions
2593
+
2594
+ This endpoint returns a list of institutions based on the specified search term or parameter.
2595
+
2596
+ ### Examples
2597
+
2598
+ ```ruby
2599
+ require 'time'
2600
+ require 'mx-platform-ruby'
2601
+ # setup authorization
2602
+ MxPlatformRuby.configure do |config|
2603
+ # Configure HTTP basic authorization: basicAuth
2604
+ config.username = 'YOUR USERNAME'
2605
+ config.password = 'YOUR PASSWORD'
2606
+ end
2607
+
2608
+ api_instance = MxPlatformRuby::MxPlatformApi.new
2609
+ opts = {
2610
+ name: 'chase', # String | This will list only institutions in which the appended string appears.
2611
+ page: 1, # Integer | Specify current page.
2612
+ records_per_page: 10, # Integer | Specify records per page.
2613
+ supports_account_identification: true, # Boolean | Filter only institutions which support account identification.
2614
+ supports_account_statement: true, # Boolean | Filter only institutions which support account statements.
2615
+ supports_account_verification: true, # Boolean | Filter only institutions which support account verification.
2616
+ supports_transaction_history: true # Boolean | Filter only institutions which support extended transaction history.
2617
+ }
2618
+
2619
+ begin
2620
+ # List institutions
2621
+ result = api_instance.list_institutions(opts)
2622
+ p result
2623
+ rescue MxPlatformRuby::ApiError => e
2624
+ puts "Error when calling MxPlatformApi->list_institutions: #{e}"
2625
+ end
2626
+ ```
2627
+
2628
+ #### Using the list_institutions_with_http_info variant
2629
+
2630
+ This returns an Array which contains the response data, status code and headers.
2631
+
2632
+ > <Array(<InstitutionsResponseBody>, Integer, Hash)> list_institutions_with_http_info(opts)
2633
+
2634
+ ```ruby
2635
+ begin
2636
+ # List institutions
2637
+ data, status_code, headers = api_instance.list_institutions_with_http_info(opts)
2638
+ p status_code # => 2xx
2639
+ p headers # => { ... }
2640
+ p data # => <InstitutionsResponseBody>
2641
+ rescue MxPlatformRuby::ApiError => e
2642
+ puts "Error when calling MxPlatformApi->list_institutions_with_http_info: #{e}"
2643
+ end
2644
+ ```
2645
+
2646
+ ### Parameters
2647
+
2648
+ | Name | Type | Description | Notes |
2649
+ | ---- | ---- | ----------- | ----- |
2650
+ | **name** | **String** | This will list only institutions in which the appended string appears. | [optional] |
2651
+ | **page** | **Integer** | Specify current page. | [optional] |
2652
+ | **records_per_page** | **Integer** | Specify records per page. | [optional] |
2653
+ | **supports_account_identification** | **Boolean** | Filter only institutions which support account identification. | [optional] |
2654
+ | **supports_account_statement** | **Boolean** | Filter only institutions which support account statements. | [optional] |
2655
+ | **supports_account_verification** | **Boolean** | Filter only institutions which support account verification. | [optional] |
2656
+ | **supports_transaction_history** | **Boolean** | Filter only institutions which support extended transaction history. | [optional] |
2657
+
2658
+ ### Return type
2659
+
2660
+ [**InstitutionsResponseBody**](InstitutionsResponseBody.md)
2661
+
2662
+ ### Authorization
2663
+
2664
+ [basicAuth](../README.md#basicAuth)
2665
+
2666
+ ### HTTP request headers
2667
+
2668
+ - **Content-Type**: Not defined
2669
+ - **Accept**: application/vnd.mx.api.v1+json
2670
+
2671
+
2672
+ ## list_managed_accounts
2673
+
2674
+ > <AccountsResponseBody> list_managed_accounts(user_guid, member_guid, opts)
2675
+
2676
+ List managed accounts
2677
+
2678
+ Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-manage member.
2679
+
2680
+ ### Examples
2681
+
2682
+ ```ruby
2683
+ require 'time'
2684
+ require 'mx-platform-ruby'
2685
+ # setup authorization
2686
+ MxPlatformRuby.configure do |config|
2687
+ # Configure HTTP basic authorization: basicAuth
2688
+ config.username = 'YOUR USERNAME'
2689
+ config.password = 'YOUR PASSWORD'
2690
+ end
2691
+
2692
+ api_instance = MxPlatformRuby::MxPlatformApi.new
2693
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
2694
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
2695
+ opts = {
2696
+ page: 1, # Integer | Specify current page.
2697
+ records_per_page: 10 # Integer | Specify records per page.
2698
+ }
2699
+
2700
+ begin
2701
+ # List managed accounts
2702
+ result = api_instance.list_managed_accounts(user_guid, member_guid, opts)
2703
+ p result
2704
+ rescue MxPlatformRuby::ApiError => e
2705
+ puts "Error when calling MxPlatformApi->list_managed_accounts: #{e}"
2706
+ end
2707
+ ```
2708
+
2709
+ #### Using the list_managed_accounts_with_http_info variant
2710
+
2711
+ This returns an Array which contains the response data, status code and headers.
2712
+
2713
+ > <Array(<AccountsResponseBody>, Integer, Hash)> list_managed_accounts_with_http_info(user_guid, member_guid, opts)
2714
+
2715
+ ```ruby
2716
+ begin
2717
+ # List managed accounts
2718
+ data, status_code, headers = api_instance.list_managed_accounts_with_http_info(user_guid, member_guid, opts)
2719
+ p status_code # => 2xx
2720
+ p headers # => { ... }
2721
+ p data # => <AccountsResponseBody>
2722
+ rescue MxPlatformRuby::ApiError => e
2723
+ puts "Error when calling MxPlatformApi->list_managed_accounts_with_http_info: #{e}"
2724
+ end
2725
+ ```
2726
+
2727
+ ### Parameters
2728
+
2729
+ | Name | Type | Description | Notes |
2730
+ | ---- | ---- | ----------- | ----- |
2731
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
2732
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
2733
+ | **page** | **Integer** | Specify current page. | [optional] |
2734
+ | **records_per_page** | **Integer** | Specify records per page. | [optional] |
2735
+
2736
+ ### Return type
2737
+
2738
+ [**AccountsResponseBody**](AccountsResponseBody.md)
2739
+
2740
+ ### Authorization
2741
+
2742
+ [basicAuth](../README.md#basicAuth)
2743
+
2744
+ ### HTTP request headers
2745
+
2746
+ - **Content-Type**: Not defined
2747
+ - **Accept**: application/vnd.mx.api.v1+json
2748
+
2749
+
2750
+ ## list_managed_institutions
2751
+
2752
+ > <InstitutionsResponseBody> list_managed_institutions(opts)
2753
+
2754
+ List managed institutions
2755
+
2756
+ This endpoint returns a list of institutions which can be used to create partner-managed members.
2757
+
2758
+ ### Examples
2759
+
2760
+ ```ruby
2761
+ require 'time'
2762
+ require 'mx-platform-ruby'
2763
+ # setup authorization
2764
+ MxPlatformRuby.configure do |config|
2765
+ # Configure HTTP basic authorization: basicAuth
2766
+ config.username = 'YOUR USERNAME'
2767
+ config.password = 'YOUR PASSWORD'
2768
+ end
2769
+
2770
+ api_instance = MxPlatformRuby::MxPlatformApi.new
2771
+ opts = {
2772
+ page: 1, # Integer | Specify current page.
2773
+ records_per_page: 10 # Integer | Specify records per page.
2774
+ }
2775
+
2776
+ begin
2777
+ # List managed institutions
2778
+ result = api_instance.list_managed_institutions(opts)
2779
+ p result
2780
+ rescue MxPlatformRuby::ApiError => e
2781
+ puts "Error when calling MxPlatformApi->list_managed_institutions: #{e}"
2782
+ end
2783
+ ```
2784
+
2785
+ #### Using the list_managed_institutions_with_http_info variant
2786
+
2787
+ This returns an Array which contains the response data, status code and headers.
2788
+
2789
+ > <Array(<InstitutionsResponseBody>, Integer, Hash)> list_managed_institutions_with_http_info(opts)
2790
+
2791
+ ```ruby
2792
+ begin
2793
+ # List managed institutions
2794
+ data, status_code, headers = api_instance.list_managed_institutions_with_http_info(opts)
2795
+ p status_code # => 2xx
2796
+ p headers # => { ... }
2797
+ p data # => <InstitutionsResponseBody>
2798
+ rescue MxPlatformRuby::ApiError => e
2799
+ puts "Error when calling MxPlatformApi->list_managed_institutions_with_http_info: #{e}"
2800
+ end
2801
+ ```
2802
+
2803
+ ### Parameters
2804
+
2805
+ | Name | Type | Description | Notes |
2806
+ | ---- | ---- | ----------- | ----- |
2807
+ | **page** | **Integer** | Specify current page. | [optional] |
2808
+ | **records_per_page** | **Integer** | Specify records per page. | [optional] |
2037
2809
 
2038
2810
  ### Return type
2039
2811
 
2040
- [**HoldingsResponseBody**](HoldingsResponseBody.md)
2812
+ [**InstitutionsResponseBody**](InstitutionsResponseBody.md)
2041
2813
 
2042
2814
  ### Authorization
2043
2815
 
@@ -2049,13 +2821,13 @@ end
2049
2821
  - **Accept**: application/vnd.mx.api.v1+json
2050
2822
 
2051
2823
 
2052
- ## list_institution_credentials
2824
+ ## list_managed_members
2053
2825
 
2054
- > <CredentialsResponseBody> list_institution_credentials(institution_code, opts)
2826
+ > <MembersResponseBody> list_managed_members(user_guid, opts)
2055
2827
 
2056
- List institution credentials
2828
+ List managed members
2057
2829
 
2058
- Use this endpoint to see which credentials will be needed to create a member for a specific institution.
2830
+ This endpoint returns a list of all the partner-managed members associated with the specified `user`.
2059
2831
 
2060
2832
  ### Examples
2061
2833
 
@@ -2070,36 +2842,36 @@ MxPlatformRuby.configure do |config|
2070
2842
  end
2071
2843
 
2072
2844
  api_instance = MxPlatformRuby::MxPlatformApi.new
2073
- institution_code = 'chase' # String | The institution_code of the institution.
2845
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
2074
2846
  opts = {
2075
2847
  page: 1, # Integer | Specify current page.
2076
2848
  records_per_page: 10 # Integer | Specify records per page.
2077
2849
  }
2078
2850
 
2079
2851
  begin
2080
- # List institution credentials
2081
- result = api_instance.list_institution_credentials(institution_code, opts)
2852
+ # List managed members
2853
+ result = api_instance.list_managed_members(user_guid, opts)
2082
2854
  p result
2083
2855
  rescue MxPlatformRuby::ApiError => e
2084
- puts "Error when calling MxPlatformApi->list_institution_credentials: #{e}"
2856
+ puts "Error when calling MxPlatformApi->list_managed_members: #{e}"
2085
2857
  end
2086
2858
  ```
2087
2859
 
2088
- #### Using the list_institution_credentials_with_http_info variant
2860
+ #### Using the list_managed_members_with_http_info variant
2089
2861
 
2090
2862
  This returns an Array which contains the response data, status code and headers.
2091
2863
 
2092
- > <Array(<CredentialsResponseBody>, Integer, Hash)> list_institution_credentials_with_http_info(institution_code, opts)
2864
+ > <Array(<MembersResponseBody>, Integer, Hash)> list_managed_members_with_http_info(user_guid, opts)
2093
2865
 
2094
2866
  ```ruby
2095
2867
  begin
2096
- # List institution credentials
2097
- data, status_code, headers = api_instance.list_institution_credentials_with_http_info(institution_code, opts)
2868
+ # List managed members
2869
+ data, status_code, headers = api_instance.list_managed_members_with_http_info(user_guid, opts)
2098
2870
  p status_code # => 2xx
2099
2871
  p headers # => { ... }
2100
- p data # => <CredentialsResponseBody>
2872
+ p data # => <MembersResponseBody>
2101
2873
  rescue MxPlatformRuby::ApiError => e
2102
- puts "Error when calling MxPlatformApi->list_institution_credentials_with_http_info: #{e}"
2874
+ puts "Error when calling MxPlatformApi->list_managed_members_with_http_info: #{e}"
2103
2875
  end
2104
2876
  ```
2105
2877
 
@@ -2107,13 +2879,13 @@ end
2107
2879
 
2108
2880
  | Name | Type | Description | Notes |
2109
2881
  | ---- | ---- | ----------- | ----- |
2110
- | **institution_code** | **String** | The institution_code of the institution. | |
2882
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
2111
2883
  | **page** | **Integer** | Specify current page. | [optional] |
2112
2884
  | **records_per_page** | **Integer** | Specify records per page. | [optional] |
2113
2885
 
2114
2886
  ### Return type
2115
2887
 
2116
- [**CredentialsResponseBody**](CredentialsResponseBody.md)
2888
+ [**MembersResponseBody**](MembersResponseBody.md)
2117
2889
 
2118
2890
  ### Authorization
2119
2891
 
@@ -2125,13 +2897,13 @@ end
2125
2897
  - **Accept**: application/vnd.mx.api.v1+json
2126
2898
 
2127
2899
 
2128
- ## list_institutions
2900
+ ## list_managed_transactions
2129
2901
 
2130
- > <InstitutionsResponseBody> list_institutions(opts)
2902
+ > <TransactionsResponseBody> list_managed_transactions(user_guid, member_guid, opts)
2131
2903
 
2132
- List institutions
2904
+ List managed transactions
2133
2905
 
2134
- This endpoint returns a list of institutions based on the specified search term or parameter.
2906
+ This endpoint returns a list of all the partner-managed transactions associated with the specified `account`, scoped through a `user` and a `member`.
2135
2907
 
2136
2908
  ### Examples
2137
2909
 
@@ -2146,38 +2918,37 @@ MxPlatformRuby.configure do |config|
2146
2918
  end
2147
2919
 
2148
2920
  api_instance = MxPlatformRuby::MxPlatformApi.new
2921
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
2922
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
2149
2923
  opts = {
2150
- name: 'chase', # String | This will list only institutions in which the appended string appears.
2151
- supports_account_identification: true, # Boolean | Filter only institutions which support account identification.
2152
- supports_account_statement: true, # Boolean | Filter only institutions which support account statements.
2153
- supports_account_verification: true, # Boolean | Filter only institutions which support account verification.
2154
- supports_transaction_history: true # Boolean | Filter only institutions which support extended transaction history.
2924
+ page: 1, # Integer | Specify current page.
2925
+ records_per_page: 10 # Integer | Specify records per page.
2155
2926
  }
2156
2927
 
2157
2928
  begin
2158
- # List institutions
2159
- result = api_instance.list_institutions(opts)
2929
+ # List managed transactions
2930
+ result = api_instance.list_managed_transactions(user_guid, member_guid, opts)
2160
2931
  p result
2161
2932
  rescue MxPlatformRuby::ApiError => e
2162
- puts "Error when calling MxPlatformApi->list_institutions: #{e}"
2933
+ puts "Error when calling MxPlatformApi->list_managed_transactions: #{e}"
2163
2934
  end
2164
2935
  ```
2165
2936
 
2166
- #### Using the list_institutions_with_http_info variant
2937
+ #### Using the list_managed_transactions_with_http_info variant
2167
2938
 
2168
2939
  This returns an Array which contains the response data, status code and headers.
2169
2940
 
2170
- > <Array(<InstitutionsResponseBody>, Integer, Hash)> list_institutions_with_http_info(opts)
2941
+ > <Array(<TransactionsResponseBody>, Integer, Hash)> list_managed_transactions_with_http_info(user_guid, member_guid, opts)
2171
2942
 
2172
2943
  ```ruby
2173
2944
  begin
2174
- # List institutions
2175
- data, status_code, headers = api_instance.list_institutions_with_http_info(opts)
2945
+ # List managed transactions
2946
+ data, status_code, headers = api_instance.list_managed_transactions_with_http_info(user_guid, member_guid, opts)
2176
2947
  p status_code # => 2xx
2177
2948
  p headers # => { ... }
2178
- p data # => <InstitutionsResponseBody>
2949
+ p data # => <TransactionsResponseBody>
2179
2950
  rescue MxPlatformRuby::ApiError => e
2180
- puts "Error when calling MxPlatformApi->list_institutions_with_http_info: #{e}"
2951
+ puts "Error when calling MxPlatformApi->list_managed_transactions_with_http_info: #{e}"
2181
2952
  end
2182
2953
  ```
2183
2954
 
@@ -2185,15 +2956,14 @@ end
2185
2956
 
2186
2957
  | Name | Type | Description | Notes |
2187
2958
  | ---- | ---- | ----------- | ----- |
2188
- | **name** | **String** | This will list only institutions in which the appended string appears. | [optional] |
2189
- | **supports_account_identification** | **Boolean** | Filter only institutions which support account identification. | [optional] |
2190
- | **supports_account_statement** | **Boolean** | Filter only institutions which support account statements. | [optional] |
2191
- | **supports_account_verification** | **Boolean** | Filter only institutions which support account verification. | [optional] |
2192
- | **supports_transaction_history** | **Boolean** | Filter only institutions which support extended transaction history. | [optional] |
2959
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
2960
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
2961
+ | **page** | **Integer** | Specify current page. | [optional] |
2962
+ | **records_per_page** | **Integer** | Specify records per page. | [optional] |
2193
2963
 
2194
2964
  ### Return type
2195
2965
 
2196
- [**InstitutionsResponseBody**](InstitutionsResponseBody.md)
2966
+ [**TransactionsResponseBody**](TransactionsResponseBody.md)
2197
2967
 
2198
2968
  ### Authorization
2199
2969
 
@@ -3063,7 +3833,7 @@ end
3063
3833
 
3064
3834
  ## list_transactions_by_tag
3065
3835
 
3066
- > <TransactionsResponseBody> list_transactions_by_tag(tag_guid, user_guid)
3836
+ > <TransactionsResponseBody> list_transactions_by_tag(tag_guid, user_guid, opts)
3067
3837
 
3068
3838
  List transactions by tag
3069
3839
 
@@ -3084,10 +3854,16 @@ end
3084
3854
  api_instance = MxPlatformRuby::MxPlatformApi.new
3085
3855
  tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # String | The unique id for a `tag`.
3086
3856
  user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
3857
+ opts = {
3858
+ from_date: '2015-09-20', # String | Filter transactions from this date.
3859
+ page: 1, # Integer | Specify current page.
3860
+ records_per_page: 10, # Integer | Specify records per page.
3861
+ to_date: '2019-10-20' # String | Filter transactions to this date.
3862
+ }
3087
3863
 
3088
3864
  begin
3089
3865
  # List transactions by tag
3090
- result = api_instance.list_transactions_by_tag(tag_guid, user_guid)
3866
+ result = api_instance.list_transactions_by_tag(tag_guid, user_guid, opts)
3091
3867
  p result
3092
3868
  rescue MxPlatformRuby::ApiError => e
3093
3869
  puts "Error when calling MxPlatformApi->list_transactions_by_tag: #{e}"
@@ -3098,12 +3874,12 @@ end
3098
3874
 
3099
3875
  This returns an Array which contains the response data, status code and headers.
3100
3876
 
3101
- > <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_tag_with_http_info(tag_guid, user_guid)
3877
+ > <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts)
3102
3878
 
3103
3879
  ```ruby
3104
3880
  begin
3105
3881
  # List transactions by tag
3106
- data, status_code, headers = api_instance.list_transactions_by_tag_with_http_info(tag_guid, user_guid)
3882
+ data, status_code, headers = api_instance.list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts)
3107
3883
  p status_code # => 2xx
3108
3884
  p headers # => { ... }
3109
3885
  p data # => <TransactionsResponseBody>
@@ -3118,6 +3894,10 @@ end
3118
3894
  | ---- | ---- | ----------- | ----- |
3119
3895
  | **tag_guid** | **String** | The unique id for a &#x60;tag&#x60;. | |
3120
3896
  | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
3897
+ | **from_date** | **String** | Filter transactions from this date. | [optional] |
3898
+ | **page** | **Integer** | Specify current page. | [optional] |
3899
+ | **records_per_page** | **Integer** | Specify records per page. | [optional] |
3900
+ | **to_date** | **String** | Filter transactions to this date. | [optional] |
3121
3901
 
3122
3902
  ### Return type
3123
3903
 
@@ -3523,29 +4303,247 @@ api_instance = MxPlatformRuby::MxPlatformApi.new
3523
4303
  institution_code = 'chase' # String | The institution_code of the institution.
3524
4304
 
3525
4305
  begin
3526
- # Read institution
3527
- result = api_instance.read_institution(institution_code)
4306
+ # Read institution
4307
+ result = api_instance.read_institution(institution_code)
4308
+ p result
4309
+ rescue MxPlatformRuby::ApiError => e
4310
+ puts "Error when calling MxPlatformApi->read_institution: #{e}"
4311
+ end
4312
+ ```
4313
+
4314
+ #### Using the read_institution_with_http_info variant
4315
+
4316
+ This returns an Array which contains the response data, status code and headers.
4317
+
4318
+ > <Array(<InstitutionResponseBody>, Integer, Hash)> read_institution_with_http_info(institution_code)
4319
+
4320
+ ```ruby
4321
+ begin
4322
+ # Read institution
4323
+ data, status_code, headers = api_instance.read_institution_with_http_info(institution_code)
4324
+ p status_code # => 2xx
4325
+ p headers # => { ... }
4326
+ p data # => <InstitutionResponseBody>
4327
+ rescue MxPlatformRuby::ApiError => e
4328
+ puts "Error when calling MxPlatformApi->read_institution_with_http_info: #{e}"
4329
+ end
4330
+ ```
4331
+
4332
+ ### Parameters
4333
+
4334
+ | Name | Type | Description | Notes |
4335
+ | ---- | ---- | ----------- | ----- |
4336
+ | **institution_code** | **String** | The institution_code of the institution. | |
4337
+
4338
+ ### Return type
4339
+
4340
+ [**InstitutionResponseBody**](InstitutionResponseBody.md)
4341
+
4342
+ ### Authorization
4343
+
4344
+ [basicAuth](../README.md#basicAuth)
4345
+
4346
+ ### HTTP request headers
4347
+
4348
+ - **Content-Type**: Not defined
4349
+ - **Accept**: application/vnd.mx.api.v1+json
4350
+
4351
+
4352
+ ## read_managed_account
4353
+
4354
+ > <AccountResponseBody> read_managed_account(member_guid, user_guid, account_guid)
4355
+
4356
+ Read managed account
4357
+
4358
+ Use this endpoint to read the attributes of a partner-managed account according to its unique guid.
4359
+
4360
+ ### Examples
4361
+
4362
+ ```ruby
4363
+ require 'time'
4364
+ require 'mx-platform-ruby'
4365
+ # setup authorization
4366
+ MxPlatformRuby.configure do |config|
4367
+ # Configure HTTP basic authorization: basicAuth
4368
+ config.username = 'YOUR USERNAME'
4369
+ config.password = 'YOUR PASSWORD'
4370
+ end
4371
+
4372
+ api_instance = MxPlatformRuby::MxPlatformApi.new
4373
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
4374
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
4375
+ account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
4376
+
4377
+ begin
4378
+ # Read managed account
4379
+ result = api_instance.read_managed_account(member_guid, user_guid, account_guid)
4380
+ p result
4381
+ rescue MxPlatformRuby::ApiError => e
4382
+ puts "Error when calling MxPlatformApi->read_managed_account: #{e}"
4383
+ end
4384
+ ```
4385
+
4386
+ #### Using the read_managed_account_with_http_info variant
4387
+
4388
+ This returns an Array which contains the response data, status code and headers.
4389
+
4390
+ > <Array(<AccountResponseBody>, Integer, Hash)> read_managed_account_with_http_info(member_guid, user_guid, account_guid)
4391
+
4392
+ ```ruby
4393
+ begin
4394
+ # Read managed account
4395
+ data, status_code, headers = api_instance.read_managed_account_with_http_info(member_guid, user_guid, account_guid)
4396
+ p status_code # => 2xx
4397
+ p headers # => { ... }
4398
+ p data # => <AccountResponseBody>
4399
+ rescue MxPlatformRuby::ApiError => e
4400
+ puts "Error when calling MxPlatformApi->read_managed_account_with_http_info: #{e}"
4401
+ end
4402
+ ```
4403
+
4404
+ ### Parameters
4405
+
4406
+ | Name | Type | Description | Notes |
4407
+ | ---- | ---- | ----------- | ----- |
4408
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
4409
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
4410
+ | **account_guid** | **String** | The unique id for an &#x60;account&#x60;. | |
4411
+
4412
+ ### Return type
4413
+
4414
+ [**AccountResponseBody**](AccountResponseBody.md)
4415
+
4416
+ ### Authorization
4417
+
4418
+ [basicAuth](../README.md#basicAuth)
4419
+
4420
+ ### HTTP request headers
4421
+
4422
+ - **Content-Type**: Not defined
4423
+ - **Accept**: application/vnd.mx.api.v1+json
4424
+
4425
+
4426
+ ## read_managed_member
4427
+
4428
+ > <MemberResponseBody> read_managed_member(member_guid, user_guid)
4429
+
4430
+ Read managed member
4431
+
4432
+ This endpoint returns the attributes of the specified partner-managed `member`.
4433
+
4434
+ ### Examples
4435
+
4436
+ ```ruby
4437
+ require 'time'
4438
+ require 'mx-platform-ruby'
4439
+ # setup authorization
4440
+ MxPlatformRuby.configure do |config|
4441
+ # Configure HTTP basic authorization: basicAuth
4442
+ config.username = 'YOUR USERNAME'
4443
+ config.password = 'YOUR PASSWORD'
4444
+ end
4445
+
4446
+ api_instance = MxPlatformRuby::MxPlatformApi.new
4447
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
4448
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
4449
+
4450
+ begin
4451
+ # Read managed member
4452
+ result = api_instance.read_managed_member(member_guid, user_guid)
4453
+ p result
4454
+ rescue MxPlatformRuby::ApiError => e
4455
+ puts "Error when calling MxPlatformApi->read_managed_member: #{e}"
4456
+ end
4457
+ ```
4458
+
4459
+ #### Using the read_managed_member_with_http_info variant
4460
+
4461
+ This returns an Array which contains the response data, status code and headers.
4462
+
4463
+ > <Array(<MemberResponseBody>, Integer, Hash)> read_managed_member_with_http_info(member_guid, user_guid)
4464
+
4465
+ ```ruby
4466
+ begin
4467
+ # Read managed member
4468
+ data, status_code, headers = api_instance.read_managed_member_with_http_info(member_guid, user_guid)
4469
+ p status_code # => 2xx
4470
+ p headers # => { ... }
4471
+ p data # => <MemberResponseBody>
4472
+ rescue MxPlatformRuby::ApiError => e
4473
+ puts "Error when calling MxPlatformApi->read_managed_member_with_http_info: #{e}"
4474
+ end
4475
+ ```
4476
+
4477
+ ### Parameters
4478
+
4479
+ | Name | Type | Description | Notes |
4480
+ | ---- | ---- | ----------- | ----- |
4481
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
4482
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
4483
+
4484
+ ### Return type
4485
+
4486
+ [**MemberResponseBody**](MemberResponseBody.md)
4487
+
4488
+ ### Authorization
4489
+
4490
+ [basicAuth](../README.md#basicAuth)
4491
+
4492
+ ### HTTP request headers
4493
+
4494
+ - **Content-Type**: Not defined
4495
+ - **Accept**: application/vnd.mx.api.v1+json
4496
+
4497
+
4498
+ ## read_managed_transaction
4499
+
4500
+ > <TransactionResponseBody> read_managed_transaction(member_guid, user_guid, transaction_guid)
4501
+
4502
+ Read managed transaction
4503
+
4504
+ Requests to this endpoint will return the attributes of the specified partner-managed `transaction`.
4505
+
4506
+ ### Examples
4507
+
4508
+ ```ruby
4509
+ require 'time'
4510
+ require 'mx-platform-ruby'
4511
+ # setup authorization
4512
+ MxPlatformRuby.configure do |config|
4513
+ # Configure HTTP basic authorization: basicAuth
4514
+ config.username = 'YOUR USERNAME'
4515
+ config.password = 'YOUR PASSWORD'
4516
+ end
4517
+
4518
+ api_instance = MxPlatformRuby::MxPlatformApi.new
4519
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
4520
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
4521
+ transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
4522
+
4523
+ begin
4524
+ # Read managed transaction
4525
+ result = api_instance.read_managed_transaction(member_guid, user_guid, transaction_guid)
3528
4526
  p result
3529
4527
  rescue MxPlatformRuby::ApiError => e
3530
- puts "Error when calling MxPlatformApi->read_institution: #{e}"
4528
+ puts "Error when calling MxPlatformApi->read_managed_transaction: #{e}"
3531
4529
  end
3532
4530
  ```
3533
4531
 
3534
- #### Using the read_institution_with_http_info variant
4532
+ #### Using the read_managed_transaction_with_http_info variant
3535
4533
 
3536
4534
  This returns an Array which contains the response data, status code and headers.
3537
4535
 
3538
- > <Array(<InstitutionResponseBody>, Integer, Hash)> read_institution_with_http_info(institution_code)
4536
+ > <Array(<TransactionResponseBody>, Integer, Hash)> read_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid)
3539
4537
 
3540
4538
  ```ruby
3541
4539
  begin
3542
- # Read institution
3543
- data, status_code, headers = api_instance.read_institution_with_http_info(institution_code)
4540
+ # Read managed transaction
4541
+ data, status_code, headers = api_instance.read_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid)
3544
4542
  p status_code # => 2xx
3545
4543
  p headers # => { ... }
3546
- p data # => <InstitutionResponseBody>
4544
+ p data # => <TransactionResponseBody>
3547
4545
  rescue MxPlatformRuby::ApiError => e
3548
- puts "Error when calling MxPlatformApi->read_institution_with_http_info: #{e}"
4546
+ puts "Error when calling MxPlatformApi->read_managed_transaction_with_http_info: #{e}"
3549
4547
  end
3550
4548
  ```
3551
4549
 
@@ -3553,11 +4551,13 @@ end
3553
4551
 
3554
4552
  | Name | Type | Description | Notes |
3555
4553
  | ---- | ---- | ----------- | ----- |
3556
- | **institution_code** | **String** | The institution_code of the institution. | |
4554
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
4555
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
4556
+ | **transaction_guid** | **String** | The unique id for a &#x60;transaction&#x60;. | |
3557
4557
 
3558
4558
  ### Return type
3559
4559
 
3560
- [**InstitutionResponseBody**](InstitutionResponseBody.md)
4560
+ [**TransactionResponseBody**](TransactionResponseBody.md)
3561
4561
 
3562
4562
  ### Authorization
3563
4563
 
@@ -3783,6 +4783,76 @@ end
3783
4783
  - **Accept**: application/vnd.mx.api.v1+json
3784
4784
 
3785
4785
 
4786
+ ## read_merchant_location
4787
+
4788
+ > <MerchantLocationResponseBody> read_merchant_location(merchant_location_guid)
4789
+
4790
+ Read merchant location
4791
+
4792
+ This endpoint returns the specified merchant_location resource.
4793
+
4794
+ ### Examples
4795
+
4796
+ ```ruby
4797
+ require 'time'
4798
+ require 'mx-platform-ruby'
4799
+ # setup authorization
4800
+ MxPlatformRuby.configure do |config|
4801
+ # Configure HTTP basic authorization: basicAuth
4802
+ config.username = 'YOUR USERNAME'
4803
+ config.password = 'YOUR PASSWORD'
4804
+ end
4805
+
4806
+ api_instance = MxPlatformRuby::MxPlatformApi.new
4807
+ merchant_location_guid = 'MCH-09466f0a-fb58-9d1a-bae2-2af0afbea621' # String | The unique id for a `merchant_location`.
4808
+
4809
+ begin
4810
+ # Read merchant location
4811
+ result = api_instance.read_merchant_location(merchant_location_guid)
4812
+ p result
4813
+ rescue MxPlatformRuby::ApiError => e
4814
+ puts "Error when calling MxPlatformApi->read_merchant_location: #{e}"
4815
+ end
4816
+ ```
4817
+
4818
+ #### Using the read_merchant_location_with_http_info variant
4819
+
4820
+ This returns an Array which contains the response data, status code and headers.
4821
+
4822
+ > <Array(<MerchantLocationResponseBody>, Integer, Hash)> read_merchant_location_with_http_info(merchant_location_guid)
4823
+
4824
+ ```ruby
4825
+ begin
4826
+ # Read merchant location
4827
+ data, status_code, headers = api_instance.read_merchant_location_with_http_info(merchant_location_guid)
4828
+ p status_code # => 2xx
4829
+ p headers # => { ... }
4830
+ p data # => <MerchantLocationResponseBody>
4831
+ rescue MxPlatformRuby::ApiError => e
4832
+ puts "Error when calling MxPlatformApi->read_merchant_location_with_http_info: #{e}"
4833
+ end
4834
+ ```
4835
+
4836
+ ### Parameters
4837
+
4838
+ | Name | Type | Description | Notes |
4839
+ | ---- | ---- | ----------- | ----- |
4840
+ | **merchant_location_guid** | **String** | The unique id for a &#x60;merchant_location&#x60;. | |
4841
+
4842
+ ### Return type
4843
+
4844
+ [**MerchantLocationResponseBody**](MerchantLocationResponseBody.md)
4845
+
4846
+ ### Authorization
4847
+
4848
+ [basicAuth](../README.md#basicAuth)
4849
+
4850
+ ### HTTP request headers
4851
+
4852
+ - **Content-Type**: Not defined
4853
+ - **Accept**: application/vnd.mx.api.v1+json
4854
+
4855
+
3786
4856
  ## read_statement_by_member
3787
4857
 
3788
4858
  > <StatementResponseBody> read_statement_by_member(member_guid, statement_guid, user_guid)
@@ -4314,7 +5384,8 @@ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique i
4314
5384
  user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
4315
5385
  opts = {
4316
5386
  referral_source: 'APP', # String | Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`.
4317
- ui_message_webview_url_scheme: 'mx' # String | A scheme for routing the user back to the application state they were previously in.
5387
+ ui_message_webview_url_scheme: 'mx', # String | A scheme for routing the user back to the application state they were previously in.
5388
+ skip_aggregation: false # Boolean | Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page.
4318
5389
  }
4319
5390
 
4320
5391
  begin
@@ -4352,6 +5423,7 @@ end
4352
5423
  | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
4353
5424
  | **referral_source** | **String** | Must be either &#x60;BROWSER&#x60; or &#x60;APP&#x60; depending on the implementation. Defaults to &#x60;BROWSER&#x60;. | [optional] |
4354
5425
  | **ui_message_webview_url_scheme** | **String** | A scheme for routing the user back to the application state they were previously in. | [optional] |
5426
+ | **skip_aggregation** | **Boolean** | Setting this parameter to &#x60;true&#x60; will prevent the member from automatically aggregating after being redirected from the authorization page. | [optional] |
4355
5427
 
4356
5428
  ### Return type
4357
5429
 
@@ -4667,6 +5739,232 @@ end
4667
5739
  - **Accept**: application/vnd.mx.api.v1+json
4668
5740
 
4669
5741
 
5742
+ ## update_managed_account
5743
+
5744
+ > <AccountResponseBody> update_managed_account(member_guid, user_guid, account_guid, managed_account_update_request_body)
5745
+
5746
+ Update managed account
5747
+
5748
+ Use this endpoint to update the attributes of a partner-managed account according to its unique GUID.
5749
+
5750
+ ### Examples
5751
+
5752
+ ```ruby
5753
+ require 'time'
5754
+ require 'mx-platform-ruby'
5755
+ # setup authorization
5756
+ MxPlatformRuby.configure do |config|
5757
+ # Configure HTTP basic authorization: basicAuth
5758
+ config.username = 'YOUR USERNAME'
5759
+ config.password = 'YOUR PASSWORD'
5760
+ end
5761
+
5762
+ api_instance = MxPlatformRuby::MxPlatformApi.new
5763
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
5764
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
5765
+ account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
5766
+ managed_account_update_request_body = MxPlatformRuby::ManagedAccountUpdateRequestBody.new # ManagedAccountUpdateRequestBody | Managed account object to be updated (While no single parameter is required, the request body can't be empty)
5767
+
5768
+ begin
5769
+ # Update managed account
5770
+ result = api_instance.update_managed_account(member_guid, user_guid, account_guid, managed_account_update_request_body)
5771
+ p result
5772
+ rescue MxPlatformRuby::ApiError => e
5773
+ puts "Error when calling MxPlatformApi->update_managed_account: #{e}"
5774
+ end
5775
+ ```
5776
+
5777
+ #### Using the update_managed_account_with_http_info variant
5778
+
5779
+ This returns an Array which contains the response data, status code and headers.
5780
+
5781
+ > <Array(<AccountResponseBody>, Integer, Hash)> update_managed_account_with_http_info(member_guid, user_guid, account_guid, managed_account_update_request_body)
5782
+
5783
+ ```ruby
5784
+ begin
5785
+ # Update managed account
5786
+ data, status_code, headers = api_instance.update_managed_account_with_http_info(member_guid, user_guid, account_guid, managed_account_update_request_body)
5787
+ p status_code # => 2xx
5788
+ p headers # => { ... }
5789
+ p data # => <AccountResponseBody>
5790
+ rescue MxPlatformRuby::ApiError => e
5791
+ puts "Error when calling MxPlatformApi->update_managed_account_with_http_info: #{e}"
5792
+ end
5793
+ ```
5794
+
5795
+ ### Parameters
5796
+
5797
+ | Name | Type | Description | Notes |
5798
+ | ---- | ---- | ----------- | ----- |
5799
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
5800
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
5801
+ | **account_guid** | **String** | The unique id for an &#x60;account&#x60;. | |
5802
+ | **managed_account_update_request_body** | [**ManagedAccountUpdateRequestBody**](ManagedAccountUpdateRequestBody.md) | Managed account object to be updated (While no single parameter is required, the request body can&#39;t be empty) | |
5803
+
5804
+ ### Return type
5805
+
5806
+ [**AccountResponseBody**](AccountResponseBody.md)
5807
+
5808
+ ### Authorization
5809
+
5810
+ [basicAuth](../README.md#basicAuth)
5811
+
5812
+ ### HTTP request headers
5813
+
5814
+ - **Content-Type**: application/json
5815
+ - **Accept**: application/vnd.mx.api.v1+json
5816
+
5817
+
5818
+ ## update_managed_member
5819
+
5820
+ > <MemberResponseBody> update_managed_member(member_guid, user_guid, managed_member_update_request_body)
5821
+
5822
+ Update managed member
5823
+
5824
+ Use this endpoint to update the attributes of the specified partner_managed `member`.
5825
+
5826
+ ### Examples
5827
+
5828
+ ```ruby
5829
+ require 'time'
5830
+ require 'mx-platform-ruby'
5831
+ # setup authorization
5832
+ MxPlatformRuby.configure do |config|
5833
+ # Configure HTTP basic authorization: basicAuth
5834
+ config.username = 'YOUR USERNAME'
5835
+ config.password = 'YOUR PASSWORD'
5836
+ end
5837
+
5838
+ api_instance = MxPlatformRuby::MxPlatformApi.new
5839
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
5840
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
5841
+ managed_member_update_request_body = MxPlatformRuby::ManagedMemberUpdateRequestBody.new # ManagedMemberUpdateRequestBody | Managed member object to be updated (While no single parameter is required, the request body can't be empty)
5842
+
5843
+ begin
5844
+ # Update managed member
5845
+ result = api_instance.update_managed_member(member_guid, user_guid, managed_member_update_request_body)
5846
+ p result
5847
+ rescue MxPlatformRuby::ApiError => e
5848
+ puts "Error when calling MxPlatformApi->update_managed_member: #{e}"
5849
+ end
5850
+ ```
5851
+
5852
+ #### Using the update_managed_member_with_http_info variant
5853
+
5854
+ This returns an Array which contains the response data, status code and headers.
5855
+
5856
+ > <Array(<MemberResponseBody>, Integer, Hash)> update_managed_member_with_http_info(member_guid, user_guid, managed_member_update_request_body)
5857
+
5858
+ ```ruby
5859
+ begin
5860
+ # Update managed member
5861
+ data, status_code, headers = api_instance.update_managed_member_with_http_info(member_guid, user_guid, managed_member_update_request_body)
5862
+ p status_code # => 2xx
5863
+ p headers # => { ... }
5864
+ p data # => <MemberResponseBody>
5865
+ rescue MxPlatformRuby::ApiError => e
5866
+ puts "Error when calling MxPlatformApi->update_managed_member_with_http_info: #{e}"
5867
+ end
5868
+ ```
5869
+
5870
+ ### Parameters
5871
+
5872
+ | Name | Type | Description | Notes |
5873
+ | ---- | ---- | ----------- | ----- |
5874
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
5875
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
5876
+ | **managed_member_update_request_body** | [**ManagedMemberUpdateRequestBody**](ManagedMemberUpdateRequestBody.md) | Managed member object to be updated (While no single parameter is required, the request body can&#39;t be empty) | |
5877
+
5878
+ ### Return type
5879
+
5880
+ [**MemberResponseBody**](MemberResponseBody.md)
5881
+
5882
+ ### Authorization
5883
+
5884
+ [basicAuth](../README.md#basicAuth)
5885
+
5886
+ ### HTTP request headers
5887
+
5888
+ - **Content-Type**: application/json
5889
+ - **Accept**: application/vnd.mx.api.v1+json
5890
+
5891
+
5892
+ ## update_managed_transaction
5893
+
5894
+ > <TransactionResponseBody> update_managed_transaction(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body)
5895
+
5896
+ Update managed transaction
5897
+
5898
+ Use this endpoint to update the attributes of the specified partner_managed `transaction`.
5899
+
5900
+ ### Examples
5901
+
5902
+ ```ruby
5903
+ require 'time'
5904
+ require 'mx-platform-ruby'
5905
+ # setup authorization
5906
+ MxPlatformRuby.configure do |config|
5907
+ # Configure HTTP basic authorization: basicAuth
5908
+ config.username = 'YOUR USERNAME'
5909
+ config.password = 'YOUR PASSWORD'
5910
+ end
5911
+
5912
+ api_instance = MxPlatformRuby::MxPlatformApi.new
5913
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
5914
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
5915
+ transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
5916
+ managed_transaction_update_request_body = MxPlatformRuby::ManagedTransactionUpdateRequestBody.new # ManagedTransactionUpdateRequestBody | Managed transaction object to be updated (While no single parameter is required, the request body can't be empty)
5917
+
5918
+ begin
5919
+ # Update managed transaction
5920
+ result = api_instance.update_managed_transaction(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body)
5921
+ p result
5922
+ rescue MxPlatformRuby::ApiError => e
5923
+ puts "Error when calling MxPlatformApi->update_managed_transaction: #{e}"
5924
+ end
5925
+ ```
5926
+
5927
+ #### Using the update_managed_transaction_with_http_info variant
5928
+
5929
+ This returns an Array which contains the response data, status code and headers.
5930
+
5931
+ > <Array(<TransactionResponseBody>, Integer, Hash)> update_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body)
5932
+
5933
+ ```ruby
5934
+ begin
5935
+ # Update managed transaction
5936
+ data, status_code, headers = api_instance.update_managed_transaction_with_http_info(member_guid, user_guid, transaction_guid, managed_transaction_update_request_body)
5937
+ p status_code # => 2xx
5938
+ p headers # => { ... }
5939
+ p data # => <TransactionResponseBody>
5940
+ rescue MxPlatformRuby::ApiError => e
5941
+ puts "Error when calling MxPlatformApi->update_managed_transaction_with_http_info: #{e}"
5942
+ end
5943
+ ```
5944
+
5945
+ ### Parameters
5946
+
5947
+ | Name | Type | Description | Notes |
5948
+ | ---- | ---- | ----------- | ----- |
5949
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
5950
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
5951
+ | **transaction_guid** | **String** | The unique id for a &#x60;transaction&#x60;. | |
5952
+ | **managed_transaction_update_request_body** | [**ManagedTransactionUpdateRequestBody**](ManagedTransactionUpdateRequestBody.md) | Managed transaction object to be updated (While no single parameter is required, the request body can&#39;t be empty) | |
5953
+
5954
+ ### Return type
5955
+
5956
+ [**TransactionResponseBody**](TransactionResponseBody.md)
5957
+
5958
+ ### Authorization
5959
+
5960
+ [basicAuth](../README.md#basicAuth)
5961
+
5962
+ ### HTTP request headers
5963
+
5964
+ - **Content-Type**: application/json
5965
+ - **Accept**: application/vnd.mx.api.v1+json
5966
+
5967
+
4670
5968
  ## update_member
4671
5969
 
4672
5970
  > <MemberResponseBody> update_member(member_guid, user_guid, member_update_request_body)