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,60 +19,65 @@ module MxPlatformRuby
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # List goals
23
- # List all goals a user can set.
24
- # @param user_guid [String] The unique identifier for the user.
22
+ # Create a goal
23
+ # Create a goal. This endpoint accepts the optional `MX-Skip-Webhook` header and `skip_webhook` parameter.
24
+ # @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
25
+ # @param goal_request_body [GoalRequestBody]
25
26
  # @param [Hash] opts the optional parameters
26
- # @option opts [String] :page Results are returned in paginated sets, this is the page of the results you would like to view. Defaults to page 1 if no page is specified.
27
- # @option opts [String] :records_per_age The supported range is from 10 to 1000. If the records_per_page parameter is not specified or is outside this range, a default of 25 records per page will be used.
28
- # @return [GoalsResponseBody]
29
- def users_user_guid_goals_get(user_guid, opts = {})
30
- data, _status_code, _headers = users_user_guid_goals_get_with_http_info(user_guid, opts)
27
+ # @return [GoalResponseBody]
28
+ def create_goal(user_guid, goal_request_body, opts = {})
29
+ data, _status_code, _headers = create_goal_with_http_info(user_guid, goal_request_body, opts)
31
30
  data
32
31
  end
33
32
 
34
- # List goals
35
- # List all goals a user can set.
36
- # @param user_guid [String] The unique identifier for the user.
33
+ # Create a goal
34
+ # Create a goal. This endpoint accepts the optional `MX-Skip-Webhook` header and `skip_webhook` parameter.
35
+ # @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
36
+ # @param goal_request_body [GoalRequestBody]
37
37
  # @param [Hash] opts the optional parameters
38
- # @option opts [String] :page Results are returned in paginated sets, this is the page of the results you would like to view. Defaults to page 1 if no page is specified.
39
- # @option opts [String] :records_per_age The supported range is from 10 to 1000. If the records_per_page parameter is not specified or is outside this range, a default of 25 records per page will be used.
40
- # @return [Array<(GoalsResponseBody, Integer, Hash)>] GoalsResponseBody data, response status code and response headers
41
- def users_user_guid_goals_get_with_http_info(user_guid, opts = {})
38
+ # @return [Array<(GoalResponseBody, Integer, Hash)>] GoalResponseBody data, response status code and response headers
39
+ def create_goal_with_http_info(user_guid, goal_request_body, opts = {})
42
40
  if @api_client.config.debugging
43
- @api_client.config.logger.debug 'Calling API: GoalsApi.users_user_guid_goals_get ...'
41
+ @api_client.config.logger.debug 'Calling API: GoalsApi.create_goal ...'
44
42
  end
45
43
  # verify the required parameter 'user_guid' is set
46
44
  if @api_client.config.client_side_validation && user_guid.nil?
47
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling GoalsApi.users_user_guid_goals_get"
45
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling GoalsApi.create_goal"
46
+ end
47
+ # verify the required parameter 'goal_request_body' is set
48
+ if @api_client.config.client_side_validation && goal_request_body.nil?
49
+ fail ArgumentError, "Missing the required parameter 'goal_request_body' when calling GoalsApi.create_goal"
48
50
  end
49
51
  # resource path
50
52
  local_var_path = '/users/{user_guid}/goals'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
51
53
 
52
54
  # query parameters
53
55
  query_params = opts[:query_params] || {}
54
- query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
55
- query_params[:'records_per_age'] = opts[:'records_per_age'] if !opts[:'records_per_age'].nil?
56
56
 
57
57
  # header parameters
58
58
  header_params = opts[:header_params] || {}
59
59
  # HTTP header 'Accept' (if needed)
60
60
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
61
+ # HTTP header 'Content-Type'
62
+ content_type = @api_client.select_header_content_type(['application/vnd.mx.api.v1+json'])
63
+ if !content_type.nil?
64
+ header_params['Content-Type'] = content_type
65
+ end
61
66
 
62
67
  # form parameters
63
68
  form_params = opts[:form_params] || {}
64
69
 
65
70
  # http body (model)
66
- post_body = opts[:debug_body]
71
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(goal_request_body)
67
72
 
68
73
  # return_type
69
- return_type = opts[:debug_return_type] || 'GoalsResponseBody'
74
+ return_type = opts[:debug_return_type] || 'GoalResponseBody'
70
75
 
71
76
  # auth_names
72
77
  auth_names = opts[:debug_auth_names] || ['basicAuth']
73
78
 
74
79
  new_options = opts.merge(
75
- :operation => :"GoalsApi.users_user_guid_goals_get",
80
+ :operation => :"GoalsApi.create_goal",
76
81
  :header_params => header_params,
77
82
  :query_params => query_params,
78
83
  :form_params => form_params,
@@ -81,9 +86,9 @@ module MxPlatformRuby
81
86
  :return_type => return_type
82
87
  )
83
88
 
84
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
89
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
85
90
  if @api_client.config.debugging
86
- @api_client.config.logger.debug "API called: GoalsApi#users_user_guid_goals_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
91
+ @api_client.config.logger.debug "API called: GoalsApi#create_goal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
87
92
  end
88
93
  return data, status_code, headers
89
94
  end
@@ -91,31 +96,37 @@ module MxPlatformRuby
91
96
  # Delete a goal
92
97
  # Delete a goal.
93
98
  # @param goal_guid [String] The unique identifier for a goal. Defined by MX.
94
- # @param user_guid [String] The unique identifier for a user.
99
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
100
+ # @param accept [String] Specifies the media type expected in the response.
95
101
  # @param [Hash] opts the optional parameters
96
102
  # @return [nil]
97
- def users_user_guid_goals_goal_guid_delete(goal_guid, user_guid, opts = {})
98
- users_user_guid_goals_goal_guid_delete_with_http_info(goal_guid, user_guid, opts)
103
+ def delete_goal(goal_guid, user_guid, accept, opts = {})
104
+ delete_goal_with_http_info(goal_guid, user_guid, accept, opts)
99
105
  nil
100
106
  end
101
107
 
102
108
  # Delete a goal
103
109
  # Delete a goal.
104
110
  # @param goal_guid [String] The unique identifier for a goal. Defined by MX.
105
- # @param user_guid [String] The unique identifier for a user.
111
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
112
+ # @param accept [String] Specifies the media type expected in the response.
106
113
  # @param [Hash] opts the optional parameters
107
114
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
108
- def users_user_guid_goals_goal_guid_delete_with_http_info(goal_guid, user_guid, opts = {})
115
+ def delete_goal_with_http_info(goal_guid, user_guid, accept, opts = {})
109
116
  if @api_client.config.debugging
110
- @api_client.config.logger.debug 'Calling API: GoalsApi.users_user_guid_goals_goal_guid_delete ...'
117
+ @api_client.config.logger.debug 'Calling API: GoalsApi.delete_goal ...'
111
118
  end
112
119
  # verify the required parameter 'goal_guid' is set
113
120
  if @api_client.config.client_side_validation && goal_guid.nil?
114
- fail ArgumentError, "Missing the required parameter 'goal_guid' when calling GoalsApi.users_user_guid_goals_goal_guid_delete"
121
+ fail ArgumentError, "Missing the required parameter 'goal_guid' when calling GoalsApi.delete_goal"
115
122
  end
116
123
  # verify the required parameter 'user_guid' is set
117
124
  if @api_client.config.client_side_validation && user_guid.nil?
118
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling GoalsApi.users_user_guid_goals_goal_guid_delete"
125
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling GoalsApi.delete_goal"
126
+ end
127
+ # verify the required parameter 'accept' is set
128
+ if @api_client.config.client_side_validation && accept.nil?
129
+ fail ArgumentError, "Missing the required parameter 'accept' when calling GoalsApi.delete_goal"
119
130
  end
120
131
  # resource path
121
132
  local_var_path = '/users/{user_guid}/goals/{goal_guid}'.sub('{' + 'goal_guid' + '}', CGI.escape(goal_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
@@ -125,6 +136,7 @@ module MxPlatformRuby
125
136
 
126
137
  # header parameters
127
138
  header_params = opts[:header_params] || {}
139
+ header_params[:'Accept'] = accept
128
140
 
129
141
  # form parameters
130
142
  form_params = opts[:form_params] || {}
@@ -139,7 +151,7 @@ module MxPlatformRuby
139
151
  auth_names = opts[:debug_auth_names] || ['basicAuth']
140
152
 
141
153
  new_options = opts.merge(
142
- :operation => :"GoalsApi.users_user_guid_goals_goal_guid_delete",
154
+ :operation => :"GoalsApi.delete_goal",
143
155
  :header_params => header_params,
144
156
  :query_params => query_params,
145
157
  :form_params => form_params,
@@ -150,50 +162,57 @@ module MxPlatformRuby
150
162
 
151
163
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
152
164
  if @api_client.config.debugging
153
- @api_client.config.logger.debug "API called: GoalsApi#users_user_guid_goals_goal_guid_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
165
+ @api_client.config.logger.debug "API called: GoalsApi#delete_goal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
154
166
  end
155
167
  return data, status_code, headers
156
168
  end
157
169
 
158
- # Read a goal
159
- # Read a specific goal.
160
- # @param goal_guid [String] The unique identifier for a goal. Defined by MX.
161
- # @param user_guid [String] The unique identifier for a user.
170
+ # List goals
171
+ # List all goals a user can set.
172
+ # @param accept [String] Specifies the media type expected in the response.
173
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
162
174
  # @param [Hash] opts the optional parameters
163
- # @return [GoalResponseBody]
164
- def users_user_guid_goals_goal_guid_get(goal_guid, user_guid, opts = {})
165
- data, _status_code, _headers = users_user_guid_goals_goal_guid_get_with_http_info(goal_guid, user_guid, opts)
175
+ # @option opts [Integer] :page Results are paginated. Specify current page.
176
+ # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
177
+ # @return [GoalsResponseBody]
178
+ def list_goals(accept, user_guid, opts = {})
179
+ data, _status_code, _headers = list_goals_with_http_info(accept, user_guid, opts)
166
180
  data
167
181
  end
168
182
 
169
- # Read a goal
170
- # Read a specific goal.
171
- # @param goal_guid [String] The unique identifier for a goal. Defined by MX.
172
- # @param user_guid [String] The unique identifier for a user.
183
+ # List goals
184
+ # List all goals a user can set.
185
+ # @param accept [String] Specifies the media type expected in the response.
186
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
173
187
  # @param [Hash] opts the optional parameters
174
- # @return [Array<(GoalResponseBody, Integer, Hash)>] GoalResponseBody data, response status code and response headers
175
- def users_user_guid_goals_goal_guid_get_with_http_info(goal_guid, user_guid, opts = {})
188
+ # @option opts [Integer] :page Results are paginated. Specify current page.
189
+ # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
190
+ # @return [Array<(GoalsResponseBody, Integer, Hash)>] GoalsResponseBody data, response status code and response headers
191
+ def list_goals_with_http_info(accept, user_guid, opts = {})
176
192
  if @api_client.config.debugging
177
- @api_client.config.logger.debug 'Calling API: GoalsApi.users_user_guid_goals_goal_guid_get ...'
193
+ @api_client.config.logger.debug 'Calling API: GoalsApi.list_goals ...'
178
194
  end
179
- # verify the required parameter 'goal_guid' is set
180
- if @api_client.config.client_side_validation && goal_guid.nil?
181
- fail ArgumentError, "Missing the required parameter 'goal_guid' when calling GoalsApi.users_user_guid_goals_goal_guid_get"
195
+ # verify the required parameter 'accept' is set
196
+ if @api_client.config.client_side_validation && accept.nil?
197
+ fail ArgumentError, "Missing the required parameter 'accept' when calling GoalsApi.list_goals"
182
198
  end
183
199
  # verify the required parameter 'user_guid' is set
184
200
  if @api_client.config.client_side_validation && user_guid.nil?
185
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling GoalsApi.users_user_guid_goals_goal_guid_get"
201
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling GoalsApi.list_goals"
186
202
  end
187
203
  # resource path
188
- local_var_path = '/users/{user_guid}/goals/{goal_guid}'.sub('{' + 'goal_guid' + '}', CGI.escape(goal_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
204
+ local_var_path = '/users/{user_guid}/goals'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
189
205
 
190
206
  # query parameters
191
207
  query_params = opts[:query_params] || {}
208
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
209
+ query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
192
210
 
193
211
  # header parameters
194
212
  header_params = opts[:header_params] || {}
195
213
  # HTTP header 'Accept' (if needed)
196
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
214
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
215
+ header_params[:'Accept'] = accept
197
216
 
198
217
  # form parameters
199
218
  form_params = opts[:form_params] || {}
@@ -202,13 +221,13 @@ module MxPlatformRuby
202
221
  post_body = opts[:debug_body]
203
222
 
204
223
  # return_type
205
- return_type = opts[:debug_return_type] || 'GoalResponseBody'
224
+ return_type = opts[:debug_return_type] || 'GoalsResponseBody'
206
225
 
207
226
  # auth_names
208
227
  auth_names = opts[:debug_auth_names] || ['basicAuth']
209
228
 
210
229
  new_options = opts.merge(
211
- :operation => :"GoalsApi.users_user_guid_goals_goal_guid_get",
230
+ :operation => :"GoalsApi.list_goals",
212
231
  :header_params => header_params,
213
232
  :query_params => query_params,
214
233
  :form_params => form_params,
@@ -219,45 +238,39 @@ module MxPlatformRuby
219
238
 
220
239
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
221
240
  if @api_client.config.debugging
222
- @api_client.config.logger.debug "API called: GoalsApi#users_user_guid_goals_goal_guid_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
241
+ @api_client.config.logger.debug "API called: GoalsApi#list_goals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
223
242
  end
224
243
  return data, status_code, headers
225
244
  end
226
245
 
227
- # Update a goal
228
- # This endpoint updates a specific goal.
246
+ # Read a goal
247
+ # Read a specific goal.
229
248
  # @param goal_guid [String] The unique identifier for a goal. Defined by MX.
230
- # @param user_guid [String] The unique identifier for a user.
231
- # @param update_goal_request_body [UpdateGoalRequestBody]
249
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
232
250
  # @param [Hash] opts the optional parameters
233
251
  # @return [GoalResponseBody]
234
- def users_user_guid_goals_goal_guid_put(goal_guid, user_guid, update_goal_request_body, opts = {})
235
- data, _status_code, _headers = users_user_guid_goals_goal_guid_put_with_http_info(goal_guid, user_guid, update_goal_request_body, opts)
252
+ def read_goal(goal_guid, user_guid, opts = {})
253
+ data, _status_code, _headers = read_goal_with_http_info(goal_guid, user_guid, opts)
236
254
  data
237
255
  end
238
256
 
239
- # Update a goal
240
- # This endpoint updates a specific goal.
257
+ # Read a goal
258
+ # Read a specific goal.
241
259
  # @param goal_guid [String] The unique identifier for a goal. Defined by MX.
242
- # @param user_guid [String] The unique identifier for a user.
243
- # @param update_goal_request_body [UpdateGoalRequestBody]
260
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
244
261
  # @param [Hash] opts the optional parameters
245
262
  # @return [Array<(GoalResponseBody, Integer, Hash)>] GoalResponseBody data, response status code and response headers
246
- def users_user_guid_goals_goal_guid_put_with_http_info(goal_guid, user_guid, update_goal_request_body, opts = {})
263
+ def read_goal_with_http_info(goal_guid, user_guid, opts = {})
247
264
  if @api_client.config.debugging
248
- @api_client.config.logger.debug 'Calling API: GoalsApi.users_user_guid_goals_goal_guid_put ...'
265
+ @api_client.config.logger.debug 'Calling API: GoalsApi.read_goal ...'
249
266
  end
250
267
  # verify the required parameter 'goal_guid' is set
251
268
  if @api_client.config.client_side_validation && goal_guid.nil?
252
- fail ArgumentError, "Missing the required parameter 'goal_guid' when calling GoalsApi.users_user_guid_goals_goal_guid_put"
269
+ fail ArgumentError, "Missing the required parameter 'goal_guid' when calling GoalsApi.read_goal"
253
270
  end
254
271
  # verify the required parameter 'user_guid' is set
255
272
  if @api_client.config.client_side_validation && user_guid.nil?
256
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling GoalsApi.users_user_guid_goals_goal_guid_put"
257
- end
258
- # verify the required parameter 'update_goal_request_body' is set
259
- if @api_client.config.client_side_validation && update_goal_request_body.nil?
260
- fail ArgumentError, "Missing the required parameter 'update_goal_request_body' when calling GoalsApi.users_user_guid_goals_goal_guid_put"
273
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling GoalsApi.read_goal"
261
274
  end
262
275
  # resource path
263
276
  local_var_path = '/users/{user_guid}/goals/{goal_guid}'.sub('{' + 'goal_guid' + '}', CGI.escape(goal_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
@@ -269,17 +282,12 @@ module MxPlatformRuby
269
282
  header_params = opts[:header_params] || {}
270
283
  # HTTP header 'Accept' (if needed)
271
284
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
272
- # HTTP header 'Content-Type'
273
- content_type = @api_client.select_header_content_type(['application/json'])
274
- if !content_type.nil?
275
- header_params['Content-Type'] = content_type
276
- end
277
285
 
278
286
  # form parameters
279
287
  form_params = opts[:form_params] || {}
280
288
 
281
289
  # http body (model)
282
- post_body = opts[:debug_body] || @api_client.object_to_http_body(update_goal_request_body)
290
+ post_body = opts[:debug_body]
283
291
 
284
292
  # return_type
285
293
  return_type = opts[:debug_return_type] || 'GoalResponseBody'
@@ -288,7 +296,7 @@ module MxPlatformRuby
288
296
  auth_names = opts[:debug_auth_names] || ['basicAuth']
289
297
 
290
298
  new_options = opts.merge(
291
- :operation => :"GoalsApi.users_user_guid_goals_goal_guid_put",
299
+ :operation => :"GoalsApi.read_goal",
292
300
  :header_params => header_params,
293
301
  :query_params => query_params,
294
302
  :form_params => form_params,
@@ -297,44 +305,44 @@ module MxPlatformRuby
297
305
  :return_type => return_type
298
306
  )
299
307
 
300
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
308
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
301
309
  if @api_client.config.debugging
302
- @api_client.config.logger.debug "API called: GoalsApi#users_user_guid_goals_goal_guid_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
310
+ @api_client.config.logger.debug "API called: GoalsApi#read_goal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
303
311
  end
304
312
  return data, status_code, headers
305
313
  end
306
314
 
307
- # Create a goal
308
- # Create a goal. This endpoint accepts the optional `MX-Skip-Webhook` header and `skip_webhook` parameter.
309
- # @param user_guid [String] The unique identifier for the user.
310
- # @param goal_request_body [GoalRequestBody]
315
+ # Reposition goals
316
+ # This endpoint repositions goal priority levels. If one goal is set to a lower priority, then any other goals need to be adjusted accordingly.
317
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
318
+ # @param reposition_request_body [RepositionRequestBody]
311
319
  # @param [Hash] opts the optional parameters
312
- # @return [GoalResponseBody]
313
- def users_user_guid_goals_post(user_guid, goal_request_body, opts = {})
314
- data, _status_code, _headers = users_user_guid_goals_post_with_http_info(user_guid, goal_request_body, opts)
320
+ # @return [RepositionResponseBody]
321
+ def reposition_goals(user_guid, reposition_request_body, opts = {})
322
+ data, _status_code, _headers = reposition_goals_with_http_info(user_guid, reposition_request_body, opts)
315
323
  data
316
324
  end
317
325
 
318
- # Create a goal
319
- # Create a goal. This endpoint accepts the optional &#x60;MX-Skip-Webhook&#x60; header and &#x60;skip_webhook&#x60; parameter.
320
- # @param user_guid [String] The unique identifier for the user.
321
- # @param goal_request_body [GoalRequestBody]
326
+ # Reposition goals
327
+ # This endpoint repositions goal priority levels. If one goal is set to a lower priority, then any other goals need to be adjusted accordingly.
328
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
329
+ # @param reposition_request_body [RepositionRequestBody]
322
330
  # @param [Hash] opts the optional parameters
323
- # @return [Array<(GoalResponseBody, Integer, Hash)>] GoalResponseBody data, response status code and response headers
324
- def users_user_guid_goals_post_with_http_info(user_guid, goal_request_body, opts = {})
331
+ # @return [Array<(RepositionResponseBody, Integer, Hash)>] RepositionResponseBody data, response status code and response headers
332
+ def reposition_goals_with_http_info(user_guid, reposition_request_body, opts = {})
325
333
  if @api_client.config.debugging
326
- @api_client.config.logger.debug 'Calling API: GoalsApi.users_user_guid_goals_post ...'
334
+ @api_client.config.logger.debug 'Calling API: GoalsApi.reposition_goals ...'
327
335
  end
328
336
  # verify the required parameter 'user_guid' is set
329
337
  if @api_client.config.client_side_validation && user_guid.nil?
330
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling GoalsApi.users_user_guid_goals_post"
338
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling GoalsApi.reposition_goals"
331
339
  end
332
- # verify the required parameter 'goal_request_body' is set
333
- if @api_client.config.client_side_validation && goal_request_body.nil?
334
- fail ArgumentError, "Missing the required parameter 'goal_request_body' when calling GoalsApi.users_user_guid_goals_post"
340
+ # verify the required parameter 'reposition_request_body' is set
341
+ if @api_client.config.client_side_validation && reposition_request_body.nil?
342
+ fail ArgumentError, "Missing the required parameter 'reposition_request_body' when calling GoalsApi.reposition_goals"
335
343
  end
336
344
  # resource path
337
- local_var_path = '/users/{user_guid}/goals'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
345
+ local_var_path = '/users/{user_guid}/goals/reposition'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
338
346
 
339
347
  # query parameters
340
348
  query_params = opts[:query_params] || {}
@@ -344,7 +352,7 @@ module MxPlatformRuby
344
352
  # HTTP header 'Accept' (if needed)
345
353
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
346
354
  # HTTP header 'Content-Type'
347
- content_type = @api_client.select_header_content_type(['application/json'])
355
+ content_type = @api_client.select_header_content_type(['application/vnd.mx.api.v1+json'])
348
356
  if !content_type.nil?
349
357
  header_params['Content-Type'] = content_type
350
358
  end
@@ -353,16 +361,16 @@ module MxPlatformRuby
353
361
  form_params = opts[:form_params] || {}
354
362
 
355
363
  # http body (model)
356
- post_body = opts[:debug_body] || @api_client.object_to_http_body(goal_request_body)
364
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(reposition_request_body)
357
365
 
358
366
  # return_type
359
- return_type = opts[:debug_return_type] || 'GoalResponseBody'
367
+ return_type = opts[:debug_return_type] || 'RepositionResponseBody'
360
368
 
361
369
  # auth_names
362
370
  auth_names = opts[:debug_auth_names] || ['basicAuth']
363
371
 
364
372
  new_options = opts.merge(
365
- :operation => :"GoalsApi.users_user_guid_goals_post",
373
+ :operation => :"GoalsApi.reposition_goals",
366
374
  :header_params => header_params,
367
375
  :query_params => query_params,
368
376
  :form_params => form_params,
@@ -371,44 +379,50 @@ module MxPlatformRuby
371
379
  :return_type => return_type
372
380
  )
373
381
 
374
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
382
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
375
383
  if @api_client.config.debugging
376
- @api_client.config.logger.debug "API called: GoalsApi#users_user_guid_goals_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
384
+ @api_client.config.logger.debug "API called: GoalsApi#reposition_goals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
377
385
  end
378
386
  return data, status_code, headers
379
387
  end
380
388
 
381
- # Reposition goals
382
- # This endpoint repositions goal priority levels. If one goal is set to a lower priority, then any other goals need to be adjusted accordingly.
383
- # @param user_guid [String] The unique identifier for the user.
384
- # @param reposition_request_body [RepositionRequestBody]
389
+ # Update a goal
390
+ # This endpoint updates a specific goal.
391
+ # @param goal_guid [String] The unique identifier for a goal. Defined by MX.
392
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
393
+ # @param update_goal_request_body [UpdateGoalRequestBody]
385
394
  # @param [Hash] opts the optional parameters
386
- # @return [RepositionResponseBody]
387
- def users_user_guid_goals_reposition_put(user_guid, reposition_request_body, opts = {})
388
- data, _status_code, _headers = users_user_guid_goals_reposition_put_with_http_info(user_guid, reposition_request_body, opts)
395
+ # @return [GoalResponseBody]
396
+ def update_goal(goal_guid, user_guid, update_goal_request_body, opts = {})
397
+ data, _status_code, _headers = update_goal_with_http_info(goal_guid, user_guid, update_goal_request_body, opts)
389
398
  data
390
399
  end
391
400
 
392
- # Reposition goals
393
- # This endpoint repositions goal priority levels. If one goal is set to a lower priority, then any other goals need to be adjusted accordingly.
394
- # @param user_guid [String] The unique identifier for the user.
395
- # @param reposition_request_body [RepositionRequestBody]
401
+ # Update a goal
402
+ # This endpoint updates a specific goal.
403
+ # @param goal_guid [String] The unique identifier for a goal. Defined by MX.
404
+ # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
405
+ # @param update_goal_request_body [UpdateGoalRequestBody]
396
406
  # @param [Hash] opts the optional parameters
397
- # @return [Array<(RepositionResponseBody, Integer, Hash)>] RepositionResponseBody data, response status code and response headers
398
- def users_user_guid_goals_reposition_put_with_http_info(user_guid, reposition_request_body, opts = {})
407
+ # @return [Array<(GoalResponseBody, Integer, Hash)>] GoalResponseBody data, response status code and response headers
408
+ def update_goal_with_http_info(goal_guid, user_guid, update_goal_request_body, opts = {})
399
409
  if @api_client.config.debugging
400
- @api_client.config.logger.debug 'Calling API: GoalsApi.users_user_guid_goals_reposition_put ...'
410
+ @api_client.config.logger.debug 'Calling API: GoalsApi.update_goal ...'
411
+ end
412
+ # verify the required parameter 'goal_guid' is set
413
+ if @api_client.config.client_side_validation && goal_guid.nil?
414
+ fail ArgumentError, "Missing the required parameter 'goal_guid' when calling GoalsApi.update_goal"
401
415
  end
402
416
  # verify the required parameter 'user_guid' is set
403
417
  if @api_client.config.client_side_validation && user_guid.nil?
404
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling GoalsApi.users_user_guid_goals_reposition_put"
418
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling GoalsApi.update_goal"
405
419
  end
406
- # verify the required parameter 'reposition_request_body' is set
407
- if @api_client.config.client_side_validation && reposition_request_body.nil?
408
- fail ArgumentError, "Missing the required parameter 'reposition_request_body' when calling GoalsApi.users_user_guid_goals_reposition_put"
420
+ # verify the required parameter 'update_goal_request_body' is set
421
+ if @api_client.config.client_side_validation && update_goal_request_body.nil?
422
+ fail ArgumentError, "Missing the required parameter 'update_goal_request_body' when calling GoalsApi.update_goal"
409
423
  end
410
424
  # resource path
411
- local_var_path = '/users/{user_guid}/goals/reposition'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
425
+ local_var_path = '/users/{user_guid}/goals/{goal_guid}'.sub('{' + 'goal_guid' + '}', CGI.escape(goal_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
412
426
 
413
427
  # query parameters
414
428
  query_params = opts[:query_params] || {}
@@ -427,16 +441,16 @@ module MxPlatformRuby
427
441
  form_params = opts[:form_params] || {}
428
442
 
429
443
  # http body (model)
430
- post_body = opts[:debug_body] || @api_client.object_to_http_body(reposition_request_body)
444
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(update_goal_request_body)
431
445
 
432
446
  # return_type
433
- return_type = opts[:debug_return_type] || 'RepositionResponseBody'
447
+ return_type = opts[:debug_return_type] || 'GoalResponseBody'
434
448
 
435
449
  # auth_names
436
450
  auth_names = opts[:debug_auth_names] || ['basicAuth']
437
451
 
438
452
  new_options = opts.merge(
439
- :operation => :"GoalsApi.users_user_guid_goals_reposition_put",
453
+ :operation => :"GoalsApi.update_goal",
440
454
  :header_params => header_params,
441
455
  :query_params => query_params,
442
456
  :form_params => form_params,
@@ -447,7 +461,7 @@ module MxPlatformRuby
447
461
 
448
462
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
449
463
  if @api_client.config.debugging
450
- @api_client.config.logger.debug "API called: GoalsApi#users_user_guid_goals_reposition_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
464
+ @api_client.config.logger.debug "API called: GoalsApi#update_goal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
451
465
  end
452
466
  return data, status_code, headers
453
467
  end