mx-platform-ruby 1.10.0 → 1.10.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (589) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/docs/ACHResponse.md +74 -0
  4. data/docs/ACHReturnCreateRequest.md +48 -0
  5. data/docs/ACHReturnCreateRequestBody.md +18 -0
  6. data/docs/ACHReturnResponseBody.md +18 -0
  7. data/docs/{HoldingsResponseBody.md → ACHReturnsResponseBody.md} +4 -4
  8. data/docs/AccountCreateRequest.md +9 -9
  9. data/docs/AccountNumberResponse.md +3 -3
  10. data/docs/AccountResponse.md +37 -37
  11. data/docs/AccountUpdateRequest.md +30 -30
  12. data/docs/AccountsApi.md +780 -0
  13. data/docs/AchReturnApi.md +234 -0
  14. data/docs/AuthorizationCodeResponseBody.md +1 -1
  15. data/docs/BudgetResponse.md +1 -1
  16. data/docs/BudgetsApi.md +115 -115
  17. data/docs/CategoriesApi.md +600 -0
  18. data/docs/CategoryCreateRequest.md +1 -1
  19. data/docs/CategoryResponse.md +1 -1
  20. data/docs/ConnectWidgetRequest.md +5 -3
  21. data/docs/CreditCardProduct.md +1 -1
  22. data/docs/GoalResponse.md +1 -1
  23. data/docs/GoalsApi.md +117 -113
  24. data/docs/GoalsResponse.md +1 -1
  25. data/docs/ImageOptionResponse.md +0 -2
  26. data/docs/InsightResponse.md +3 -1
  27. data/docs/InsightResponseBody.md +1 -1
  28. data/docs/InsightUpdateRequestBody.md +18 -0
  29. data/docs/InsightsApi.md +170 -91
  30. data/docs/InstitutionResponse.md +15 -7
  31. data/docs/InstitutionsApi.md +319 -0
  32. data/docs/InvestmentHoldingResponse.md +90 -0
  33. data/docs/InvestmentHoldingResponseBody.md +18 -0
  34. data/docs/InvestmentHoldingsApi.md +386 -0
  35. data/docs/InvestmentHoldingsDeactivation.md +20 -0
  36. data/docs/InvestmentHoldingsResponseBody.md +20 -0
  37. data/docs/ManagedAccountCreateRequest.md +15 -15
  38. data/docs/ManagedAccountUpdateRequest.md +14 -14
  39. data/docs/ManagedDataApi.md +1228 -0
  40. data/docs/ManagedTransactionCreateRequest.md +1 -1
  41. data/docs/MemberCreateRequest.md +5 -3
  42. data/docs/MemberCreateRequestBody.md +3 -3
  43. data/docs/MemberElements.md +22 -0
  44. data/docs/MemberResponse.md +1 -3
  45. data/docs/MemberStatusResponse.md +2 -2
  46. data/docs/MemberUpdateRequest.md +4 -2
  47. data/docs/MembersApi.md +997 -0
  48. data/docs/MerchantsApi.md +226 -0
  49. data/docs/{MicrodepositRequest.md → MicrodepositElements.md} +7 -7
  50. data/docs/MicrodepositRequestBody.md +1 -1
  51. data/docs/MicrodepositResponse.md +0 -14
  52. data/docs/MicrodepositResponseBody.md +1 -1
  53. data/docs/MicrodepositResponseBodyMicroDepositInner.md +44 -0
  54. data/docs/MicrodepositVerifyRequest.md +4 -4
  55. data/docs/MicrodepositsApi.md +153 -82
  56. data/docs/MonthlyCashFlowProfileApi.md +151 -0
  57. data/docs/MonthlyCashFlowResponse.md +3 -3
  58. data/docs/NotificationResponse.md +36 -0
  59. data/docs/NotificationResponseBody.md +18 -0
  60. data/docs/NotificationsApi.md +236 -0
  61. data/docs/NotificationsResponseBody.md +18 -0
  62. data/docs/OptionResponse.md +0 -2
  63. data/docs/PaymentAccount.md +34 -0
  64. data/docs/PaymentAccountBody.md +18 -0
  65. data/docs/PaymentAccountBodyPaymentAccount.md +40 -0
  66. data/docs/PaymentProcessorAuthorizationCodeRequest.md +3 -3
  67. data/docs/ProcessorAccountNumber.md +34 -0
  68. data/docs/ProcessorAccountNumberBody.md +18 -0
  69. data/docs/ProcessorAccountNumberBodyAccountNumbersInner.md +40 -0
  70. data/docs/ProcessorOwner.md +34 -0
  71. data/docs/ProcessorOwnerBody.md +20 -0
  72. data/docs/ProcessorOwnerBodyAccountOwnersInner.md +40 -0
  73. data/docs/ProcessorTokenApi.md +490 -0
  74. data/docs/RepeatingTransactionResponse.md +40 -0
  75. data/docs/RepeatingTransactionsResponseBody.md +18 -0
  76. data/docs/{RewardsResponse.md → RewardElements.md} +3 -9
  77. data/docs/RewardResponseBody.md +1 -1
  78. data/docs/RewardsApi.md +299 -0
  79. data/docs/RewardsResponseBody.md +1 -1
  80. data/docs/{RewardResponse.md → RewardsResponseBodyRewardsInner.md} +8 -8
  81. data/docs/ScheduledPaymentsResponseBody.md +3 -3
  82. data/docs/SpendingPlanApi.md +142 -63
  83. data/docs/SpendingPlanIterationItemResponse.md +5 -5
  84. data/docs/StatementsApi.md +309 -0
  85. data/docs/StatementsResponseBody.md +3 -3
  86. data/docs/TaggingsApi.md +377 -0
  87. data/docs/TaggingsResponseBody.md +3 -3
  88. data/docs/TagsApi.md +379 -0
  89. data/docs/TagsResponseBody.md +3 -3
  90. data/docs/TokenRequestBody.md +18 -0
  91. data/docs/TokenResponse.md +24 -0
  92. data/docs/TokenResponseBody.md +18 -0
  93. data/docs/TransactionIncludesResponse.md +112 -0
  94. data/docs/TransactionIncludesResponseAllOfClassification.md +20 -0
  95. data/docs/TransactionIncludesResponseAllOfGeolocation.md +24 -0
  96. data/docs/TransactionIncludesResponseAllOfMerchant.md +24 -0
  97. data/docs/TransactionIncludesResponseAllOfRepeatingTransaction.md +22 -0
  98. data/docs/TransactionResponse.md +38 -36
  99. data/docs/TransactionRulesApi.md +305 -0
  100. data/docs/TransactionRulesResponseBody.md +3 -3
  101. data/docs/TransactionUpdateRequest.md +7 -1
  102. data/docs/TransactionsApi.md +1232 -14
  103. data/docs/TransactionsResponseBody.md +3 -3
  104. data/docs/TransactionsResponseBodyIncludes.md +20 -0
  105. data/docs/UsersApi.md +375 -0
  106. data/docs/UsersResponseBody.md +3 -3
  107. data/docs/VCResponse.md +18 -0
  108. data/docs/VerifiableCredentialsApi.md +232 -0
  109. data/docs/WidgetRequest.md +31 -23
  110. data/docs/WidgetsApi.md +244 -0
  111. data/lib/mx-platform-ruby/api/accounts_api.rb +781 -0
  112. data/lib/mx-platform-ruby/api/ach_return_api.rb +231 -0
  113. data/lib/mx-platform-ruby/api/budgets_api.rb +131 -131
  114. data/lib/mx-platform-ruby/api/categories_api.rb +576 -0
  115. data/lib/mx-platform-ruby/api/goals_api.rb +148 -134
  116. data/lib/mx-platform-ruby/api/insights_api.rb +162 -87
  117. data/lib/mx-platform-ruby/api/institutions_api.rb +301 -0
  118. data/lib/mx-platform-ruby/api/investment_holdings_api.rb +373 -0
  119. data/lib/mx-platform-ruby/api/managed_data_api.rb +1265 -0
  120. data/lib/mx-platform-ruby/api/members_api.rb +977 -0
  121. data/lib/mx-platform-ruby/api/merchants_api.rb +214 -0
  122. data/lib/mx-platform-ruby/api/microdeposits_api.rb +159 -96
  123. data/lib/mx-platform-ruby/api/monthly_cash_flow_profile_api.rb +159 -0
  124. data/lib/mx-platform-ruby/api/notifications_api.rb +243 -0
  125. data/lib/mx-platform-ruby/api/processor_token_api.rb +450 -0
  126. data/lib/mx-platform-ruby/api/rewards_api.rb +298 -0
  127. data/lib/mx-platform-ruby/api/spending_plan_api.rb +139 -64
  128. data/lib/mx-platform-ruby/api/statements_api.rb +316 -0
  129. data/lib/mx-platform-ruby/api/taggings_api.rb +381 -0
  130. data/lib/mx-platform-ruby/api/tags_api.rb +388 -0
  131. data/lib/mx-platform-ruby/api/transaction_rules_api.rb +314 -0
  132. data/lib/mx-platform-ruby/api/transactions_api.rb +1237 -15
  133. data/lib/mx-platform-ruby/api/users_api.rb +367 -0
  134. data/lib/mx-platform-ruby/api/verifiable_credentials_api.rb +235 -0
  135. data/lib/mx-platform-ruby/api/widgets_api.rb +260 -0
  136. data/lib/mx-platform-ruby/api_client.rb +2 -2
  137. data/lib/mx-platform-ruby/api_error.rb +2 -2
  138. data/lib/mx-platform-ruby/configuration.rb +12 -5
  139. data/lib/mx-platform-ruby/models/account_create_request.rb +2 -2
  140. data/lib/mx-platform-ruby/models/account_create_request_body.rb +2 -2
  141. data/lib/mx-platform-ruby/models/account_number_response.rb +13 -13
  142. data/lib/mx-platform-ruby/models/account_numbers_response_body.rb +2 -2
  143. data/lib/mx-platform-ruby/models/account_owner_response.rb +2 -2
  144. data/lib/mx-platform-ruby/models/account_owners_response_body.rb +2 -2
  145. data/lib/mx-platform-ruby/models/account_response.rb +2 -2
  146. data/lib/mx-platform-ruby/models/account_response_body.rb +2 -2
  147. data/lib/mx-platform-ruby/models/account_update_request.rb +23 -2
  148. data/lib/mx-platform-ruby/models/account_update_request_body.rb +2 -2
  149. data/lib/mx-platform-ruby/models/accounts_response_body.rb +2 -2
  150. data/lib/mx-platform-ruby/models/ach_response.rb +485 -0
  151. data/lib/mx-platform-ruby/models/ach_return_create_request.rb +400 -0
  152. data/lib/mx-platform-ruby/models/ach_return_create_request_body.rb +214 -0
  153. data/lib/mx-platform-ruby/models/ach_return_response_body.rb +214 -0
  154. data/lib/mx-platform-ruby/models/{holdings_response_body.rb → ach_returns_response_body.rb} +13 -13
  155. data/lib/mx-platform-ruby/models/authorization_code_request.rb +2 -2
  156. data/lib/mx-platform-ruby/models/authorization_code_request_body.rb +2 -2
  157. data/lib/mx-platform-ruby/models/authorization_code_response.rb +2 -2
  158. data/lib/mx-platform-ruby/models/authorization_code_response_body.rb +4 -6
  159. data/lib/mx-platform-ruby/models/budget_create_request.rb +2 -2
  160. data/lib/mx-platform-ruby/models/budget_create_request_body.rb +2 -2
  161. data/lib/mx-platform-ruby/models/budget_response.rb +2 -2
  162. data/lib/mx-platform-ruby/models/budget_response_body.rb +2 -2
  163. data/lib/mx-platform-ruby/models/budget_update_request.rb +2 -2
  164. data/lib/mx-platform-ruby/models/budget_update_request_body.rb +2 -2
  165. data/lib/mx-platform-ruby/models/categories_response_body.rb +2 -2
  166. data/lib/mx-platform-ruby/models/category_create_request.rb +9 -2
  167. data/lib/mx-platform-ruby/models/category_create_request_body.rb +2 -2
  168. data/lib/mx-platform-ruby/models/category_response.rb +3 -2
  169. data/lib/mx-platform-ruby/models/category_response_body.rb +2 -2
  170. data/lib/mx-platform-ruby/models/category_update_request.rb +2 -2
  171. data/lib/mx-platform-ruby/models/category_update_request_body.rb +2 -2
  172. data/lib/mx-platform-ruby/models/challenge_response.rb +2 -2
  173. data/lib/mx-platform-ruby/models/challenges_response_body.rb +2 -2
  174. data/lib/mx-platform-ruby/models/connect_widget_request.rb +13 -3
  175. data/lib/mx-platform-ruby/models/connect_widget_request_body.rb +2 -2
  176. data/lib/mx-platform-ruby/models/connect_widget_response.rb +2 -2
  177. data/lib/mx-platform-ruby/models/connect_widget_response_body.rb +2 -2
  178. data/lib/mx-platform-ruby/models/credential_request.rb +2 -2
  179. data/lib/mx-platform-ruby/models/credential_response.rb +2 -2
  180. data/lib/mx-platform-ruby/models/credentials_response_body.rb +2 -2
  181. data/lib/mx-platform-ruby/models/credit_card_product.rb +4 -2
  182. data/lib/mx-platform-ruby/models/credit_card_product_response.rb +2 -2
  183. data/lib/mx-platform-ruby/models/enhance_transaction_response.rb +2 -2
  184. data/lib/mx-platform-ruby/models/enhance_transactions_request.rb +2 -2
  185. data/lib/mx-platform-ruby/models/enhance_transactions_request_body.rb +2 -2
  186. data/lib/mx-platform-ruby/models/enhance_transactions_response_body.rb +2 -2
  187. data/lib/mx-platform-ruby/models/goal_request.rb +2 -2
  188. data/lib/mx-platform-ruby/models/goal_request_body.rb +2 -2
  189. data/lib/mx-platform-ruby/models/goal_response.rb +2 -2
  190. data/lib/mx-platform-ruby/models/goal_response_body.rb +2 -2
  191. data/lib/mx-platform-ruby/models/goals_response.rb +2 -2
  192. data/lib/mx-platform-ruby/models/goals_response_body.rb +2 -2
  193. data/lib/mx-platform-ruby/models/image_option_response.rb +3 -13
  194. data/lib/mx-platform-ruby/models/insight_response.rb +13 -3
  195. data/lib/mx-platform-ruby/models/insight_response_body.rb +4 -6
  196. data/lib/mx-platform-ruby/models/insight_update_request.rb +2 -2
  197. data/lib/mx-platform-ruby/models/{tax_document_response_body.rb → insight_update_request_body.rb} +12 -12
  198. data/lib/mx-platform-ruby/models/insights_response_body.rb +2 -2
  199. data/lib/mx-platform-ruby/models/institution_response.rb +35 -3
  200. data/lib/mx-platform-ruby/models/institution_response_body.rb +2 -2
  201. data/lib/mx-platform-ruby/models/institutions_response_body.rb +2 -2
  202. data/lib/mx-platform-ruby/models/investment_holding_response.rb +575 -0
  203. data/lib/mx-platform-ruby/models/investment_holding_response_body.rb +214 -0
  204. data/lib/mx-platform-ruby/models/investment_holdings_deactivation.rb +225 -0
  205. data/lib/mx-platform-ruby/models/investment_holdings_response_body.rb +225 -0
  206. data/lib/mx-platform-ruby/models/managed_account_create_request.rb +9 -2
  207. data/lib/mx-platform-ruby/models/managed_account_create_request_body.rb +2 -2
  208. data/lib/mx-platform-ruby/models/managed_account_update_request.rb +2 -2
  209. data/lib/mx-platform-ruby/models/managed_account_update_request_body.rb +2 -2
  210. data/lib/mx-platform-ruby/models/managed_member_create_request.rb +2 -2
  211. data/lib/mx-platform-ruby/models/managed_member_create_request_body.rb +2 -2
  212. data/lib/mx-platform-ruby/models/managed_member_update_request.rb +2 -2
  213. data/lib/mx-platform-ruby/models/managed_member_update_request_body.rb +2 -2
  214. data/lib/mx-platform-ruby/models/managed_transaction_create_request.rb +9 -2
  215. data/lib/mx-platform-ruby/models/managed_transaction_create_request_body.rb +2 -2
  216. data/lib/mx-platform-ruby/models/managed_transaction_update_request.rb +2 -2
  217. data/lib/mx-platform-ruby/models/managed_transaction_update_request_body.rb +2 -2
  218. data/lib/mx-platform-ruby/models/member_create_request.rb +40 -6
  219. data/lib/mx-platform-ruby/models/member_create_request_body.rb +3 -2
  220. data/lib/mx-platform-ruby/models/member_elements.rb +232 -0
  221. data/lib/mx-platform-ruby/models/member_response.rb +3 -13
  222. data/lib/mx-platform-ruby/models/member_response_body.rb +2 -2
  223. data/lib/mx-platform-ruby/models/member_resume_request.rb +2 -2
  224. data/lib/mx-platform-ruby/models/member_resume_request_body.rb +2 -2
  225. data/lib/mx-platform-ruby/models/member_status_response.rb +13 -13
  226. data/lib/mx-platform-ruby/models/member_status_response_body.rb +2 -2
  227. data/lib/mx-platform-ruby/models/member_update_request.rb +40 -6
  228. data/lib/mx-platform-ruby/models/member_update_request_body.rb +2 -2
  229. data/lib/mx-platform-ruby/models/members_response_body.rb +2 -2
  230. data/lib/mx-platform-ruby/models/merchant_location_response.rb +2 -2
  231. data/lib/mx-platform-ruby/models/merchant_location_response_body.rb +2 -2
  232. data/lib/mx-platform-ruby/models/merchant_response.rb +2 -2
  233. data/lib/mx-platform-ruby/models/merchant_response_body.rb +2 -2
  234. data/lib/mx-platform-ruby/models/merchants_response_body.rb +2 -2
  235. data/lib/mx-platform-ruby/models/{microdeposit_request.rb → microdeposit_elements.rb} +29 -29
  236. data/lib/mx-platform-ruby/models/microdeposit_request_body.rb +3 -3
  237. data/lib/mx-platform-ruby/models/microdeposit_response.rb +5 -66
  238. data/lib/mx-platform-ruby/models/microdeposit_response_body.rb +6 -4
  239. data/lib/mx-platform-ruby/models/microdeposit_response_body_micro_deposit_inner.rb +362 -0
  240. data/lib/mx-platform-ruby/models/microdeposit_verify_request.rb +4 -4
  241. data/lib/mx-platform-ruby/models/microdeposit_verify_request_body.rb +2 -2
  242. data/lib/mx-platform-ruby/models/microdeposits_response_body.rb +2 -2
  243. data/lib/mx-platform-ruby/models/monthly_cash_flow_profile_request.rb +2 -2
  244. data/lib/mx-platform-ruby/models/monthly_cash_flow_profile_request_body.rb +2 -2
  245. data/lib/mx-platform-ruby/models/monthly_cash_flow_response.rb +4 -3
  246. data/lib/mx-platform-ruby/models/monthly_cash_flow_response_body.rb +2 -2
  247. data/lib/mx-platform-ruby/models/notification_response.rb +305 -0
  248. data/lib/mx-platform-ruby/models/{tax_documents_response_body.rb → notification_response_body.rb} +12 -23
  249. data/lib/mx-platform-ruby/models/notifications_response_body.rb +216 -0
  250. data/lib/mx-platform-ruby/models/o_auth_window_response.rb +2 -2
  251. data/lib/mx-platform-ruby/models/o_auth_window_response_body.rb +2 -2
  252. data/lib/mx-platform-ruby/models/option_response.rb +3 -13
  253. data/lib/mx-platform-ruby/models/pagination_response.rb +2 -2
  254. data/lib/mx-platform-ruby/models/{tax_document_response.rb → payment_account.rb} +66 -76
  255. data/lib/mx-platform-ruby/models/payment_account_body.rb +214 -0
  256. data/lib/mx-platform-ruby/models/payment_account_body_payment_account.rb +330 -0
  257. data/lib/mx-platform-ruby/models/payment_processor_authorization_code_request.rb +23 -5
  258. data/lib/mx-platform-ruby/models/payment_processor_authorization_code_request_body.rb +2 -2
  259. data/lib/mx-platform-ruby/models/payment_processor_authorization_code_response.rb +2 -2
  260. data/lib/mx-platform-ruby/models/payment_processor_authorization_code_response_body.rb +2 -2
  261. data/lib/mx-platform-ruby/models/processor_account_number.rb +292 -0
  262. data/lib/mx-platform-ruby/models/processor_account_number_body.rb +216 -0
  263. data/lib/mx-platform-ruby/models/processor_account_number_body_account_numbers_inner.rb +327 -0
  264. data/lib/mx-platform-ruby/models/processor_owner.rb +295 -0
  265. data/lib/mx-platform-ruby/models/processor_owner_body.rb +225 -0
  266. data/lib/mx-platform-ruby/models/processor_owner_body_account_owners_inner.rb +330 -0
  267. data/lib/mx-platform-ruby/models/{holding_response.rb → repeating_transaction_response.rb} +100 -135
  268. data/lib/mx-platform-ruby/models/repeating_transactions_response_body.rb +216 -0
  269. data/lib/mx-platform-ruby/models/reposition_request.rb +2 -2
  270. data/lib/mx-platform-ruby/models/reposition_request_body.rb +2 -2
  271. data/lib/mx-platform-ruby/models/reposition_response_body.rb +2 -2
  272. data/lib/mx-platform-ruby/models/{rewards_response.rb → reward_elements.rb} +9 -36
  273. data/lib/mx-platform-ruby/models/reward_response_body.rb +3 -3
  274. data/lib/mx-platform-ruby/models/rewards_response_body.rb +3 -3
  275. data/lib/mx-platform-ruby/models/{reward_response.rb → rewards_response_body_rewards_inner.rb} +35 -27
  276. data/lib/mx-platform-ruby/models/scheduled_payment_response.rb +2 -2
  277. data/lib/mx-platform-ruby/models/scheduled_payments_response_body.rb +15 -15
  278. data/lib/mx-platform-ruby/models/spending_plan_account_response.rb +2 -2
  279. data/lib/mx-platform-ruby/models/spending_plan_accounts_response.rb +2 -2
  280. data/lib/mx-platform-ruby/models/spending_plan_iteration_item_create_request_body.rb +2 -2
  281. data/lib/mx-platform-ruby/models/spending_plan_iteration_item_response.rb +2 -2
  282. data/lib/mx-platform-ruby/models/spending_plan_iteration_items_response_body.rb +2 -2
  283. data/lib/mx-platform-ruby/models/spending_plan_iteration_response.rb +2 -2
  284. data/lib/mx-platform-ruby/models/spending_plan_iterations_response.rb +2 -2
  285. data/lib/mx-platform-ruby/models/spending_plan_response.rb +2 -2
  286. data/lib/mx-platform-ruby/models/spending_plans_response_body.rb +2 -2
  287. data/lib/mx-platform-ruby/models/split_transaction_request.rb +2 -2
  288. data/lib/mx-platform-ruby/models/split_transaction_request_body.rb +2 -2
  289. data/lib/mx-platform-ruby/models/split_transactions_response_body.rb +2 -2
  290. data/lib/mx-platform-ruby/models/statement_response.rb +2 -2
  291. data/lib/mx-platform-ruby/models/statement_response_body.rb +2 -2
  292. data/lib/mx-platform-ruby/models/statements_response_body.rb +15 -15
  293. data/lib/mx-platform-ruby/models/tag_create_request.rb +2 -2
  294. data/lib/mx-platform-ruby/models/tag_create_request_body.rb +2 -2
  295. data/lib/mx-platform-ruby/models/tag_response.rb +2 -2
  296. data/lib/mx-platform-ruby/models/tag_response_body.rb +2 -2
  297. data/lib/mx-platform-ruby/models/tag_update_request.rb +2 -2
  298. data/lib/mx-platform-ruby/models/tag_update_request_body.rb +2 -2
  299. data/lib/mx-platform-ruby/models/tagging_create_request.rb +2 -2
  300. data/lib/mx-platform-ruby/models/tagging_create_request_body.rb +2 -2
  301. data/lib/mx-platform-ruby/models/tagging_response.rb +2 -2
  302. data/lib/mx-platform-ruby/models/tagging_response_body.rb +2 -2
  303. data/lib/mx-platform-ruby/models/tagging_update_request.rb +2 -2
  304. data/lib/mx-platform-ruby/models/tagging_update_request_body.rb +2 -2
  305. data/lib/mx-platform-ruby/models/taggings_response_body.rb +15 -15
  306. data/lib/mx-platform-ruby/models/tags_response_body.rb +15 -15
  307. data/lib/mx-platform-ruby/models/{holding_response_body.rb → token_request_body.rb} +12 -12
  308. data/lib/mx-platform-ruby/models/token_response.rb +241 -0
  309. data/lib/mx-platform-ruby/models/token_response_body.rb +216 -0
  310. data/lib/mx-platform-ruby/models/transaction_create_request.rb +2 -2
  311. data/lib/mx-platform-ruby/models/transaction_create_request_body.rb +2 -2
  312. data/lib/mx-platform-ruby/models/transaction_create_response_body.rb +2 -2
  313. data/lib/mx-platform-ruby/models/transaction_includes_response.rb +692 -0
  314. data/lib/mx-platform-ruby/models/transaction_includes_response_all_of_classification.rb +257 -0
  315. data/lib/mx-platform-ruby/models/transaction_includes_response_all_of_geolocation.rb +241 -0
  316. data/lib/mx-platform-ruby/models/transaction_includes_response_all_of_merchant.rb +241 -0
  317. data/lib/mx-platform-ruby/models/transaction_includes_response_all_of_repeating_transaction.rb +278 -0
  318. data/lib/mx-platform-ruby/models/transaction_response.rb +13 -3
  319. data/lib/mx-platform-ruby/models/transaction_response_body.rb +2 -2
  320. data/lib/mx-platform-ruby/models/transaction_rule_create_request.rb +2 -2
  321. data/lib/mx-platform-ruby/models/transaction_rule_create_request_body.rb +2 -2
  322. data/lib/mx-platform-ruby/models/transaction_rule_response.rb +2 -2
  323. data/lib/mx-platform-ruby/models/transaction_rule_response_body.rb +2 -2
  324. data/lib/mx-platform-ruby/models/transaction_rule_update_request.rb +2 -2
  325. data/lib/mx-platform-ruby/models/transaction_rule_update_request_body.rb +2 -2
  326. data/lib/mx-platform-ruby/models/transaction_rules_response_body.rb +15 -15
  327. data/lib/mx-platform-ruby/models/transaction_update_request.rb +30 -10
  328. data/lib/mx-platform-ruby/models/transaction_update_request_body.rb +2 -2
  329. data/lib/mx-platform-ruby/models/transactions_response_body.rb +15 -15
  330. data/lib/mx-platform-ruby/models/transactions_response_body_includes.rb +225 -0
  331. data/lib/mx-platform-ruby/models/update_goal_request.rb +2 -2
  332. data/lib/mx-platform-ruby/models/update_goal_request_body.rb +2 -2
  333. data/lib/mx-platform-ruby/models/user_create_request.rb +2 -2
  334. data/lib/mx-platform-ruby/models/user_create_request_body.rb +2 -2
  335. data/lib/mx-platform-ruby/models/user_response.rb +2 -2
  336. data/lib/mx-platform-ruby/models/user_response_body.rb +2 -2
  337. data/lib/mx-platform-ruby/models/user_update_request.rb +2 -2
  338. data/lib/mx-platform-ruby/models/user_update_request_body.rb +2 -2
  339. data/lib/mx-platform-ruby/models/users_response_body.rb +15 -15
  340. data/lib/mx-platform-ruby/models/vc_response.rb +214 -0
  341. data/lib/mx-platform-ruby/models/widget_request.rb +89 -3
  342. data/lib/mx-platform-ruby/models/widget_request_body.rb +2 -2
  343. data/lib/mx-platform-ruby/models/widget_response.rb +2 -2
  344. data/lib/mx-platform-ruby/models/widget_response_body.rb +2 -2
  345. data/lib/mx-platform-ruby/version.rb +3 -3
  346. data/lib/mx-platform-ruby.rb +60 -12
  347. data/mx-platform-ruby.gemspec +2 -2
  348. data/openapi/config.yml +1 -1
  349. data/spec/api/accounts_api_spec.rb +182 -0
  350. data/spec/api/ach_return_api_spec.rb +77 -0
  351. data/spec/api/budgets_api_spec.rb +38 -38
  352. data/spec/api/categories_api_spec.rb +141 -0
  353. data/spec/api/goals_api_spec.rb +42 -40
  354. data/spec/api/insights_api_spec.rb +53 -38
  355. data/spec/api/institutions_api_spec.rb +94 -0
  356. data/spec/api/investment_holdings_api_spec.rb +104 -0
  357. data/spec/api/managed_data_api_spec.rb +267 -0
  358. data/spec/api/members_api_spec.rb +218 -0
  359. data/spec/api/merchants_api_spec.rb +73 -0
  360. data/spec/api/microdeposits_api_spec.rb +40 -28
  361. data/spec/api/monthly_cash_flow_profile_api_spec.rb +60 -0
  362. data/spec/api/notifications_api_spec.rb +78 -0
  363. data/spec/api/processor_token_api_spec.rb +115 -0
  364. data/spec/api/rewards_api_spec.rb +87 -0
  365. data/spec/api/spending_plan_api_spec.rb +48 -33
  366. data/spec/api/statements_api_spec.rb +91 -0
  367. data/spec/api/taggings_api_spec.rb +102 -0
  368. data/spec/api/tags_api_spec.rb +103 -0
  369. data/spec/api/transaction_rules_api_spec.rb +89 -0
  370. data/spec/api/transactions_api_spec.rb +258 -6
  371. data/spec/api/users_api_spec.rb +101 -0
  372. data/spec/api/verifiable_credentials_api_spec.rb +76 -0
  373. data/spec/api/widgets_api_spec.rb +81 -0
  374. data/spec/models/account_create_request_body_spec.rb +2 -2
  375. data/spec/models/account_create_request_spec.rb +2 -2
  376. data/spec/models/account_number_response_spec.rb +5 -5
  377. data/spec/models/account_numbers_response_body_spec.rb +2 -2
  378. data/spec/models/account_owner_response_spec.rb +2 -2
  379. data/spec/models/account_owners_response_body_spec.rb +2 -2
  380. data/spec/models/account_response_body_spec.rb +2 -2
  381. data/spec/models/account_response_spec.rb +2 -2
  382. data/spec/models/account_update_request_body_spec.rb +2 -2
  383. data/spec/models/account_update_request_spec.rb +2 -2
  384. data/spec/models/accounts_response_body_spec.rb +2 -2
  385. data/spec/models/ach_response_spec.rb +204 -0
  386. data/spec/models/ach_return_create_request_body_spec.rb +36 -0
  387. data/spec/models/{holding_response_spec.rb → ach_return_create_request_spec.rb} +22 -40
  388. data/spec/models/ach_return_response_body_spec.rb +36 -0
  389. data/spec/models/{tax_documents_response_body_spec.rb → ach_returns_response_body_spec.rb} +10 -10
  390. data/spec/models/authorization_code_request_body_spec.rb +2 -2
  391. data/spec/models/authorization_code_request_spec.rb +2 -2
  392. data/spec/models/authorization_code_response_body_spec.rb +2 -2
  393. data/spec/models/authorization_code_response_spec.rb +2 -2
  394. data/spec/models/budget_create_request_body_spec.rb +2 -2
  395. data/spec/models/budget_create_request_spec.rb +2 -2
  396. data/spec/models/budget_response_body_spec.rb +2 -2
  397. data/spec/models/budget_response_spec.rb +2 -2
  398. data/spec/models/budget_update_request_body_spec.rb +2 -2
  399. data/spec/models/budget_update_request_spec.rb +2 -2
  400. data/spec/models/categories_response_body_spec.rb +2 -2
  401. data/spec/models/category_create_request_body_spec.rb +2 -2
  402. data/spec/models/category_create_request_spec.rb +2 -2
  403. data/spec/models/category_response_body_spec.rb +2 -2
  404. data/spec/models/category_response_spec.rb +2 -2
  405. data/spec/models/category_update_request_body_spec.rb +2 -2
  406. data/spec/models/category_update_request_spec.rb +2 -2
  407. data/spec/models/challenge_response_spec.rb +2 -2
  408. data/spec/models/challenges_response_body_spec.rb +2 -2
  409. data/spec/models/connect_widget_request_body_spec.rb +2 -2
  410. data/spec/models/connect_widget_request_spec.rb +8 -2
  411. data/spec/models/connect_widget_response_body_spec.rb +2 -2
  412. data/spec/models/connect_widget_response_spec.rb +2 -2
  413. data/spec/models/credential_request_spec.rb +2 -2
  414. data/spec/models/credential_response_spec.rb +2 -2
  415. data/spec/models/credentials_response_body_spec.rb +2 -2
  416. data/spec/models/credit_card_product_response_spec.rb +2 -2
  417. data/spec/models/credit_card_product_spec.rb +2 -2
  418. data/spec/models/enhance_transaction_response_spec.rb +2 -2
  419. data/spec/models/enhance_transactions_request_body_spec.rb +2 -2
  420. data/spec/models/enhance_transactions_request_spec.rb +2 -2
  421. data/spec/models/enhance_transactions_response_body_spec.rb +2 -2
  422. data/spec/models/goal_request_body_spec.rb +2 -2
  423. data/spec/models/goal_request_spec.rb +2 -2
  424. data/spec/models/goal_response_body_spec.rb +2 -2
  425. data/spec/models/goal_response_spec.rb +2 -2
  426. data/spec/models/goals_response_body_spec.rb +2 -2
  427. data/spec/models/goals_response_spec.rb +2 -2
  428. data/spec/models/image_option_response_spec.rb +2 -8
  429. data/spec/models/insight_response_body_spec.rb +2 -2
  430. data/spec/models/insight_response_spec.rb +8 -2
  431. data/spec/models/insight_update_request_body_spec.rb +36 -0
  432. data/spec/models/insight_update_request_spec.rb +2 -2
  433. data/spec/models/insights_response_body_spec.rb +2 -2
  434. data/spec/models/institution_response_body_spec.rb +2 -2
  435. data/spec/models/institution_response_spec.rb +20 -2
  436. data/spec/models/institutions_response_body_spec.rb +2 -2
  437. data/spec/models/investment_holding_response_body_spec.rb +36 -0
  438. data/spec/models/investment_holding_response_spec.rb +252 -0
  439. data/spec/models/investment_holdings_deactivation_spec.rb +42 -0
  440. data/spec/models/investment_holdings_response_body_spec.rb +42 -0
  441. data/spec/models/managed_account_create_request_body_spec.rb +2 -2
  442. data/spec/models/managed_account_create_request_spec.rb +2 -2
  443. data/spec/models/managed_account_update_request_body_spec.rb +2 -2
  444. data/spec/models/managed_account_update_request_spec.rb +2 -2
  445. data/spec/models/managed_member_create_request_body_spec.rb +2 -2
  446. data/spec/models/managed_member_create_request_spec.rb +2 -2
  447. data/spec/models/managed_member_update_request_body_spec.rb +2 -2
  448. data/spec/models/managed_member_update_request_spec.rb +2 -2
  449. data/spec/models/managed_transaction_create_request_body_spec.rb +2 -2
  450. data/spec/models/managed_transaction_create_request_spec.rb +2 -2
  451. data/spec/models/managed_transaction_update_request_body_spec.rb +2 -2
  452. data/spec/models/managed_transaction_update_request_spec.rb +2 -2
  453. data/spec/models/member_create_request_body_spec.rb +2 -2
  454. data/spec/models/member_create_request_spec.rb +12 -2
  455. data/spec/models/member_elements_spec.rb +48 -0
  456. data/spec/models/member_response_body_spec.rb +2 -2
  457. data/spec/models/member_response_spec.rb +2 -8
  458. data/spec/models/member_resume_request_body_spec.rb +2 -2
  459. data/spec/models/member_resume_request_spec.rb +2 -2
  460. data/spec/models/member_status_response_body_spec.rb +2 -2
  461. data/spec/models/member_status_response_spec.rb +4 -4
  462. data/spec/models/member_update_request_body_spec.rb +2 -2
  463. data/spec/models/member_update_request_spec.rb +12 -2
  464. data/spec/models/members_response_body_spec.rb +2 -2
  465. data/spec/models/merchant_location_response_body_spec.rb +2 -2
  466. data/spec/models/merchant_location_response_spec.rb +2 -2
  467. data/spec/models/merchant_response_body_spec.rb +2 -2
  468. data/spec/models/merchant_response_spec.rb +2 -2
  469. data/spec/models/merchants_response_body_spec.rb +2 -2
  470. data/spec/models/{microdeposit_request_spec.rb → microdeposit_elements_spec.rb} +15 -15
  471. data/spec/models/microdeposit_request_body_spec.rb +2 -2
  472. data/spec/models/microdeposit_response_body_micro_deposit_inner_spec.rb +114 -0
  473. data/spec/models/microdeposit_response_body_spec.rb +2 -2
  474. data/spec/models/microdeposit_response_spec.rb +2 -44
  475. data/spec/models/microdeposit_verify_request_body_spec.rb +2 -2
  476. data/spec/models/microdeposit_verify_request_spec.rb +2 -2
  477. data/spec/models/microdeposits_response_body_spec.rb +2 -2
  478. data/spec/models/monthly_cash_flow_profile_request_body_spec.rb +2 -2
  479. data/spec/models/monthly_cash_flow_profile_request_spec.rb +2 -2
  480. data/spec/models/monthly_cash_flow_response_body_spec.rb +2 -2
  481. data/spec/models/monthly_cash_flow_response_spec.rb +2 -2
  482. data/spec/models/notification_response_body_spec.rb +36 -0
  483. data/spec/models/{tax_document_response_spec.rb → notification_response_spec.rb} +18 -18
  484. data/spec/models/notifications_response_body_spec.rb +36 -0
  485. data/spec/models/o_auth_window_response_body_spec.rb +2 -2
  486. data/spec/models/o_auth_window_response_spec.rb +2 -2
  487. data/spec/models/option_response_spec.rb +2 -8
  488. data/spec/models/pagination_response_spec.rb +2 -2
  489. data/spec/models/{reward_response_spec.rb → payment_account_body_payment_account_spec.rb} +24 -18
  490. data/spec/models/payment_account_body_spec.rb +36 -0
  491. data/spec/models/payment_account_spec.rb +84 -0
  492. data/spec/models/payment_processor_authorization_code_request_body_spec.rb +2 -2
  493. data/spec/models/payment_processor_authorization_code_request_spec.rb +2 -2
  494. data/spec/models/payment_processor_authorization_code_response_body_spec.rb +2 -2
  495. data/spec/models/payment_processor_authorization_code_response_spec.rb +2 -2
  496. data/spec/models/processor_account_number_body_account_numbers_inner_spec.rb +102 -0
  497. data/spec/models/processor_account_number_body_spec.rb +36 -0
  498. data/spec/models/processor_account_number_spec.rb +84 -0
  499. data/spec/models/processor_owner_body_account_owners_inner_spec.rb +102 -0
  500. data/spec/models/{holdings_response_body_spec.rb → processor_owner_body_spec.rb} +9 -9
  501. data/spec/models/processor_owner_spec.rb +84 -0
  502. data/spec/models/repeating_transaction_response_spec.rb +110 -0
  503. data/spec/models/repeating_transactions_response_body_spec.rb +36 -0
  504. data/spec/models/reposition_request_body_spec.rb +2 -2
  505. data/spec/models/reposition_request_spec.rb +2 -2
  506. data/spec/models/reposition_response_body_spec.rb +2 -2
  507. data/spec/models/reward_elements_spec.rb +78 -0
  508. data/spec/models/reward_response_body_spec.rb +2 -2
  509. data/spec/models/{rewards_response_spec.rb → rewards_response_body_rewards_inner_spec.rb} +18 -18
  510. data/spec/models/rewards_response_body_spec.rb +2 -2
  511. data/spec/models/scheduled_payment_response_spec.rb +2 -2
  512. data/spec/models/scheduled_payments_response_body_spec.rb +4 -4
  513. data/spec/models/spending_plan_account_response_spec.rb +2 -2
  514. data/spec/models/spending_plan_accounts_response_spec.rb +2 -2
  515. data/spec/models/spending_plan_iteration_item_create_request_body_spec.rb +2 -2
  516. data/spec/models/spending_plan_iteration_item_response_spec.rb +2 -2
  517. data/spec/models/spending_plan_iteration_items_response_body_spec.rb +2 -2
  518. data/spec/models/spending_plan_iteration_response_spec.rb +2 -2
  519. data/spec/models/spending_plan_iterations_response_spec.rb +2 -2
  520. data/spec/models/spending_plan_response_spec.rb +2 -2
  521. data/spec/models/spending_plans_response_body_spec.rb +2 -2
  522. data/spec/models/split_transaction_request_body_spec.rb +2 -2
  523. data/spec/models/split_transaction_request_spec.rb +2 -2
  524. data/spec/models/split_transactions_response_body_spec.rb +2 -2
  525. data/spec/models/statement_response_body_spec.rb +2 -2
  526. data/spec/models/statement_response_spec.rb +2 -2
  527. data/spec/models/statements_response_body_spec.rb +4 -4
  528. data/spec/models/tag_create_request_body_spec.rb +2 -2
  529. data/spec/models/tag_create_request_spec.rb +2 -2
  530. data/spec/models/tag_response_body_spec.rb +2 -2
  531. data/spec/models/tag_response_spec.rb +2 -2
  532. data/spec/models/tag_update_request_body_spec.rb +2 -2
  533. data/spec/models/tag_update_request_spec.rb +2 -2
  534. data/spec/models/tagging_create_request_body_spec.rb +2 -2
  535. data/spec/models/tagging_create_request_spec.rb +2 -2
  536. data/spec/models/tagging_response_body_spec.rb +2 -2
  537. data/spec/models/tagging_response_spec.rb +2 -2
  538. data/spec/models/tagging_update_request_body_spec.rb +2 -2
  539. data/spec/models/tagging_update_request_spec.rb +2 -2
  540. data/spec/models/taggings_response_body_spec.rb +4 -4
  541. data/spec/models/tags_response_body_spec.rb +4 -4
  542. data/spec/models/{tax_document_response_body_spec.rb → token_request_body_spec.rb} +9 -9
  543. data/spec/models/token_response_body_spec.rb +36 -0
  544. data/spec/models/token_response_spec.rb +54 -0
  545. data/spec/models/transaction_create_request_body_spec.rb +2 -2
  546. data/spec/models/transaction_create_request_spec.rb +2 -2
  547. data/spec/models/transaction_create_response_body_spec.rb +2 -2
  548. data/spec/models/transaction_includes_response_all_of_classification_spec.rb +46 -0
  549. data/spec/models/transaction_includes_response_all_of_geolocation_spec.rb +54 -0
  550. data/spec/models/transaction_includes_response_all_of_merchant_spec.rb +54 -0
  551. data/spec/models/transaction_includes_response_all_of_repeating_transaction_spec.rb +56 -0
  552. data/spec/models/transaction_includes_response_spec.rb +318 -0
  553. data/spec/models/transaction_response_body_spec.rb +2 -2
  554. data/spec/models/transaction_response_spec.rb +8 -2
  555. data/spec/models/transaction_rule_create_request_body_spec.rb +2 -2
  556. data/spec/models/transaction_rule_create_request_spec.rb +2 -2
  557. data/spec/models/transaction_rule_response_body_spec.rb +2 -2
  558. data/spec/models/transaction_rule_response_spec.rb +2 -2
  559. data/spec/models/transaction_rule_update_request_body_spec.rb +2 -2
  560. data/spec/models/transaction_rule_update_request_spec.rb +2 -2
  561. data/spec/models/transaction_rules_response_body_spec.rb +4 -4
  562. data/spec/models/transaction_update_request_body_spec.rb +2 -2
  563. data/spec/models/transaction_update_request_spec.rb +20 -2
  564. data/spec/models/transactions_response_body_includes_spec.rb +42 -0
  565. data/spec/models/transactions_response_body_spec.rb +4 -4
  566. data/spec/models/update_goal_request_body_spec.rb +2 -2
  567. data/spec/models/update_goal_request_spec.rb +2 -2
  568. data/spec/models/user_create_request_body_spec.rb +2 -2
  569. data/spec/models/user_create_request_spec.rb +2 -2
  570. data/spec/models/user_response_body_spec.rb +2 -2
  571. data/spec/models/user_response_spec.rb +2 -2
  572. data/spec/models/user_update_request_body_spec.rb +2 -2
  573. data/spec/models/user_update_request_spec.rb +2 -2
  574. data/spec/models/users_response_body_spec.rb +4 -4
  575. data/spec/models/{holding_response_body_spec.rb → vc_response_spec.rb} +9 -9
  576. data/spec/models/widget_request_body_spec.rb +2 -2
  577. data/spec/models/widget_request_spec.rb +30 -2
  578. data/spec/models/widget_response_body_spec.rb +2 -2
  579. data/spec/models/widget_response_spec.rb +2 -2
  580. data/spec/spec_helper.rb +2 -2
  581. metadata +233 -41
  582. data/docs/HoldingResponse.md +0 -54
  583. data/docs/HoldingResponseBody.md +0 -18
  584. data/docs/MxPlatformApi.md +0 -8065
  585. data/docs/TaxDocumentResponse.md +0 -36
  586. data/docs/TaxDocumentResponseBody.md +0 -18
  587. data/docs/TaxDocumentsResponseBody.md +0 -20
  588. data/lib/mx-platform-ruby/api/mx_platform_api.rb +0 -7795
  589. data/spec/api/mx_platform_api_spec.rb +0 -1519
@@ -1,9 +1,9 @@
1
1
  =begin
2
2
  #MX Platform API
3
3
 
4
- #The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.
4
+ #The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions. Just getting started? See our [use case guides](/use-cases/).
5
5
 
6
- The version of the OpenAPI document: 0.1.0
6
+ The version of the OpenAPI document: 20111101
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.8.0
@@ -19,43 +19,39 @@ module MxPlatformRuby
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Delete a budget
23
- # Delete a budget.
24
- # @param user_guid [String] The unique identifier for the budget. Defined by MX.
25
- # @param budget_guid [String] The unique identifier for the budget. Defined by MX.
22
+ # Auto-generate budgets
23
+ # This endpoint will automatically create budgets for several categories based on existing transactions; these budgets are returned as an array. Specifically, budgets will only be generated if the `user` has at least one `transaction` in a given category during each of the two previous calendar months. For example, if the request is made on March 6, and there is at least one \"Bills & Utilities\" `transaction` in both January and February, a budget will be generated for \"Bills & Utilities.\" If there are two \"Bills & Utilities\" transactions in February but none in January, no budget will be generated for that category. If budgets already exist for particular categories, new budgets will be generated and returned based on the available transactions. If one or more budgets remain unchanged, they will nevertheless be returned in the response. If no transaction data for the `user` meet the above criteria, a `422 Unprocessable Entity` error will be returned with status code 4221 along with the message, `There aren't enough transactions to automatically create any budgets`.
24
+ # @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
26
25
  # @param [Hash] opts the optional parameters
27
- # @return [nil]
28
- def users_user_guid_budgets_budget_guid_delete(user_guid, budget_guid, opts = {})
29
- users_user_guid_budgets_budget_guid_delete_with_http_info(user_guid, budget_guid, opts)
30
- nil
26
+ # @return [BudgetResponseBody]
27
+ def auto_generate_budgets(user_guid, opts = {})
28
+ data, _status_code, _headers = auto_generate_budgets_with_http_info(user_guid, opts)
29
+ data
31
30
  end
32
31
 
33
- # Delete a budget
34
- # Delete a budget.
35
- # @param user_guid [String] The unique identifier for the budget. Defined by MX.
36
- # @param budget_guid [String] The unique identifier for the budget. Defined by MX.
32
+ # Auto-generate budgets
33
+ # This endpoint will automatically create budgets for several categories based on existing transactions; these budgets are returned as an array. Specifically, budgets will only be generated if the `user` has at least one `transaction` in a given category during each of the two previous calendar months. For example, if the request is made on March 6, and there is at least one \"Bills & Utilities\" `transaction` in both January and February, a budget will be generated for \"Bills & Utilities.\" If there are two \"Bills & Utilities\" transactions in February but none in January, no budget will be generated for that category. If budgets already exist for particular categories, new budgets will be generated and returned based on the available transactions. If one or more budgets remain unchanged, they will nevertheless be returned in the response. If no transaction data for the `user` meet the above criteria, a `422 Unprocessable Entity` error will be returned with status code 4221 along with the message, `There aren't enough transactions to automatically create any budgets`.
34
+ # @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
37
35
  # @param [Hash] opts the optional parameters
38
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
39
- def users_user_guid_budgets_budget_guid_delete_with_http_info(user_guid, budget_guid, opts = {})
36
+ # @return [Array<(BudgetResponseBody, Integer, Hash)>] BudgetResponseBody data, response status code and response headers
37
+ def auto_generate_budgets_with_http_info(user_guid, opts = {})
40
38
  if @api_client.config.debugging
41
- @api_client.config.logger.debug 'Calling API: BudgetsApi.users_user_guid_budgets_budget_guid_delete ...'
39
+ @api_client.config.logger.debug 'Calling API: BudgetsApi.auto_generate_budgets ...'
42
40
  end
43
41
  # verify the required parameter 'user_guid' is set
44
42
  if @api_client.config.client_side_validation && user_guid.nil?
45
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling BudgetsApi.users_user_guid_budgets_budget_guid_delete"
46
- end
47
- # verify the required parameter 'budget_guid' is set
48
- if @api_client.config.client_side_validation && budget_guid.nil?
49
- fail ArgumentError, "Missing the required parameter 'budget_guid' when calling BudgetsApi.users_user_guid_budgets_budget_guid_delete"
43
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling BudgetsApi.auto_generate_budgets"
50
44
  end
51
45
  # resource path
52
- local_var_path = '/users/{user_guid}/budgets/{budget_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'budget_guid' + '}', CGI.escape(budget_guid.to_s))
46
+ local_var_path = '/users/{user_guid}/budgets/generate'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
53
47
 
54
48
  # query parameters
55
49
  query_params = opts[:query_params] || {}
56
50
 
57
51
  # header parameters
58
52
  header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
59
55
 
60
56
  # form parameters
61
57
  form_params = opts[:form_params] || {}
@@ -64,13 +60,13 @@ module MxPlatformRuby
64
60
  post_body = opts[:debug_body]
65
61
 
66
62
  # return_type
67
- return_type = opts[:debug_return_type]
63
+ return_type = opts[:debug_return_type] || 'BudgetResponseBody'
68
64
 
69
65
  # auth_names
70
66
  auth_names = opts[:debug_auth_names] || ['basicAuth']
71
67
 
72
68
  new_options = opts.merge(
73
- :operation => :"BudgetsApi.users_user_guid_budgets_budget_guid_delete",
69
+ :operation => :"BudgetsApi.auto_generate_budgets",
74
70
  :header_params => header_params,
75
71
  :query_params => query_params,
76
72
  :form_params => form_params,
@@ -79,44 +75,44 @@ module MxPlatformRuby
79
75
  :return_type => return_type
80
76
  )
81
77
 
82
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
78
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
83
79
  if @api_client.config.debugging
84
- @api_client.config.logger.debug "API called: BudgetsApi#users_user_guid_budgets_budget_guid_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
80
+ @api_client.config.logger.debug "API called: BudgetsApi#auto_generate_budgets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
85
81
  end
86
82
  return data, status_code, headers
87
83
  end
88
84
 
89
- # Read a specific budget
90
- # Read a specific budget.
91
- # @param budget_guid [String] The unique identifier for the budget. Defined by MX.
92
- # @param user_guid [String] The unique identifier for the budget. Defined by MX.
85
+ # Create a budget
86
+ # Create a budget. This endpoint accepts the optional `MX-Skip-Webhook` header and `skip_webhook` parameter. You cannot create a duplicate budget. For example, if you attempt to create a budget for \"Gas\", but that budget already exist, the request will fail. You can retrieve a list of all existing categories by using the List Categories endpoint.
87
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
88
+ # @param budget_create_request_body [BudgetCreateRequestBody]
93
89
  # @param [Hash] opts the optional parameters
94
90
  # @return [BudgetResponseBody]
95
- def users_user_guid_budgets_budget_guid_get(budget_guid, user_guid, opts = {})
96
- data, _status_code, _headers = users_user_guid_budgets_budget_guid_get_with_http_info(budget_guid, user_guid, opts)
91
+ def create_budget(user_guid, budget_create_request_body, opts = {})
92
+ data, _status_code, _headers = create_budget_with_http_info(user_guid, budget_create_request_body, opts)
97
93
  data
98
94
  end
99
95
 
100
- # Read a specific budget
101
- # Read a specific budget.
102
- # @param budget_guid [String] The unique identifier for the budget. Defined by MX.
103
- # @param user_guid [String] The unique identifier for the budget. Defined by MX.
96
+ # Create a budget
97
+ # Create a budget. This endpoint accepts the optional &#x60;MX-Skip-Webhook&#x60; header and &#x60;skip_webhook&#x60; parameter. You cannot create a duplicate budget. For example, if you attempt to create a budget for \&quot;Gas\&quot;, but that budget already exist, the request will fail. You can retrieve a list of all existing categories by using the List Categories endpoint.
98
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
99
+ # @param budget_create_request_body [BudgetCreateRequestBody]
104
100
  # @param [Hash] opts the optional parameters
105
101
  # @return [Array<(BudgetResponseBody, Integer, Hash)>] BudgetResponseBody data, response status code and response headers
106
- def users_user_guid_budgets_budget_guid_get_with_http_info(budget_guid, user_guid, opts = {})
102
+ def create_budget_with_http_info(user_guid, budget_create_request_body, opts = {})
107
103
  if @api_client.config.debugging
108
- @api_client.config.logger.debug 'Calling API: BudgetsApi.users_user_guid_budgets_budget_guid_get ...'
109
- end
110
- # verify the required parameter 'budget_guid' is set
111
- if @api_client.config.client_side_validation && budget_guid.nil?
112
- fail ArgumentError, "Missing the required parameter 'budget_guid' when calling BudgetsApi.users_user_guid_budgets_budget_guid_get"
104
+ @api_client.config.logger.debug 'Calling API: BudgetsApi.create_budget ...'
113
105
  end
114
106
  # verify the required parameter 'user_guid' is set
115
107
  if @api_client.config.client_side_validation && user_guid.nil?
116
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling BudgetsApi.users_user_guid_budgets_budget_guid_get"
108
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling BudgetsApi.create_budget"
109
+ end
110
+ # verify the required parameter 'budget_create_request_body' is set
111
+ if @api_client.config.client_side_validation && budget_create_request_body.nil?
112
+ fail ArgumentError, "Missing the required parameter 'budget_create_request_body' when calling BudgetsApi.create_budget"
117
113
  end
118
114
  # resource path
119
- local_var_path = '/users/{user_guid}/budgets/{budget_guid}'.sub('{' + 'budget_guid' + '}', CGI.escape(budget_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
115
+ local_var_path = '/users/{user_guid}/budgets'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
120
116
 
121
117
  # query parameters
122
118
  query_params = opts[:query_params] || {}
@@ -125,12 +121,17 @@ module MxPlatformRuby
125
121
  header_params = opts[:header_params] || {}
126
122
  # HTTP header 'Accept' (if needed)
127
123
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
124
+ # HTTP header 'Content-Type'
125
+ content_type = @api_client.select_header_content_type(['application/vnd.mx.api.v1+json'])
126
+ if !content_type.nil?
127
+ header_params['Content-Type'] = content_type
128
+ end
128
129
 
129
130
  # form parameters
130
131
  form_params = opts[:form_params] || {}
131
132
 
132
133
  # http body (model)
133
- post_body = opts[:debug_body]
134
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(budget_create_request_body)
134
135
 
135
136
  # return_type
136
137
  return_type = opts[:debug_return_type] || 'BudgetResponseBody'
@@ -139,7 +140,7 @@ module MxPlatformRuby
139
140
  auth_names = opts[:debug_auth_names] || ['basicAuth']
140
141
 
141
142
  new_options = opts.merge(
142
- :operation => :"BudgetsApi.users_user_guid_budgets_budget_guid_get",
143
+ :operation => :"BudgetsApi.create_budget",
143
144
  :header_params => header_params,
144
145
  :query_params => query_params,
145
146
  :form_params => form_params,
@@ -148,43 +149,41 @@ module MxPlatformRuby
148
149
  :return_type => return_type
149
150
  )
150
151
 
151
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
152
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
152
153
  if @api_client.config.debugging
153
- @api_client.config.logger.debug "API called: BudgetsApi#users_user_guid_budgets_budget_guid_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
154
+ @api_client.config.logger.debug "API called: BudgetsApi#create_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
154
155
  end
155
156
  return data, status_code, headers
156
157
  end
157
158
 
158
- # Update a specific budget
159
- # Update a specific budget.
160
- # @param user_guid [String] The unique identifier for the budget. Defined by MX.
159
+ # Delete a budget
160
+ # Delete a budget.
161
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
161
162
  # @param budget_guid [String] The unique identifier for the budget. Defined by MX.
162
163
  # @param [Hash] opts the optional parameters
163
- # @option opts [BudgetUpdateRequestBody] :budget_update_request_body
164
- # @return [BudgetResponseBody]
165
- def users_user_guid_budgets_budget_guid_put(user_guid, budget_guid, opts = {})
166
- data, _status_code, _headers = users_user_guid_budgets_budget_guid_put_with_http_info(user_guid, budget_guid, opts)
167
- data
164
+ # @return [nil]
165
+ def delete_budget(user_guid, budget_guid, opts = {})
166
+ delete_budget_with_http_info(user_guid, budget_guid, opts)
167
+ nil
168
168
  end
169
169
 
170
- # Update a specific budget
171
- # Update a specific budget.
172
- # @param user_guid [String] The unique identifier for the budget. Defined by MX.
170
+ # Delete a budget
171
+ # Delete a budget.
172
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
173
173
  # @param budget_guid [String] The unique identifier for the budget. Defined by MX.
174
174
  # @param [Hash] opts the optional parameters
175
- # @option opts [BudgetUpdateRequestBody] :budget_update_request_body
176
- # @return [Array<(BudgetResponseBody, Integer, Hash)>] BudgetResponseBody data, response status code and response headers
177
- def users_user_guid_budgets_budget_guid_put_with_http_info(user_guid, budget_guid, opts = {})
175
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
176
+ def delete_budget_with_http_info(user_guid, budget_guid, opts = {})
178
177
  if @api_client.config.debugging
179
- @api_client.config.logger.debug 'Calling API: BudgetsApi.users_user_guid_budgets_budget_guid_put ...'
178
+ @api_client.config.logger.debug 'Calling API: BudgetsApi.delete_budget ...'
180
179
  end
181
180
  # verify the required parameter 'user_guid' is set
182
181
  if @api_client.config.client_side_validation && user_guid.nil?
183
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling BudgetsApi.users_user_guid_budgets_budget_guid_put"
182
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling BudgetsApi.delete_budget"
184
183
  end
185
184
  # verify the required parameter 'budget_guid' is set
186
185
  if @api_client.config.client_side_validation && budget_guid.nil?
187
- fail ArgumentError, "Missing the required parameter 'budget_guid' when calling BudgetsApi.users_user_guid_budgets_budget_guid_put"
186
+ fail ArgumentError, "Missing the required parameter 'budget_guid' when calling BudgetsApi.delete_budget"
188
187
  end
189
188
  # resource path
190
189
  local_var_path = '/users/{user_guid}/budgets/{budget_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'budget_guid' + '}', CGI.escape(budget_guid.to_s))
@@ -194,28 +193,21 @@ module MxPlatformRuby
194
193
 
195
194
  # header parameters
196
195
  header_params = opts[:header_params] || {}
197
- # HTTP header 'Accept' (if needed)
198
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
199
- # HTTP header 'Content-Type'
200
- content_type = @api_client.select_header_content_type(['application/json'])
201
- if !content_type.nil?
202
- header_params['Content-Type'] = content_type
203
- end
204
196
 
205
197
  # form parameters
206
198
  form_params = opts[:form_params] || {}
207
199
 
208
200
  # http body (model)
209
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'budget_update_request_body'])
201
+ post_body = opts[:debug_body]
210
202
 
211
203
  # return_type
212
- return_type = opts[:debug_return_type] || 'BudgetResponseBody'
204
+ return_type = opts[:debug_return_type]
213
205
 
214
206
  # auth_names
215
207
  auth_names = opts[:debug_auth_names] || ['basicAuth']
216
208
 
217
209
  new_options = opts.merge(
218
- :operation => :"BudgetsApi.users_user_guid_budgets_budget_guid_put",
210
+ :operation => :"BudgetsApi.delete_budget",
219
211
  :header_params => header_params,
220
212
  :query_params => query_params,
221
213
  :form_params => form_params,
@@ -224,38 +216,38 @@ module MxPlatformRuby
224
216
  :return_type => return_type
225
217
  )
226
218
 
227
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
219
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
228
220
  if @api_client.config.debugging
229
- @api_client.config.logger.debug "API called: BudgetsApi#users_user_guid_budgets_budget_guid_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
221
+ @api_client.config.logger.debug "API called: BudgetsApi#delete_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
230
222
  end
231
223
  return data, status_code, headers
232
224
  end
233
225
 
234
- # Auto-generate budgets
235
- # This endpoint will automatically create budgets for several categories based on existing transactions; these budgets are returned as an array. Specifically, budgets will only be generated if the `user` has at least one `transaction` in a given category during each of the two previous calendar months. For example, if the request is made on March 6, and there is at least one \"Bills & Utilities\" `transaction` in both January and February, a budget will be generated for \"Bills & Utilities.\" If there are two \"Bills & Utilities\" transactions in February but none in January, no budget will be generated for that category. If budgets already exist for particular categories, new budgets will be generated and returned based on the available transactions. If one or more budgets remain unchanged, they will nevertheless be returned in the response. If no transaction data for the `user` meet the above criteria, a `422 Unprocessable Entity` error will be returned with status code 4221 along with the message, `There aren't enough transactions to automatically create any budgets`.
236
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
226
+ # List all budgets
227
+ # List all budgets
228
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
237
229
  # @param [Hash] opts the optional parameters
238
230
  # @return [BudgetResponseBody]
239
- def users_user_guid_budgets_generate_post(user_guid, opts = {})
240
- data, _status_code, _headers = users_user_guid_budgets_generate_post_with_http_info(user_guid, opts)
231
+ def list_all_budgets(user_guid, opts = {})
232
+ data, _status_code, _headers = list_all_budgets_with_http_info(user_guid, opts)
241
233
  data
242
234
  end
243
235
 
244
- # Auto-generate budgets
245
- # This endpoint will automatically create budgets for several categories based on existing transactions; these budgets are returned as an array. Specifically, budgets will only be generated if the &#x60;user&#x60; has at least one &#x60;transaction&#x60; in a given category during each of the two previous calendar months. For example, if the request is made on March 6, and there is at least one \&quot;Bills &amp; Utilities\&quot; &#x60;transaction&#x60; in both January and February, a budget will be generated for \&quot;Bills &amp; Utilities.\&quot; If there are two \&quot;Bills &amp; Utilities\&quot; transactions in February but none in January, no budget will be generated for that category. If budgets already exist for particular categories, new budgets will be generated and returned based on the available transactions. If one or more budgets remain unchanged, they will nevertheless be returned in the response. If no transaction data for the &#x60;user&#x60; meet the above criteria, a &#x60;422 Unprocessable Entity&#x60; error will be returned with status code 4221 along with the message, &#x60;There aren&#39;t enough transactions to automatically create any budgets&#x60;.
246
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
236
+ # List all budgets
237
+ # List all budgets
238
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
247
239
  # @param [Hash] opts the optional parameters
248
240
  # @return [Array<(BudgetResponseBody, Integer, Hash)>] BudgetResponseBody data, response status code and response headers
249
- def users_user_guid_budgets_generate_post_with_http_info(user_guid, opts = {})
241
+ def list_all_budgets_with_http_info(user_guid, opts = {})
250
242
  if @api_client.config.debugging
251
- @api_client.config.logger.debug 'Calling API: BudgetsApi.users_user_guid_budgets_generate_post ...'
243
+ @api_client.config.logger.debug 'Calling API: BudgetsApi.list_all_budgets ...'
252
244
  end
253
245
  # verify the required parameter 'user_guid' is set
254
246
  if @api_client.config.client_side_validation && user_guid.nil?
255
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling BudgetsApi.users_user_guid_budgets_generate_post"
247
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling BudgetsApi.list_all_budgets"
256
248
  end
257
249
  # resource path
258
- local_var_path = '/users/{user_guid}/budgets/generate'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
250
+ local_var_path = '/users/{user_guid}/budgets'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
259
251
 
260
252
  # query parameters
261
253
  query_params = opts[:query_params] || {}
@@ -263,7 +255,7 @@ module MxPlatformRuby
263
255
  # header parameters
264
256
  header_params = opts[:header_params] || {}
265
257
  # HTTP header 'Accept' (if needed)
266
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
258
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
267
259
 
268
260
  # form parameters
269
261
  form_params = opts[:form_params] || {}
@@ -278,7 +270,7 @@ module MxPlatformRuby
278
270
  auth_names = opts[:debug_auth_names] || ['basicAuth']
279
271
 
280
272
  new_options = opts.merge(
281
- :operation => :"BudgetsApi.users_user_guid_budgets_generate_post",
273
+ :operation => :"BudgetsApi.list_all_budgets",
282
274
  :header_params => header_params,
283
275
  :query_params => query_params,
284
276
  :form_params => form_params,
@@ -287,38 +279,44 @@ module MxPlatformRuby
287
279
  :return_type => return_type
288
280
  )
289
281
 
290
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
282
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
291
283
  if @api_client.config.debugging
292
- @api_client.config.logger.debug "API called: BudgetsApi#users_user_guid_budgets_generate_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
284
+ @api_client.config.logger.debug "API called: BudgetsApi#list_all_budgets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
293
285
  end
294
286
  return data, status_code, headers
295
287
  end
296
288
 
297
- # List all budgets
298
- # List all budgets
299
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
289
+ # Read a specific budget
290
+ # Read a specific budget.
291
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
292
+ # @param budget_guid [String] The unique identifier for the budget. Defined by MX.
300
293
  # @param [Hash] opts the optional parameters
301
294
  # @return [BudgetResponseBody]
302
- def users_user_guid_budgets_get(user_guid, opts = {})
303
- data, _status_code, _headers = users_user_guid_budgets_get_with_http_info(user_guid, opts)
295
+ def read_specific_budget(user_guid, budget_guid, opts = {})
296
+ data, _status_code, _headers = read_specific_budget_with_http_info(user_guid, budget_guid, opts)
304
297
  data
305
298
  end
306
299
 
307
- # List all budgets
308
- # List all budgets
309
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
300
+ # Read a specific budget
301
+ # Read a specific budget.
302
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
303
+ # @param budget_guid [String] The unique identifier for the budget. Defined by MX.
310
304
  # @param [Hash] opts the optional parameters
311
305
  # @return [Array<(BudgetResponseBody, Integer, Hash)>] BudgetResponseBody data, response status code and response headers
312
- def users_user_guid_budgets_get_with_http_info(user_guid, opts = {})
306
+ def read_specific_budget_with_http_info(user_guid, budget_guid, opts = {})
313
307
  if @api_client.config.debugging
314
- @api_client.config.logger.debug 'Calling API: BudgetsApi.users_user_guid_budgets_get ...'
308
+ @api_client.config.logger.debug 'Calling API: BudgetsApi.read_specific_budget ...'
315
309
  end
316
310
  # verify the required parameter 'user_guid' is set
317
311
  if @api_client.config.client_side_validation && user_guid.nil?
318
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling BudgetsApi.users_user_guid_budgets_get"
312
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling BudgetsApi.read_specific_budget"
313
+ end
314
+ # verify the required parameter 'budget_guid' is set
315
+ if @api_client.config.client_side_validation && budget_guid.nil?
316
+ fail ArgumentError, "Missing the required parameter 'budget_guid' when calling BudgetsApi.read_specific_budget"
319
317
  end
320
318
  # resource path
321
- local_var_path = '/users/{user_guid}/budgets'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
319
+ local_var_path = '/users/{user_guid}/budgets/{budget_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'budget_guid' + '}', CGI.escape(budget_guid.to_s))
322
320
 
323
321
  # query parameters
324
322
  query_params = opts[:query_params] || {}
@@ -326,7 +324,7 @@ module MxPlatformRuby
326
324
  # header parameters
327
325
  header_params = opts[:header_params] || {}
328
326
  # HTTP header 'Accept' (if needed)
329
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
327
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
330
328
 
331
329
  # form parameters
332
330
  form_params = opts[:form_params] || {}
@@ -341,7 +339,7 @@ module MxPlatformRuby
341
339
  auth_names = opts[:debug_auth_names] || ['basicAuth']
342
340
 
343
341
  new_options = opts.merge(
344
- :operation => :"BudgetsApi.users_user_guid_budgets_get",
342
+ :operation => :"BudgetsApi.read_specific_budget",
345
343
  :header_params => header_params,
346
344
  :query_params => query_params,
347
345
  :form_params => form_params,
@@ -352,42 +350,44 @@ module MxPlatformRuby
352
350
 
353
351
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
354
352
  if @api_client.config.debugging
355
- @api_client.config.logger.debug "API called: BudgetsApi#users_user_guid_budgets_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
353
+ @api_client.config.logger.debug "API called: BudgetsApi#read_specific_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
356
354
  end
357
355
  return data, status_code, headers
358
356
  end
359
357
 
360
- # Create a budget
361
- # Create a budget. This endpoint accepts the optional `MX-Skip-Webhook` header and `skip_webhook` parameter. You cannot create a duplicate budget. For example, if you attempt to create a budget for \"Gas\", but that budget already exist, the request will fail. You can retrieve a list of all existing categories by using the List Categories endpoint.
362
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
363
- # @param budget_create_request_body [BudgetCreateRequestBody]
358
+ # Update a specific budget
359
+ # Update a specific budget.
360
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
361
+ # @param budget_guid [String] The unique identifier for the budget. Defined by MX.
364
362
  # @param [Hash] opts the optional parameters
363
+ # @option opts [BudgetUpdateRequestBody] :budget_update_request_body
365
364
  # @return [BudgetResponseBody]
366
- def users_user_guid_budgets_post(user_guid, budget_create_request_body, opts = {})
367
- data, _status_code, _headers = users_user_guid_budgets_post_with_http_info(user_guid, budget_create_request_body, opts)
365
+ def update_specific_budget(user_guid, budget_guid, opts = {})
366
+ data, _status_code, _headers = update_specific_budget_with_http_info(user_guid, budget_guid, opts)
368
367
  data
369
368
  end
370
369
 
371
- # Create a budget
372
- # Create a budget. This endpoint accepts the optional &#x60;MX-Skip-Webhook&#x60; header and &#x60;skip_webhook&#x60; parameter. You cannot create a duplicate budget. For example, if you attempt to create a budget for \&quot;Gas\&quot;, but that budget already exist, the request will fail. You can retrieve a list of all existing categories by using the List Categories endpoint.
373
- # @param user_guid [String] The unique identifier for the user. Defined by MX.
374
- # @param budget_create_request_body [BudgetCreateRequestBody]
370
+ # Update a specific budget
371
+ # Update a specific budget.
372
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
373
+ # @param budget_guid [String] The unique identifier for the budget. Defined by MX.
375
374
  # @param [Hash] opts the optional parameters
375
+ # @option opts [BudgetUpdateRequestBody] :budget_update_request_body
376
376
  # @return [Array<(BudgetResponseBody, Integer, Hash)>] BudgetResponseBody data, response status code and response headers
377
- def users_user_guid_budgets_post_with_http_info(user_guid, budget_create_request_body, opts = {})
377
+ def update_specific_budget_with_http_info(user_guid, budget_guid, opts = {})
378
378
  if @api_client.config.debugging
379
- @api_client.config.logger.debug 'Calling API: BudgetsApi.users_user_guid_budgets_post ...'
379
+ @api_client.config.logger.debug 'Calling API: BudgetsApi.update_specific_budget ...'
380
380
  end
381
381
  # verify the required parameter 'user_guid' is set
382
382
  if @api_client.config.client_side_validation && user_guid.nil?
383
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling BudgetsApi.users_user_guid_budgets_post"
383
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling BudgetsApi.update_specific_budget"
384
384
  end
385
- # verify the required parameter 'budget_create_request_body' is set
386
- if @api_client.config.client_side_validation && budget_create_request_body.nil?
387
- fail ArgumentError, "Missing the required parameter 'budget_create_request_body' when calling BudgetsApi.users_user_guid_budgets_post"
385
+ # verify the required parameter 'budget_guid' is set
386
+ if @api_client.config.client_side_validation && budget_guid.nil?
387
+ fail ArgumentError, "Missing the required parameter 'budget_guid' when calling BudgetsApi.update_specific_budget"
388
388
  end
389
389
  # resource path
390
- local_var_path = '/users/{user_guid}/budgets'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
390
+ local_var_path = '/users/{user_guid}/budgets/{budget_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'budget_guid' + '}', CGI.escape(budget_guid.to_s))
391
391
 
392
392
  # query parameters
393
393
  query_params = opts[:query_params] || {}
@@ -397,7 +397,7 @@ module MxPlatformRuby
397
397
  # HTTP header 'Accept' (if needed)
398
398
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
399
399
  # HTTP header 'Content-Type'
400
- content_type = @api_client.select_header_content_type(['application/json'])
400
+ content_type = @api_client.select_header_content_type(['application/vnd.mx.api.v1+json'])
401
401
  if !content_type.nil?
402
402
  header_params['Content-Type'] = content_type
403
403
  end
@@ -406,7 +406,7 @@ module MxPlatformRuby
406
406
  form_params = opts[:form_params] || {}
407
407
 
408
408
  # http body (model)
409
- post_body = opts[:debug_body] || @api_client.object_to_http_body(budget_create_request_body)
409
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'budget_update_request_body'])
410
410
 
411
411
  # return_type
412
412
  return_type = opts[:debug_return_type] || 'BudgetResponseBody'
@@ -415,7 +415,7 @@ module MxPlatformRuby
415
415
  auth_names = opts[:debug_auth_names] || ['basicAuth']
416
416
 
417
417
  new_options = opts.merge(
418
- :operation => :"BudgetsApi.users_user_guid_budgets_post",
418
+ :operation => :"BudgetsApi.update_specific_budget",
419
419
  :header_params => header_params,
420
420
  :query_params => query_params,
421
421
  :form_params => form_params,
@@ -424,9 +424,9 @@ module MxPlatformRuby
424
424
  :return_type => return_type
425
425
  )
426
426
 
427
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
427
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
428
428
  if @api_client.config.debugging
429
- @api_client.config.logger.debug "API called: BudgetsApi#users_user_guid_budgets_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
429
+ @api_client.config.logger.debug "API called: BudgetsApi#update_specific_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
430
430
  end
431
431
  return data, status_code, headers
432
432
  end