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.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/docs/ACHResponse.md +74 -0
- data/docs/ACHReturnCreateRequest.md +48 -0
- data/docs/ACHReturnCreateRequestBody.md +18 -0
- data/docs/ACHReturnResponseBody.md +18 -0
- data/docs/{HoldingsResponseBody.md → ACHReturnsResponseBody.md} +4 -4
- data/docs/AccountCreateRequest.md +9 -9
- data/docs/AccountNumberResponse.md +3 -3
- data/docs/AccountResponse.md +37 -37
- data/docs/AccountUpdateRequest.md +30 -30
- data/docs/AccountsApi.md +780 -0
- data/docs/AchReturnApi.md +234 -0
- data/docs/AuthorizationCodeResponseBody.md +1 -1
- data/docs/BudgetResponse.md +1 -1
- data/docs/BudgetsApi.md +115 -115
- data/docs/CategoriesApi.md +600 -0
- data/docs/CategoryCreateRequest.md +1 -1
- data/docs/CategoryResponse.md +1 -1
- data/docs/ConnectWidgetRequest.md +5 -3
- data/docs/CreditCardProduct.md +1 -1
- data/docs/GoalResponse.md +1 -1
- data/docs/GoalsApi.md +117 -113
- data/docs/GoalsResponse.md +1 -1
- data/docs/ImageOptionResponse.md +0 -2
- data/docs/InsightResponse.md +3 -1
- data/docs/InsightResponseBody.md +1 -1
- data/docs/InsightUpdateRequestBody.md +18 -0
- data/docs/InsightsApi.md +170 -91
- data/docs/InstitutionResponse.md +15 -7
- data/docs/InstitutionsApi.md +319 -0
- data/docs/InvestmentHoldingResponse.md +90 -0
- data/docs/InvestmentHoldingResponseBody.md +18 -0
- data/docs/InvestmentHoldingsApi.md +386 -0
- data/docs/InvestmentHoldingsDeactivation.md +20 -0
- data/docs/InvestmentHoldingsResponseBody.md +20 -0
- data/docs/ManagedAccountCreateRequest.md +15 -15
- data/docs/ManagedAccountUpdateRequest.md +14 -14
- data/docs/ManagedDataApi.md +1228 -0
- data/docs/ManagedTransactionCreateRequest.md +1 -1
- data/docs/MemberCreateRequest.md +5 -3
- data/docs/MemberCreateRequestBody.md +3 -3
- data/docs/MemberElements.md +22 -0
- data/docs/MemberResponse.md +1 -3
- data/docs/MemberStatusResponse.md +2 -2
- data/docs/MemberUpdateRequest.md +4 -2
- data/docs/MembersApi.md +997 -0
- data/docs/MerchantsApi.md +226 -0
- data/docs/{MicrodepositRequest.md → MicrodepositElements.md} +7 -7
- data/docs/MicrodepositRequestBody.md +1 -1
- data/docs/MicrodepositResponse.md +0 -14
- data/docs/MicrodepositResponseBody.md +1 -1
- data/docs/MicrodepositResponseBodyMicroDepositInner.md +44 -0
- data/docs/MicrodepositVerifyRequest.md +4 -4
- data/docs/MicrodepositsApi.md +153 -82
- data/docs/MonthlyCashFlowProfileApi.md +151 -0
- data/docs/MonthlyCashFlowResponse.md +3 -3
- data/docs/NotificationResponse.md +36 -0
- data/docs/NotificationResponseBody.md +18 -0
- data/docs/NotificationsApi.md +236 -0
- data/docs/NotificationsResponseBody.md +18 -0
- data/docs/OptionResponse.md +0 -2
- data/docs/PaymentAccount.md +34 -0
- data/docs/PaymentAccountBody.md +18 -0
- data/docs/PaymentAccountBodyPaymentAccount.md +40 -0
- data/docs/PaymentProcessorAuthorizationCodeRequest.md +3 -3
- data/docs/ProcessorAccountNumber.md +34 -0
- data/docs/ProcessorAccountNumberBody.md +18 -0
- data/docs/ProcessorAccountNumberBodyAccountNumbersInner.md +40 -0
- data/docs/ProcessorOwner.md +34 -0
- data/docs/ProcessorOwnerBody.md +20 -0
- data/docs/ProcessorOwnerBodyAccountOwnersInner.md +40 -0
- data/docs/ProcessorTokenApi.md +490 -0
- data/docs/RepeatingTransactionResponse.md +40 -0
- data/docs/RepeatingTransactionsResponseBody.md +18 -0
- data/docs/{RewardsResponse.md → RewardElements.md} +3 -9
- data/docs/RewardResponseBody.md +1 -1
- data/docs/RewardsApi.md +299 -0
- data/docs/RewardsResponseBody.md +1 -1
- data/docs/{RewardResponse.md → RewardsResponseBodyRewardsInner.md} +8 -8
- data/docs/ScheduledPaymentsResponseBody.md +3 -3
- data/docs/SpendingPlanApi.md +142 -63
- data/docs/SpendingPlanIterationItemResponse.md +5 -5
- data/docs/StatementsApi.md +309 -0
- data/docs/StatementsResponseBody.md +3 -3
- data/docs/TaggingsApi.md +377 -0
- data/docs/TaggingsResponseBody.md +3 -3
- data/docs/TagsApi.md +379 -0
- data/docs/TagsResponseBody.md +3 -3
- data/docs/TokenRequestBody.md +18 -0
- data/docs/TokenResponse.md +24 -0
- data/docs/TokenResponseBody.md +18 -0
- data/docs/TransactionIncludesResponse.md +112 -0
- data/docs/TransactionIncludesResponseAllOfClassification.md +20 -0
- data/docs/TransactionIncludesResponseAllOfGeolocation.md +24 -0
- data/docs/TransactionIncludesResponseAllOfMerchant.md +24 -0
- data/docs/TransactionIncludesResponseAllOfRepeatingTransaction.md +22 -0
- data/docs/TransactionResponse.md +38 -36
- data/docs/TransactionRulesApi.md +305 -0
- data/docs/TransactionRulesResponseBody.md +3 -3
- data/docs/TransactionUpdateRequest.md +7 -1
- data/docs/TransactionsApi.md +1232 -14
- data/docs/TransactionsResponseBody.md +3 -3
- data/docs/TransactionsResponseBodyIncludes.md +20 -0
- data/docs/UsersApi.md +375 -0
- data/docs/UsersResponseBody.md +3 -3
- data/docs/VCResponse.md +18 -0
- data/docs/VerifiableCredentialsApi.md +232 -0
- data/docs/WidgetRequest.md +31 -23
- data/docs/WidgetsApi.md +244 -0
- data/lib/mx-platform-ruby/api/accounts_api.rb +781 -0
- data/lib/mx-platform-ruby/api/ach_return_api.rb +231 -0
- data/lib/mx-platform-ruby/api/budgets_api.rb +131 -131
- data/lib/mx-platform-ruby/api/categories_api.rb +576 -0
- data/lib/mx-platform-ruby/api/goals_api.rb +148 -134
- data/lib/mx-platform-ruby/api/insights_api.rb +162 -87
- data/lib/mx-platform-ruby/api/institutions_api.rb +301 -0
- data/lib/mx-platform-ruby/api/investment_holdings_api.rb +373 -0
- data/lib/mx-platform-ruby/api/managed_data_api.rb +1265 -0
- data/lib/mx-platform-ruby/api/members_api.rb +977 -0
- data/lib/mx-platform-ruby/api/merchants_api.rb +214 -0
- data/lib/mx-platform-ruby/api/microdeposits_api.rb +159 -96
- data/lib/mx-platform-ruby/api/monthly_cash_flow_profile_api.rb +159 -0
- data/lib/mx-platform-ruby/api/notifications_api.rb +243 -0
- data/lib/mx-platform-ruby/api/processor_token_api.rb +450 -0
- data/lib/mx-platform-ruby/api/rewards_api.rb +298 -0
- data/lib/mx-platform-ruby/api/spending_plan_api.rb +139 -64
- data/lib/mx-platform-ruby/api/statements_api.rb +316 -0
- data/lib/mx-platform-ruby/api/taggings_api.rb +381 -0
- data/lib/mx-platform-ruby/api/tags_api.rb +388 -0
- data/lib/mx-platform-ruby/api/transaction_rules_api.rb +314 -0
- data/lib/mx-platform-ruby/api/transactions_api.rb +1237 -15
- data/lib/mx-platform-ruby/api/users_api.rb +367 -0
- data/lib/mx-platform-ruby/api/verifiable_credentials_api.rb +235 -0
- data/lib/mx-platform-ruby/api/widgets_api.rb +260 -0
- data/lib/mx-platform-ruby/api_client.rb +2 -2
- data/lib/mx-platform-ruby/api_error.rb +2 -2
- data/lib/mx-platform-ruby/configuration.rb +12 -5
- data/lib/mx-platform-ruby/models/account_create_request.rb +2 -2
- data/lib/mx-platform-ruby/models/account_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/account_number_response.rb +13 -13
- data/lib/mx-platform-ruby/models/account_numbers_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/account_owner_response.rb +2 -2
- data/lib/mx-platform-ruby/models/account_owners_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/account_response.rb +2 -2
- data/lib/mx-platform-ruby/models/account_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/account_update_request.rb +23 -2
- data/lib/mx-platform-ruby/models/account_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/accounts_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/ach_response.rb +485 -0
- data/lib/mx-platform-ruby/models/ach_return_create_request.rb +400 -0
- data/lib/mx-platform-ruby/models/ach_return_create_request_body.rb +214 -0
- data/lib/mx-platform-ruby/models/ach_return_response_body.rb +214 -0
- data/lib/mx-platform-ruby/models/{holdings_response_body.rb → ach_returns_response_body.rb} +13 -13
- data/lib/mx-platform-ruby/models/authorization_code_request.rb +2 -2
- data/lib/mx-platform-ruby/models/authorization_code_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/authorization_code_response.rb +2 -2
- data/lib/mx-platform-ruby/models/authorization_code_response_body.rb +4 -6
- data/lib/mx-platform-ruby/models/budget_create_request.rb +2 -2
- data/lib/mx-platform-ruby/models/budget_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/budget_response.rb +2 -2
- data/lib/mx-platform-ruby/models/budget_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/budget_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/budget_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/categories_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/category_create_request.rb +9 -2
- data/lib/mx-platform-ruby/models/category_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/category_response.rb +3 -2
- data/lib/mx-platform-ruby/models/category_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/category_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/category_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/challenge_response.rb +2 -2
- data/lib/mx-platform-ruby/models/challenges_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/connect_widget_request.rb +13 -3
- data/lib/mx-platform-ruby/models/connect_widget_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/connect_widget_response.rb +2 -2
- data/lib/mx-platform-ruby/models/connect_widget_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/credential_request.rb +2 -2
- data/lib/mx-platform-ruby/models/credential_response.rb +2 -2
- data/lib/mx-platform-ruby/models/credentials_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/credit_card_product.rb +4 -2
- data/lib/mx-platform-ruby/models/credit_card_product_response.rb +2 -2
- data/lib/mx-platform-ruby/models/enhance_transaction_response.rb +2 -2
- data/lib/mx-platform-ruby/models/enhance_transactions_request.rb +2 -2
- data/lib/mx-platform-ruby/models/enhance_transactions_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/enhance_transactions_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/goal_request.rb +2 -2
- data/lib/mx-platform-ruby/models/goal_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/goal_response.rb +2 -2
- data/lib/mx-platform-ruby/models/goal_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/goals_response.rb +2 -2
- data/lib/mx-platform-ruby/models/goals_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/image_option_response.rb +3 -13
- data/lib/mx-platform-ruby/models/insight_response.rb +13 -3
- data/lib/mx-platform-ruby/models/insight_response_body.rb +4 -6
- data/lib/mx-platform-ruby/models/insight_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/{tax_document_response_body.rb → insight_update_request_body.rb} +12 -12
- data/lib/mx-platform-ruby/models/insights_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/institution_response.rb +35 -3
- data/lib/mx-platform-ruby/models/institution_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/institutions_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/investment_holding_response.rb +575 -0
- data/lib/mx-platform-ruby/models/investment_holding_response_body.rb +214 -0
- data/lib/mx-platform-ruby/models/investment_holdings_deactivation.rb +225 -0
- data/lib/mx-platform-ruby/models/investment_holdings_response_body.rb +225 -0
- data/lib/mx-platform-ruby/models/managed_account_create_request.rb +9 -2
- data/lib/mx-platform-ruby/models/managed_account_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/managed_account_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/managed_account_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/managed_member_create_request.rb +2 -2
- data/lib/mx-platform-ruby/models/managed_member_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/managed_member_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/managed_member_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/managed_transaction_create_request.rb +9 -2
- data/lib/mx-platform-ruby/models/managed_transaction_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/managed_transaction_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/managed_transaction_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/member_create_request.rb +40 -6
- data/lib/mx-platform-ruby/models/member_create_request_body.rb +3 -2
- data/lib/mx-platform-ruby/models/member_elements.rb +232 -0
- data/lib/mx-platform-ruby/models/member_response.rb +3 -13
- data/lib/mx-platform-ruby/models/member_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/member_resume_request.rb +2 -2
- data/lib/mx-platform-ruby/models/member_resume_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/member_status_response.rb +13 -13
- data/lib/mx-platform-ruby/models/member_status_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/member_update_request.rb +40 -6
- data/lib/mx-platform-ruby/models/member_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/members_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/merchant_location_response.rb +2 -2
- data/lib/mx-platform-ruby/models/merchant_location_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/merchant_response.rb +2 -2
- data/lib/mx-platform-ruby/models/merchant_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/merchants_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/{microdeposit_request.rb → microdeposit_elements.rb} +29 -29
- data/lib/mx-platform-ruby/models/microdeposit_request_body.rb +3 -3
- data/lib/mx-platform-ruby/models/microdeposit_response.rb +5 -66
- data/lib/mx-platform-ruby/models/microdeposit_response_body.rb +6 -4
- data/lib/mx-platform-ruby/models/microdeposit_response_body_micro_deposit_inner.rb +362 -0
- data/lib/mx-platform-ruby/models/microdeposit_verify_request.rb +4 -4
- data/lib/mx-platform-ruby/models/microdeposit_verify_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/microdeposits_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/monthly_cash_flow_profile_request.rb +2 -2
- data/lib/mx-platform-ruby/models/monthly_cash_flow_profile_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/monthly_cash_flow_response.rb +4 -3
- data/lib/mx-platform-ruby/models/monthly_cash_flow_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/notification_response.rb +305 -0
- data/lib/mx-platform-ruby/models/{tax_documents_response_body.rb → notification_response_body.rb} +12 -23
- data/lib/mx-platform-ruby/models/notifications_response_body.rb +216 -0
- data/lib/mx-platform-ruby/models/o_auth_window_response.rb +2 -2
- data/lib/mx-platform-ruby/models/o_auth_window_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/option_response.rb +3 -13
- data/lib/mx-platform-ruby/models/pagination_response.rb +2 -2
- data/lib/mx-platform-ruby/models/{tax_document_response.rb → payment_account.rb} +66 -76
- data/lib/mx-platform-ruby/models/payment_account_body.rb +214 -0
- data/lib/mx-platform-ruby/models/payment_account_body_payment_account.rb +330 -0
- data/lib/mx-platform-ruby/models/payment_processor_authorization_code_request.rb +23 -5
- data/lib/mx-platform-ruby/models/payment_processor_authorization_code_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/payment_processor_authorization_code_response.rb +2 -2
- data/lib/mx-platform-ruby/models/payment_processor_authorization_code_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/processor_account_number.rb +292 -0
- data/lib/mx-platform-ruby/models/processor_account_number_body.rb +216 -0
- data/lib/mx-platform-ruby/models/processor_account_number_body_account_numbers_inner.rb +327 -0
- data/lib/mx-platform-ruby/models/processor_owner.rb +295 -0
- data/lib/mx-platform-ruby/models/processor_owner_body.rb +225 -0
- data/lib/mx-platform-ruby/models/processor_owner_body_account_owners_inner.rb +330 -0
- data/lib/mx-platform-ruby/models/{holding_response.rb → repeating_transaction_response.rb} +100 -135
- data/lib/mx-platform-ruby/models/repeating_transactions_response_body.rb +216 -0
- data/lib/mx-platform-ruby/models/reposition_request.rb +2 -2
- data/lib/mx-platform-ruby/models/reposition_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/reposition_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/{rewards_response.rb → reward_elements.rb} +9 -36
- data/lib/mx-platform-ruby/models/reward_response_body.rb +3 -3
- data/lib/mx-platform-ruby/models/rewards_response_body.rb +3 -3
- data/lib/mx-platform-ruby/models/{reward_response.rb → rewards_response_body_rewards_inner.rb} +35 -27
- data/lib/mx-platform-ruby/models/scheduled_payment_response.rb +2 -2
- data/lib/mx-platform-ruby/models/scheduled_payments_response_body.rb +15 -15
- data/lib/mx-platform-ruby/models/spending_plan_account_response.rb +2 -2
- data/lib/mx-platform-ruby/models/spending_plan_accounts_response.rb +2 -2
- data/lib/mx-platform-ruby/models/spending_plan_iteration_item_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/spending_plan_iteration_item_response.rb +2 -2
- data/lib/mx-platform-ruby/models/spending_plan_iteration_items_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/spending_plan_iteration_response.rb +2 -2
- data/lib/mx-platform-ruby/models/spending_plan_iterations_response.rb +2 -2
- data/lib/mx-platform-ruby/models/spending_plan_response.rb +2 -2
- data/lib/mx-platform-ruby/models/spending_plans_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/split_transaction_request.rb +2 -2
- data/lib/mx-platform-ruby/models/split_transaction_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/split_transactions_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/statement_response.rb +2 -2
- data/lib/mx-platform-ruby/models/statement_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/statements_response_body.rb +15 -15
- data/lib/mx-platform-ruby/models/tag_create_request.rb +2 -2
- data/lib/mx-platform-ruby/models/tag_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/tag_response.rb +2 -2
- data/lib/mx-platform-ruby/models/tag_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/tag_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/tag_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/tagging_create_request.rb +2 -2
- data/lib/mx-platform-ruby/models/tagging_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/tagging_response.rb +2 -2
- data/lib/mx-platform-ruby/models/tagging_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/tagging_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/tagging_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/taggings_response_body.rb +15 -15
- data/lib/mx-platform-ruby/models/tags_response_body.rb +15 -15
- data/lib/mx-platform-ruby/models/{holding_response_body.rb → token_request_body.rb} +12 -12
- data/lib/mx-platform-ruby/models/token_response.rb +241 -0
- data/lib/mx-platform-ruby/models/token_response_body.rb +216 -0
- data/lib/mx-platform-ruby/models/transaction_create_request.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_create_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_includes_response.rb +692 -0
- data/lib/mx-platform-ruby/models/transaction_includes_response_all_of_classification.rb +257 -0
- data/lib/mx-platform-ruby/models/transaction_includes_response_all_of_geolocation.rb +241 -0
- data/lib/mx-platform-ruby/models/transaction_includes_response_all_of_merchant.rb +241 -0
- data/lib/mx-platform-ruby/models/transaction_includes_response_all_of_repeating_transaction.rb +278 -0
- data/lib/mx-platform-ruby/models/transaction_response.rb +13 -3
- data/lib/mx-platform-ruby/models/transaction_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_rule_create_request.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_rule_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_rule_response.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_rule_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_rule_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_rule_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_rules_response_body.rb +15 -15
- data/lib/mx-platform-ruby/models/transaction_update_request.rb +30 -10
- data/lib/mx-platform-ruby/models/transaction_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/transactions_response_body.rb +15 -15
- data/lib/mx-platform-ruby/models/transactions_response_body_includes.rb +225 -0
- data/lib/mx-platform-ruby/models/update_goal_request.rb +2 -2
- data/lib/mx-platform-ruby/models/update_goal_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/user_create_request.rb +2 -2
- data/lib/mx-platform-ruby/models/user_create_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/user_response.rb +2 -2
- data/lib/mx-platform-ruby/models/user_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/user_update_request.rb +2 -2
- data/lib/mx-platform-ruby/models/user_update_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/users_response_body.rb +15 -15
- data/lib/mx-platform-ruby/models/vc_response.rb +214 -0
- data/lib/mx-platform-ruby/models/widget_request.rb +89 -3
- data/lib/mx-platform-ruby/models/widget_request_body.rb +2 -2
- data/lib/mx-platform-ruby/models/widget_response.rb +2 -2
- data/lib/mx-platform-ruby/models/widget_response_body.rb +2 -2
- data/lib/mx-platform-ruby/version.rb +3 -3
- data/lib/mx-platform-ruby.rb +60 -12
- data/mx-platform-ruby.gemspec +2 -2
- data/openapi/config.yml +1 -1
- data/spec/api/accounts_api_spec.rb +182 -0
- data/spec/api/ach_return_api_spec.rb +77 -0
- data/spec/api/budgets_api_spec.rb +38 -38
- data/spec/api/categories_api_spec.rb +141 -0
- data/spec/api/goals_api_spec.rb +42 -40
- data/spec/api/insights_api_spec.rb +53 -38
- data/spec/api/institutions_api_spec.rb +94 -0
- data/spec/api/investment_holdings_api_spec.rb +104 -0
- data/spec/api/managed_data_api_spec.rb +267 -0
- data/spec/api/members_api_spec.rb +218 -0
- data/spec/api/merchants_api_spec.rb +73 -0
- data/spec/api/microdeposits_api_spec.rb +40 -28
- data/spec/api/monthly_cash_flow_profile_api_spec.rb +60 -0
- data/spec/api/notifications_api_spec.rb +78 -0
- data/spec/api/processor_token_api_spec.rb +115 -0
- data/spec/api/rewards_api_spec.rb +87 -0
- data/spec/api/spending_plan_api_spec.rb +48 -33
- data/spec/api/statements_api_spec.rb +91 -0
- data/spec/api/taggings_api_spec.rb +102 -0
- data/spec/api/tags_api_spec.rb +103 -0
- data/spec/api/transaction_rules_api_spec.rb +89 -0
- data/spec/api/transactions_api_spec.rb +258 -6
- data/spec/api/users_api_spec.rb +101 -0
- data/spec/api/verifiable_credentials_api_spec.rb +76 -0
- data/spec/api/widgets_api_spec.rb +81 -0
- data/spec/models/account_create_request_body_spec.rb +2 -2
- data/spec/models/account_create_request_spec.rb +2 -2
- data/spec/models/account_number_response_spec.rb +5 -5
- data/spec/models/account_numbers_response_body_spec.rb +2 -2
- data/spec/models/account_owner_response_spec.rb +2 -2
- data/spec/models/account_owners_response_body_spec.rb +2 -2
- data/spec/models/account_response_body_spec.rb +2 -2
- data/spec/models/account_response_spec.rb +2 -2
- data/spec/models/account_update_request_body_spec.rb +2 -2
- data/spec/models/account_update_request_spec.rb +2 -2
- data/spec/models/accounts_response_body_spec.rb +2 -2
- data/spec/models/ach_response_spec.rb +204 -0
- data/spec/models/ach_return_create_request_body_spec.rb +36 -0
- data/spec/models/{holding_response_spec.rb → ach_return_create_request_spec.rb} +22 -40
- data/spec/models/ach_return_response_body_spec.rb +36 -0
- data/spec/models/{tax_documents_response_body_spec.rb → ach_returns_response_body_spec.rb} +10 -10
- data/spec/models/authorization_code_request_body_spec.rb +2 -2
- data/spec/models/authorization_code_request_spec.rb +2 -2
- data/spec/models/authorization_code_response_body_spec.rb +2 -2
- data/spec/models/authorization_code_response_spec.rb +2 -2
- data/spec/models/budget_create_request_body_spec.rb +2 -2
- data/spec/models/budget_create_request_spec.rb +2 -2
- data/spec/models/budget_response_body_spec.rb +2 -2
- data/spec/models/budget_response_spec.rb +2 -2
- data/spec/models/budget_update_request_body_spec.rb +2 -2
- data/spec/models/budget_update_request_spec.rb +2 -2
- data/spec/models/categories_response_body_spec.rb +2 -2
- data/spec/models/category_create_request_body_spec.rb +2 -2
- data/spec/models/category_create_request_spec.rb +2 -2
- data/spec/models/category_response_body_spec.rb +2 -2
- data/spec/models/category_response_spec.rb +2 -2
- data/spec/models/category_update_request_body_spec.rb +2 -2
- data/spec/models/category_update_request_spec.rb +2 -2
- data/spec/models/challenge_response_spec.rb +2 -2
- data/spec/models/challenges_response_body_spec.rb +2 -2
- data/spec/models/connect_widget_request_body_spec.rb +2 -2
- data/spec/models/connect_widget_request_spec.rb +8 -2
- data/spec/models/connect_widget_response_body_spec.rb +2 -2
- data/spec/models/connect_widget_response_spec.rb +2 -2
- data/spec/models/credential_request_spec.rb +2 -2
- data/spec/models/credential_response_spec.rb +2 -2
- data/spec/models/credentials_response_body_spec.rb +2 -2
- data/spec/models/credit_card_product_response_spec.rb +2 -2
- data/spec/models/credit_card_product_spec.rb +2 -2
- data/spec/models/enhance_transaction_response_spec.rb +2 -2
- data/spec/models/enhance_transactions_request_body_spec.rb +2 -2
- data/spec/models/enhance_transactions_request_spec.rb +2 -2
- data/spec/models/enhance_transactions_response_body_spec.rb +2 -2
- data/spec/models/goal_request_body_spec.rb +2 -2
- data/spec/models/goal_request_spec.rb +2 -2
- data/spec/models/goal_response_body_spec.rb +2 -2
- data/spec/models/goal_response_spec.rb +2 -2
- data/spec/models/goals_response_body_spec.rb +2 -2
- data/spec/models/goals_response_spec.rb +2 -2
- data/spec/models/image_option_response_spec.rb +2 -8
- data/spec/models/insight_response_body_spec.rb +2 -2
- data/spec/models/insight_response_spec.rb +8 -2
- data/spec/models/insight_update_request_body_spec.rb +36 -0
- data/spec/models/insight_update_request_spec.rb +2 -2
- data/spec/models/insights_response_body_spec.rb +2 -2
- data/spec/models/institution_response_body_spec.rb +2 -2
- data/spec/models/institution_response_spec.rb +20 -2
- data/spec/models/institutions_response_body_spec.rb +2 -2
- data/spec/models/investment_holding_response_body_spec.rb +36 -0
- data/spec/models/investment_holding_response_spec.rb +252 -0
- data/spec/models/investment_holdings_deactivation_spec.rb +42 -0
- data/spec/models/investment_holdings_response_body_spec.rb +42 -0
- data/spec/models/managed_account_create_request_body_spec.rb +2 -2
- data/spec/models/managed_account_create_request_spec.rb +2 -2
- data/spec/models/managed_account_update_request_body_spec.rb +2 -2
- data/spec/models/managed_account_update_request_spec.rb +2 -2
- data/spec/models/managed_member_create_request_body_spec.rb +2 -2
- data/spec/models/managed_member_create_request_spec.rb +2 -2
- data/spec/models/managed_member_update_request_body_spec.rb +2 -2
- data/spec/models/managed_member_update_request_spec.rb +2 -2
- data/spec/models/managed_transaction_create_request_body_spec.rb +2 -2
- data/spec/models/managed_transaction_create_request_spec.rb +2 -2
- data/spec/models/managed_transaction_update_request_body_spec.rb +2 -2
- data/spec/models/managed_transaction_update_request_spec.rb +2 -2
- data/spec/models/member_create_request_body_spec.rb +2 -2
- data/spec/models/member_create_request_spec.rb +12 -2
- data/spec/models/member_elements_spec.rb +48 -0
- data/spec/models/member_response_body_spec.rb +2 -2
- data/spec/models/member_response_spec.rb +2 -8
- data/spec/models/member_resume_request_body_spec.rb +2 -2
- data/spec/models/member_resume_request_spec.rb +2 -2
- data/spec/models/member_status_response_body_spec.rb +2 -2
- data/spec/models/member_status_response_spec.rb +4 -4
- data/spec/models/member_update_request_body_spec.rb +2 -2
- data/spec/models/member_update_request_spec.rb +12 -2
- data/spec/models/members_response_body_spec.rb +2 -2
- data/spec/models/merchant_location_response_body_spec.rb +2 -2
- data/spec/models/merchant_location_response_spec.rb +2 -2
- data/spec/models/merchant_response_body_spec.rb +2 -2
- data/spec/models/merchant_response_spec.rb +2 -2
- data/spec/models/merchants_response_body_spec.rb +2 -2
- data/spec/models/{microdeposit_request_spec.rb → microdeposit_elements_spec.rb} +15 -15
- data/spec/models/microdeposit_request_body_spec.rb +2 -2
- data/spec/models/microdeposit_response_body_micro_deposit_inner_spec.rb +114 -0
- data/spec/models/microdeposit_response_body_spec.rb +2 -2
- data/spec/models/microdeposit_response_spec.rb +2 -44
- data/spec/models/microdeposit_verify_request_body_spec.rb +2 -2
- data/spec/models/microdeposit_verify_request_spec.rb +2 -2
- data/spec/models/microdeposits_response_body_spec.rb +2 -2
- data/spec/models/monthly_cash_flow_profile_request_body_spec.rb +2 -2
- data/spec/models/monthly_cash_flow_profile_request_spec.rb +2 -2
- data/spec/models/monthly_cash_flow_response_body_spec.rb +2 -2
- data/spec/models/monthly_cash_flow_response_spec.rb +2 -2
- data/spec/models/notification_response_body_spec.rb +36 -0
- data/spec/models/{tax_document_response_spec.rb → notification_response_spec.rb} +18 -18
- data/spec/models/notifications_response_body_spec.rb +36 -0
- data/spec/models/o_auth_window_response_body_spec.rb +2 -2
- data/spec/models/o_auth_window_response_spec.rb +2 -2
- data/spec/models/option_response_spec.rb +2 -8
- data/spec/models/pagination_response_spec.rb +2 -2
- data/spec/models/{reward_response_spec.rb → payment_account_body_payment_account_spec.rb} +24 -18
- data/spec/models/payment_account_body_spec.rb +36 -0
- data/spec/models/payment_account_spec.rb +84 -0
- data/spec/models/payment_processor_authorization_code_request_body_spec.rb +2 -2
- data/spec/models/payment_processor_authorization_code_request_spec.rb +2 -2
- data/spec/models/payment_processor_authorization_code_response_body_spec.rb +2 -2
- data/spec/models/payment_processor_authorization_code_response_spec.rb +2 -2
- data/spec/models/processor_account_number_body_account_numbers_inner_spec.rb +102 -0
- data/spec/models/processor_account_number_body_spec.rb +36 -0
- data/spec/models/processor_account_number_spec.rb +84 -0
- data/spec/models/processor_owner_body_account_owners_inner_spec.rb +102 -0
- data/spec/models/{holdings_response_body_spec.rb → processor_owner_body_spec.rb} +9 -9
- data/spec/models/processor_owner_spec.rb +84 -0
- data/spec/models/repeating_transaction_response_spec.rb +110 -0
- data/spec/models/repeating_transactions_response_body_spec.rb +36 -0
- data/spec/models/reposition_request_body_spec.rb +2 -2
- data/spec/models/reposition_request_spec.rb +2 -2
- data/spec/models/reposition_response_body_spec.rb +2 -2
- data/spec/models/reward_elements_spec.rb +78 -0
- data/spec/models/reward_response_body_spec.rb +2 -2
- data/spec/models/{rewards_response_spec.rb → rewards_response_body_rewards_inner_spec.rb} +18 -18
- data/spec/models/rewards_response_body_spec.rb +2 -2
- data/spec/models/scheduled_payment_response_spec.rb +2 -2
- data/spec/models/scheduled_payments_response_body_spec.rb +4 -4
- data/spec/models/spending_plan_account_response_spec.rb +2 -2
- data/spec/models/spending_plan_accounts_response_spec.rb +2 -2
- data/spec/models/spending_plan_iteration_item_create_request_body_spec.rb +2 -2
- data/spec/models/spending_plan_iteration_item_response_spec.rb +2 -2
- data/spec/models/spending_plan_iteration_items_response_body_spec.rb +2 -2
- data/spec/models/spending_plan_iteration_response_spec.rb +2 -2
- data/spec/models/spending_plan_iterations_response_spec.rb +2 -2
- data/spec/models/spending_plan_response_spec.rb +2 -2
- data/spec/models/spending_plans_response_body_spec.rb +2 -2
- data/spec/models/split_transaction_request_body_spec.rb +2 -2
- data/spec/models/split_transaction_request_spec.rb +2 -2
- data/spec/models/split_transactions_response_body_spec.rb +2 -2
- data/spec/models/statement_response_body_spec.rb +2 -2
- data/spec/models/statement_response_spec.rb +2 -2
- data/spec/models/statements_response_body_spec.rb +4 -4
- data/spec/models/tag_create_request_body_spec.rb +2 -2
- data/spec/models/tag_create_request_spec.rb +2 -2
- data/spec/models/tag_response_body_spec.rb +2 -2
- data/spec/models/tag_response_spec.rb +2 -2
- data/spec/models/tag_update_request_body_spec.rb +2 -2
- data/spec/models/tag_update_request_spec.rb +2 -2
- data/spec/models/tagging_create_request_body_spec.rb +2 -2
- data/spec/models/tagging_create_request_spec.rb +2 -2
- data/spec/models/tagging_response_body_spec.rb +2 -2
- data/spec/models/tagging_response_spec.rb +2 -2
- data/spec/models/tagging_update_request_body_spec.rb +2 -2
- data/spec/models/tagging_update_request_spec.rb +2 -2
- data/spec/models/taggings_response_body_spec.rb +4 -4
- data/spec/models/tags_response_body_spec.rb +4 -4
- data/spec/models/{tax_document_response_body_spec.rb → token_request_body_spec.rb} +9 -9
- data/spec/models/token_response_body_spec.rb +36 -0
- data/spec/models/token_response_spec.rb +54 -0
- data/spec/models/transaction_create_request_body_spec.rb +2 -2
- data/spec/models/transaction_create_request_spec.rb +2 -2
- data/spec/models/transaction_create_response_body_spec.rb +2 -2
- data/spec/models/transaction_includes_response_all_of_classification_spec.rb +46 -0
- data/spec/models/transaction_includes_response_all_of_geolocation_spec.rb +54 -0
- data/spec/models/transaction_includes_response_all_of_merchant_spec.rb +54 -0
- data/spec/models/transaction_includes_response_all_of_repeating_transaction_spec.rb +56 -0
- data/spec/models/transaction_includes_response_spec.rb +318 -0
- data/spec/models/transaction_response_body_spec.rb +2 -2
- data/spec/models/transaction_response_spec.rb +8 -2
- data/spec/models/transaction_rule_create_request_body_spec.rb +2 -2
- data/spec/models/transaction_rule_create_request_spec.rb +2 -2
- data/spec/models/transaction_rule_response_body_spec.rb +2 -2
- data/spec/models/transaction_rule_response_spec.rb +2 -2
- data/spec/models/transaction_rule_update_request_body_spec.rb +2 -2
- data/spec/models/transaction_rule_update_request_spec.rb +2 -2
- data/spec/models/transaction_rules_response_body_spec.rb +4 -4
- data/spec/models/transaction_update_request_body_spec.rb +2 -2
- data/spec/models/transaction_update_request_spec.rb +20 -2
- data/spec/models/transactions_response_body_includes_spec.rb +42 -0
- data/spec/models/transactions_response_body_spec.rb +4 -4
- data/spec/models/update_goal_request_body_spec.rb +2 -2
- data/spec/models/update_goal_request_spec.rb +2 -2
- data/spec/models/user_create_request_body_spec.rb +2 -2
- data/spec/models/user_create_request_spec.rb +2 -2
- data/spec/models/user_response_body_spec.rb +2 -2
- data/spec/models/user_response_spec.rb +2 -2
- data/spec/models/user_update_request_body_spec.rb +2 -2
- data/spec/models/user_update_request_spec.rb +2 -2
- data/spec/models/users_response_body_spec.rb +4 -4
- data/spec/models/{holding_response_body_spec.rb → vc_response_spec.rb} +9 -9
- data/spec/models/widget_request_body_spec.rb +2 -2
- data/spec/models/widget_request_spec.rb +30 -2
- data/spec/models/widget_response_body_spec.rb +2 -2
- data/spec/models/widget_response_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- metadata +233 -41
- data/docs/HoldingResponse.md +0 -54
- data/docs/HoldingResponseBody.md +0 -18
- data/docs/MxPlatformApi.md +0 -8065
- data/docs/TaxDocumentResponse.md +0 -36
- data/docs/TaxDocumentResponseBody.md +0 -18
- data/docs/TaxDocumentsResponseBody.md +0 -20
- data/lib/mx-platform-ruby/api/mx_platform_api.rb +0 -7795
- data/spec/api/mx_platform_api_spec.rb +0 -1519
|
@@ -0,0 +1,600 @@
|
|
|
1
|
+
# MxPlatformRuby::CategoriesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://int-api.mx.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_category**](CategoriesApi.md#create_category) | **POST** /users/{user_guid}/categories | Create category |
|
|
8
|
+
| [**delete_category**](CategoriesApi.md#delete_category) | **DELETE** /users/{user_guid}/categories/{category_guid} | Delete category |
|
|
9
|
+
| [**list_categories**](CategoriesApi.md#list_categories) | **GET** /users/{user_guid}/categories | List categories |
|
|
10
|
+
| [**list_default_categories**](CategoriesApi.md#list_default_categories) | **GET** /categories/default | List default categories |
|
|
11
|
+
| [**list_default_categories_by_user**](CategoriesApi.md#list_default_categories_by_user) | **GET** /users/{user_guid}/categories/default | List default categories by user |
|
|
12
|
+
| [**read_category**](CategoriesApi.md#read_category) | **GET** /users/{user_guid}/categories/{category_guid} | Read a custom category |
|
|
13
|
+
| [**read_default_category**](CategoriesApi.md#read_default_category) | **GET** /categories/{category_guid} | Read a default category |
|
|
14
|
+
| [**update_category**](CategoriesApi.md#update_category) | **PUT** /users/{user_guid}/categories/{category_guid} | Update category |
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## create_category
|
|
18
|
+
|
|
19
|
+
> <CategoryResponseBody> create_category(user_guid, category_create_request_body)
|
|
20
|
+
|
|
21
|
+
Create category
|
|
22
|
+
|
|
23
|
+
Use this endpoint to create a new custom category for a specific `user`.
|
|
24
|
+
|
|
25
|
+
### Examples
|
|
26
|
+
|
|
27
|
+
```ruby
|
|
28
|
+
require 'time'
|
|
29
|
+
require 'mx-platform-ruby'
|
|
30
|
+
# setup authorization
|
|
31
|
+
MxPlatformRuby.configure do |config|
|
|
32
|
+
# Configure HTTP basic authorization: basicAuth
|
|
33
|
+
config.username = 'YOUR USERNAME'
|
|
34
|
+
config.password = 'YOUR PASSWORD'
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
api_instance = MxPlatformRuby::CategoriesApi.new
|
|
38
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
39
|
+
category_create_request_body = MxPlatformRuby::CategoryCreateRequestBody.new # CategoryCreateRequestBody | Custom category object to be created
|
|
40
|
+
|
|
41
|
+
begin
|
|
42
|
+
# Create category
|
|
43
|
+
result = api_instance.create_category(user_guid, category_create_request_body)
|
|
44
|
+
p result
|
|
45
|
+
rescue MxPlatformRuby::ApiError => e
|
|
46
|
+
puts "Error when calling CategoriesApi->create_category: #{e}"
|
|
47
|
+
end
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
#### Using the create_category_with_http_info variant
|
|
51
|
+
|
|
52
|
+
This returns an Array which contains the response data, status code and headers.
|
|
53
|
+
|
|
54
|
+
> <Array(<CategoryResponseBody>, Integer, Hash)> create_category_with_http_info(user_guid, category_create_request_body)
|
|
55
|
+
|
|
56
|
+
```ruby
|
|
57
|
+
begin
|
|
58
|
+
# Create category
|
|
59
|
+
data, status_code, headers = api_instance.create_category_with_http_info(user_guid, category_create_request_body)
|
|
60
|
+
p status_code # => 2xx
|
|
61
|
+
p headers # => { ... }
|
|
62
|
+
p data # => <CategoryResponseBody>
|
|
63
|
+
rescue MxPlatformRuby::ApiError => e
|
|
64
|
+
puts "Error when calling CategoriesApi->create_category_with_http_info: #{e}"
|
|
65
|
+
end
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Parameters
|
|
69
|
+
|
|
70
|
+
| Name | Type | Description | Notes |
|
|
71
|
+
| ---- | ---- | ----------- | ----- |
|
|
72
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
73
|
+
| **category_create_request_body** | [**CategoryCreateRequestBody**](CategoryCreateRequestBody.md) | Custom category object to be created | |
|
|
74
|
+
|
|
75
|
+
### Return type
|
|
76
|
+
|
|
77
|
+
[**CategoryResponseBody**](CategoryResponseBody.md)
|
|
78
|
+
|
|
79
|
+
### Authorization
|
|
80
|
+
|
|
81
|
+
[basicAuth](../README.md#basicAuth)
|
|
82
|
+
|
|
83
|
+
### HTTP request headers
|
|
84
|
+
|
|
85
|
+
- **Content-Type**: application/json
|
|
86
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
## delete_category
|
|
90
|
+
|
|
91
|
+
> delete_category(category_guid, user_guid)
|
|
92
|
+
|
|
93
|
+
Delete category
|
|
94
|
+
|
|
95
|
+
Use this endpoint to delete a specific custom category according to its unique GUID. The API will respond with an empty object and a status of `204 No Content`.
|
|
96
|
+
|
|
97
|
+
### Examples
|
|
98
|
+
|
|
99
|
+
```ruby
|
|
100
|
+
require 'time'
|
|
101
|
+
require 'mx-platform-ruby'
|
|
102
|
+
# setup authorization
|
|
103
|
+
MxPlatformRuby.configure do |config|
|
|
104
|
+
# Configure HTTP basic authorization: basicAuth
|
|
105
|
+
config.username = 'YOUR USERNAME'
|
|
106
|
+
config.password = 'YOUR PASSWORD'
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
api_instance = MxPlatformRuby::CategoriesApi.new
|
|
110
|
+
category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique id for a `category`.
|
|
111
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
112
|
+
|
|
113
|
+
begin
|
|
114
|
+
# Delete category
|
|
115
|
+
api_instance.delete_category(category_guid, user_guid)
|
|
116
|
+
rescue MxPlatformRuby::ApiError => e
|
|
117
|
+
puts "Error when calling CategoriesApi->delete_category: #{e}"
|
|
118
|
+
end
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
#### Using the delete_category_with_http_info variant
|
|
122
|
+
|
|
123
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
124
|
+
|
|
125
|
+
> <Array(nil, Integer, Hash)> delete_category_with_http_info(category_guid, user_guid)
|
|
126
|
+
|
|
127
|
+
```ruby
|
|
128
|
+
begin
|
|
129
|
+
# Delete category
|
|
130
|
+
data, status_code, headers = api_instance.delete_category_with_http_info(category_guid, user_guid)
|
|
131
|
+
p status_code # => 2xx
|
|
132
|
+
p headers # => { ... }
|
|
133
|
+
p data # => nil
|
|
134
|
+
rescue MxPlatformRuby::ApiError => e
|
|
135
|
+
puts "Error when calling CategoriesApi->delete_category_with_http_info: #{e}"
|
|
136
|
+
end
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Parameters
|
|
140
|
+
|
|
141
|
+
| Name | Type | Description | Notes |
|
|
142
|
+
| ---- | ---- | ----------- | ----- |
|
|
143
|
+
| **category_guid** | **String** | The unique id for a `category`. | |
|
|
144
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
145
|
+
|
|
146
|
+
### Return type
|
|
147
|
+
|
|
148
|
+
nil (empty response body)
|
|
149
|
+
|
|
150
|
+
### Authorization
|
|
151
|
+
|
|
152
|
+
[basicAuth](../README.md#basicAuth)
|
|
153
|
+
|
|
154
|
+
### HTTP request headers
|
|
155
|
+
|
|
156
|
+
- **Content-Type**: Not defined
|
|
157
|
+
- **Accept**: Not defined
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
## list_categories
|
|
161
|
+
|
|
162
|
+
> <CategoriesResponseBody> list_categories(user_guid, opts)
|
|
163
|
+
|
|
164
|
+
List categories
|
|
165
|
+
|
|
166
|
+
Use this endpoint to list all categories associated with a `user`, including both default and custom categories.
|
|
167
|
+
|
|
168
|
+
### Examples
|
|
169
|
+
|
|
170
|
+
```ruby
|
|
171
|
+
require 'time'
|
|
172
|
+
require 'mx-platform-ruby'
|
|
173
|
+
# setup authorization
|
|
174
|
+
MxPlatformRuby.configure do |config|
|
|
175
|
+
# Configure HTTP basic authorization: basicAuth
|
|
176
|
+
config.username = 'YOUR USERNAME'
|
|
177
|
+
config.password = 'YOUR PASSWORD'
|
|
178
|
+
end
|
|
179
|
+
|
|
180
|
+
api_instance = MxPlatformRuby::CategoriesApi.new
|
|
181
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
182
|
+
opts = {
|
|
183
|
+
page: 1, # Integer | Results are paginated. Specify current page.
|
|
184
|
+
records_per_page: 10 # Integer | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
begin
|
|
188
|
+
# List categories
|
|
189
|
+
result = api_instance.list_categories(user_guid, opts)
|
|
190
|
+
p result
|
|
191
|
+
rescue MxPlatformRuby::ApiError => e
|
|
192
|
+
puts "Error when calling CategoriesApi->list_categories: #{e}"
|
|
193
|
+
end
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
#### Using the list_categories_with_http_info variant
|
|
197
|
+
|
|
198
|
+
This returns an Array which contains the response data, status code and headers.
|
|
199
|
+
|
|
200
|
+
> <Array(<CategoriesResponseBody>, Integer, Hash)> list_categories_with_http_info(user_guid, opts)
|
|
201
|
+
|
|
202
|
+
```ruby
|
|
203
|
+
begin
|
|
204
|
+
# List categories
|
|
205
|
+
data, status_code, headers = api_instance.list_categories_with_http_info(user_guid, opts)
|
|
206
|
+
p status_code # => 2xx
|
|
207
|
+
p headers # => { ... }
|
|
208
|
+
p data # => <CategoriesResponseBody>
|
|
209
|
+
rescue MxPlatformRuby::ApiError => e
|
|
210
|
+
puts "Error when calling CategoriesApi->list_categories_with_http_info: #{e}"
|
|
211
|
+
end
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
### Parameters
|
|
215
|
+
|
|
216
|
+
| Name | Type | Description | Notes |
|
|
217
|
+
| ---- | ---- | ----------- | ----- |
|
|
218
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
219
|
+
| **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
|
|
220
|
+
| **records_per_page** | **Integer** | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead. | [optional] |
|
|
221
|
+
|
|
222
|
+
### Return type
|
|
223
|
+
|
|
224
|
+
[**CategoriesResponseBody**](CategoriesResponseBody.md)
|
|
225
|
+
|
|
226
|
+
### Authorization
|
|
227
|
+
|
|
228
|
+
[basicAuth](../README.md#basicAuth)
|
|
229
|
+
|
|
230
|
+
### HTTP request headers
|
|
231
|
+
|
|
232
|
+
- **Content-Type**: Not defined
|
|
233
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
## list_default_categories
|
|
237
|
+
|
|
238
|
+
> <CategoriesResponseBody> list_default_categories(opts)
|
|
239
|
+
|
|
240
|
+
List default categories
|
|
241
|
+
|
|
242
|
+
Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
|
|
243
|
+
|
|
244
|
+
### Examples
|
|
245
|
+
|
|
246
|
+
```ruby
|
|
247
|
+
require 'time'
|
|
248
|
+
require 'mx-platform-ruby'
|
|
249
|
+
# setup authorization
|
|
250
|
+
MxPlatformRuby.configure do |config|
|
|
251
|
+
# Configure HTTP basic authorization: basicAuth
|
|
252
|
+
config.username = 'YOUR USERNAME'
|
|
253
|
+
config.password = 'YOUR PASSWORD'
|
|
254
|
+
end
|
|
255
|
+
|
|
256
|
+
api_instance = MxPlatformRuby::CategoriesApi.new
|
|
257
|
+
opts = {
|
|
258
|
+
page: 1, # Integer | Results are paginated. Specify current page.
|
|
259
|
+
records_per_page: 10 # Integer | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead.
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
begin
|
|
263
|
+
# List default categories
|
|
264
|
+
result = api_instance.list_default_categories(opts)
|
|
265
|
+
p result
|
|
266
|
+
rescue MxPlatformRuby::ApiError => e
|
|
267
|
+
puts "Error when calling CategoriesApi->list_default_categories: #{e}"
|
|
268
|
+
end
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
#### Using the list_default_categories_with_http_info variant
|
|
272
|
+
|
|
273
|
+
This returns an Array which contains the response data, status code and headers.
|
|
274
|
+
|
|
275
|
+
> <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_with_http_info(opts)
|
|
276
|
+
|
|
277
|
+
```ruby
|
|
278
|
+
begin
|
|
279
|
+
# List default categories
|
|
280
|
+
data, status_code, headers = api_instance.list_default_categories_with_http_info(opts)
|
|
281
|
+
p status_code # => 2xx
|
|
282
|
+
p headers # => { ... }
|
|
283
|
+
p data # => <CategoriesResponseBody>
|
|
284
|
+
rescue MxPlatformRuby::ApiError => e
|
|
285
|
+
puts "Error when calling CategoriesApi->list_default_categories_with_http_info: #{e}"
|
|
286
|
+
end
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
### Parameters
|
|
290
|
+
|
|
291
|
+
| Name | Type | Description | Notes |
|
|
292
|
+
| ---- | ---- | ----------- | ----- |
|
|
293
|
+
| **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
|
|
294
|
+
| **records_per_page** | **Integer** | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead. | [optional] |
|
|
295
|
+
|
|
296
|
+
### Return type
|
|
297
|
+
|
|
298
|
+
[**CategoriesResponseBody**](CategoriesResponseBody.md)
|
|
299
|
+
|
|
300
|
+
### Authorization
|
|
301
|
+
|
|
302
|
+
[basicAuth](../README.md#basicAuth)
|
|
303
|
+
|
|
304
|
+
### HTTP request headers
|
|
305
|
+
|
|
306
|
+
- **Content-Type**: Not defined
|
|
307
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
## list_default_categories_by_user
|
|
311
|
+
|
|
312
|
+
> <CategoriesResponseBody> list_default_categories_by_user(user_guid, opts)
|
|
313
|
+
|
|
314
|
+
List default categories by user
|
|
315
|
+
|
|
316
|
+
Use this endpoint to retrieve a list of all the default categories and subcategories, scoped by user, offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
|
|
317
|
+
|
|
318
|
+
### Examples
|
|
319
|
+
|
|
320
|
+
```ruby
|
|
321
|
+
require 'time'
|
|
322
|
+
require 'mx-platform-ruby'
|
|
323
|
+
# setup authorization
|
|
324
|
+
MxPlatformRuby.configure do |config|
|
|
325
|
+
# Configure HTTP basic authorization: basicAuth
|
|
326
|
+
config.username = 'YOUR USERNAME'
|
|
327
|
+
config.password = 'YOUR PASSWORD'
|
|
328
|
+
end
|
|
329
|
+
|
|
330
|
+
api_instance = MxPlatformRuby::CategoriesApi.new
|
|
331
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
332
|
+
opts = {
|
|
333
|
+
page: 1, # Integer | Results are paginated. Specify current page.
|
|
334
|
+
records_per_page: 10 # Integer | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
|
|
335
|
+
}
|
|
336
|
+
|
|
337
|
+
begin
|
|
338
|
+
# List default categories by user
|
|
339
|
+
result = api_instance.list_default_categories_by_user(user_guid, opts)
|
|
340
|
+
p result
|
|
341
|
+
rescue MxPlatformRuby::ApiError => e
|
|
342
|
+
puts "Error when calling CategoriesApi->list_default_categories_by_user: #{e}"
|
|
343
|
+
end
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
#### Using the list_default_categories_by_user_with_http_info variant
|
|
347
|
+
|
|
348
|
+
This returns an Array which contains the response data, status code and headers.
|
|
349
|
+
|
|
350
|
+
> <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_by_user_with_http_info(user_guid, opts)
|
|
351
|
+
|
|
352
|
+
```ruby
|
|
353
|
+
begin
|
|
354
|
+
# List default categories by user
|
|
355
|
+
data, status_code, headers = api_instance.list_default_categories_by_user_with_http_info(user_guid, opts)
|
|
356
|
+
p status_code # => 2xx
|
|
357
|
+
p headers # => { ... }
|
|
358
|
+
p data # => <CategoriesResponseBody>
|
|
359
|
+
rescue MxPlatformRuby::ApiError => e
|
|
360
|
+
puts "Error when calling CategoriesApi->list_default_categories_by_user_with_http_info: #{e}"
|
|
361
|
+
end
|
|
362
|
+
```
|
|
363
|
+
|
|
364
|
+
### Parameters
|
|
365
|
+
|
|
366
|
+
| Name | Type | Description | Notes |
|
|
367
|
+
| ---- | ---- | ----------- | ----- |
|
|
368
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
369
|
+
| **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
|
|
370
|
+
| **records_per_page** | **Integer** | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead. | [optional] |
|
|
371
|
+
|
|
372
|
+
### Return type
|
|
373
|
+
|
|
374
|
+
[**CategoriesResponseBody**](CategoriesResponseBody.md)
|
|
375
|
+
|
|
376
|
+
### Authorization
|
|
377
|
+
|
|
378
|
+
[basicAuth](../README.md#basicAuth)
|
|
379
|
+
|
|
380
|
+
### HTTP request headers
|
|
381
|
+
|
|
382
|
+
- **Content-Type**: Not defined
|
|
383
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
## read_category
|
|
387
|
+
|
|
388
|
+
> <CategoryResponseBody> read_category(category_guid, user_guid)
|
|
389
|
+
|
|
390
|
+
Read a custom category
|
|
391
|
+
|
|
392
|
+
Use this endpoint to read the attributes of either a default category or a custom category.
|
|
393
|
+
|
|
394
|
+
### Examples
|
|
395
|
+
|
|
396
|
+
```ruby
|
|
397
|
+
require 'time'
|
|
398
|
+
require 'mx-platform-ruby'
|
|
399
|
+
# setup authorization
|
|
400
|
+
MxPlatformRuby.configure do |config|
|
|
401
|
+
# Configure HTTP basic authorization: basicAuth
|
|
402
|
+
config.username = 'YOUR USERNAME'
|
|
403
|
+
config.password = 'YOUR PASSWORD'
|
|
404
|
+
end
|
|
405
|
+
|
|
406
|
+
api_instance = MxPlatformRuby::CategoriesApi.new
|
|
407
|
+
category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique id for a `category`.
|
|
408
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
409
|
+
|
|
410
|
+
begin
|
|
411
|
+
# Read a custom category
|
|
412
|
+
result = api_instance.read_category(category_guid, user_guid)
|
|
413
|
+
p result
|
|
414
|
+
rescue MxPlatformRuby::ApiError => e
|
|
415
|
+
puts "Error when calling CategoriesApi->read_category: #{e}"
|
|
416
|
+
end
|
|
417
|
+
```
|
|
418
|
+
|
|
419
|
+
#### Using the read_category_with_http_info variant
|
|
420
|
+
|
|
421
|
+
This returns an Array which contains the response data, status code and headers.
|
|
422
|
+
|
|
423
|
+
> <Array(<CategoryResponseBody>, Integer, Hash)> read_category_with_http_info(category_guid, user_guid)
|
|
424
|
+
|
|
425
|
+
```ruby
|
|
426
|
+
begin
|
|
427
|
+
# Read a custom category
|
|
428
|
+
data, status_code, headers = api_instance.read_category_with_http_info(category_guid, user_guid)
|
|
429
|
+
p status_code # => 2xx
|
|
430
|
+
p headers # => { ... }
|
|
431
|
+
p data # => <CategoryResponseBody>
|
|
432
|
+
rescue MxPlatformRuby::ApiError => e
|
|
433
|
+
puts "Error when calling CategoriesApi->read_category_with_http_info: #{e}"
|
|
434
|
+
end
|
|
435
|
+
```
|
|
436
|
+
|
|
437
|
+
### Parameters
|
|
438
|
+
|
|
439
|
+
| Name | Type | Description | Notes |
|
|
440
|
+
| ---- | ---- | ----------- | ----- |
|
|
441
|
+
| **category_guid** | **String** | The unique id for a `category`. | |
|
|
442
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
443
|
+
|
|
444
|
+
### Return type
|
|
445
|
+
|
|
446
|
+
[**CategoryResponseBody**](CategoryResponseBody.md)
|
|
447
|
+
|
|
448
|
+
### Authorization
|
|
449
|
+
|
|
450
|
+
[basicAuth](../README.md#basicAuth)
|
|
451
|
+
|
|
452
|
+
### HTTP request headers
|
|
453
|
+
|
|
454
|
+
- **Content-Type**: Not defined
|
|
455
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
## read_default_category
|
|
459
|
+
|
|
460
|
+
> <CategoryResponseBody> read_default_category(category_guid)
|
|
461
|
+
|
|
462
|
+
Read a default category
|
|
463
|
+
|
|
464
|
+
Use this endpoint to read the attributes of a default category.
|
|
465
|
+
|
|
466
|
+
### Examples
|
|
467
|
+
|
|
468
|
+
```ruby
|
|
469
|
+
require 'time'
|
|
470
|
+
require 'mx-platform-ruby'
|
|
471
|
+
# setup authorization
|
|
472
|
+
MxPlatformRuby.configure do |config|
|
|
473
|
+
# Configure HTTP basic authorization: basicAuth
|
|
474
|
+
config.username = 'YOUR USERNAME'
|
|
475
|
+
config.password = 'YOUR PASSWORD'
|
|
476
|
+
end
|
|
477
|
+
|
|
478
|
+
api_instance = MxPlatformRuby::CategoriesApi.new
|
|
479
|
+
category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique id for a `category`.
|
|
480
|
+
|
|
481
|
+
begin
|
|
482
|
+
# Read a default category
|
|
483
|
+
result = api_instance.read_default_category(category_guid)
|
|
484
|
+
p result
|
|
485
|
+
rescue MxPlatformRuby::ApiError => e
|
|
486
|
+
puts "Error when calling CategoriesApi->read_default_category: #{e}"
|
|
487
|
+
end
|
|
488
|
+
```
|
|
489
|
+
|
|
490
|
+
#### Using the read_default_category_with_http_info variant
|
|
491
|
+
|
|
492
|
+
This returns an Array which contains the response data, status code and headers.
|
|
493
|
+
|
|
494
|
+
> <Array(<CategoryResponseBody>, Integer, Hash)> read_default_category_with_http_info(category_guid)
|
|
495
|
+
|
|
496
|
+
```ruby
|
|
497
|
+
begin
|
|
498
|
+
# Read a default category
|
|
499
|
+
data, status_code, headers = api_instance.read_default_category_with_http_info(category_guid)
|
|
500
|
+
p status_code # => 2xx
|
|
501
|
+
p headers # => { ... }
|
|
502
|
+
p data # => <CategoryResponseBody>
|
|
503
|
+
rescue MxPlatformRuby::ApiError => e
|
|
504
|
+
puts "Error when calling CategoriesApi->read_default_category_with_http_info: #{e}"
|
|
505
|
+
end
|
|
506
|
+
```
|
|
507
|
+
|
|
508
|
+
### Parameters
|
|
509
|
+
|
|
510
|
+
| Name | Type | Description | Notes |
|
|
511
|
+
| ---- | ---- | ----------- | ----- |
|
|
512
|
+
| **category_guid** | **String** | The unique id for a `category`. | |
|
|
513
|
+
|
|
514
|
+
### Return type
|
|
515
|
+
|
|
516
|
+
[**CategoryResponseBody**](CategoryResponseBody.md)
|
|
517
|
+
|
|
518
|
+
### Authorization
|
|
519
|
+
|
|
520
|
+
[basicAuth](../README.md#basicAuth)
|
|
521
|
+
|
|
522
|
+
### HTTP request headers
|
|
523
|
+
|
|
524
|
+
- **Content-Type**: Not defined
|
|
525
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
## update_category
|
|
529
|
+
|
|
530
|
+
> <CategoryResponseBody> update_category(category_guid, user_guid, category_update_request_body)
|
|
531
|
+
|
|
532
|
+
Update category
|
|
533
|
+
|
|
534
|
+
Use this endpoint to update the attributes of a custom category according to its unique GUID.
|
|
535
|
+
|
|
536
|
+
### Examples
|
|
537
|
+
|
|
538
|
+
```ruby
|
|
539
|
+
require 'time'
|
|
540
|
+
require 'mx-platform-ruby'
|
|
541
|
+
# setup authorization
|
|
542
|
+
MxPlatformRuby.configure do |config|
|
|
543
|
+
# Configure HTTP basic authorization: basicAuth
|
|
544
|
+
config.username = 'YOUR USERNAME'
|
|
545
|
+
config.password = 'YOUR PASSWORD'
|
|
546
|
+
end
|
|
547
|
+
|
|
548
|
+
api_instance = MxPlatformRuby::CategoriesApi.new
|
|
549
|
+
category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique id for a `category`.
|
|
550
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
551
|
+
category_update_request_body = MxPlatformRuby::CategoryUpdateRequestBody.new # CategoryUpdateRequestBody | Category object to be updated (While no single parameter is required, the `category` object cannot be empty)
|
|
552
|
+
|
|
553
|
+
begin
|
|
554
|
+
# Update category
|
|
555
|
+
result = api_instance.update_category(category_guid, user_guid, category_update_request_body)
|
|
556
|
+
p result
|
|
557
|
+
rescue MxPlatformRuby::ApiError => e
|
|
558
|
+
puts "Error when calling CategoriesApi->update_category: #{e}"
|
|
559
|
+
end
|
|
560
|
+
```
|
|
561
|
+
|
|
562
|
+
#### Using the update_category_with_http_info variant
|
|
563
|
+
|
|
564
|
+
This returns an Array which contains the response data, status code and headers.
|
|
565
|
+
|
|
566
|
+
> <Array(<CategoryResponseBody>, Integer, Hash)> update_category_with_http_info(category_guid, user_guid, category_update_request_body)
|
|
567
|
+
|
|
568
|
+
```ruby
|
|
569
|
+
begin
|
|
570
|
+
# Update category
|
|
571
|
+
data, status_code, headers = api_instance.update_category_with_http_info(category_guid, user_guid, category_update_request_body)
|
|
572
|
+
p status_code # => 2xx
|
|
573
|
+
p headers # => { ... }
|
|
574
|
+
p data # => <CategoryResponseBody>
|
|
575
|
+
rescue MxPlatformRuby::ApiError => e
|
|
576
|
+
puts "Error when calling CategoriesApi->update_category_with_http_info: #{e}"
|
|
577
|
+
end
|
|
578
|
+
```
|
|
579
|
+
|
|
580
|
+
### Parameters
|
|
581
|
+
|
|
582
|
+
| Name | Type | Description | Notes |
|
|
583
|
+
| ---- | ---- | ----------- | ----- |
|
|
584
|
+
| **category_guid** | **String** | The unique id for a `category`. | |
|
|
585
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
586
|
+
| **category_update_request_body** | [**CategoryUpdateRequestBody**](CategoryUpdateRequestBody.md) | Category object to be updated (While no single parameter is required, the `category` object cannot be empty) | |
|
|
587
|
+
|
|
588
|
+
### Return type
|
|
589
|
+
|
|
590
|
+
[**CategoryResponseBody**](CategoryResponseBody.md)
|
|
591
|
+
|
|
592
|
+
### Authorization
|
|
593
|
+
|
|
594
|
+
[basicAuth](../README.md#basicAuth)
|
|
595
|
+
|
|
596
|
+
### HTTP request headers
|
|
597
|
+
|
|
598
|
+
- **Content-Type**: application/json
|
|
599
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
600
|
+
|
data/docs/CategoryResponse.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **created_at** | **String** |
|
|
7
|
+
| **created_at** | **String** | Category creation date-time. | [optional] |
|
|
8
8
|
| **guid** | **String** | | [optional] |
|
|
9
9
|
| **is_default** | **Boolean** | | [optional] |
|
|
10
10
|
| **is_income** | **Boolean** | | [optional] |
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
| **current_member_guid** | **String** | | [optional] |
|
|
11
11
|
| **disable_background_agg** | **Boolean** | | [optional] |
|
|
12
12
|
| **disable_institution_search** | **Boolean** | | [optional] |
|
|
13
|
+
| **enable_app2app** | **Boolean** | This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to `true`. When set to `false`, the widget will **not** direct the end user to the institution's mobile application. This setting is not persistent. This setting currently only affects Chase institutions. | [optional] |
|
|
13
14
|
| **include_identity** | **Boolean** | | [optional] |
|
|
14
15
|
| **include_transactions** | **Boolean** | | [optional] |
|
|
15
16
|
| **is_mobile_webview** | **Boolean** | | [optional] |
|
|
@@ -25,19 +26,20 @@
|
|
|
25
26
|
require 'mx-platform-ruby'
|
|
26
27
|
|
|
27
28
|
instance = MxPlatformRuby::ConnectWidgetRequest.new(
|
|
28
|
-
client_redirect_url: https://
|
|
29
|
+
client_redirect_url: https://{yoursite.com},
|
|
29
30
|
color_scheme: light,
|
|
30
|
-
current_institution_code:
|
|
31
|
+
current_institution_code: mxbank,
|
|
31
32
|
current_member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
|
|
32
33
|
disable_background_agg: false,
|
|
33
34
|
disable_institution_search: false,
|
|
35
|
+
enable_app2app: false,
|
|
34
36
|
include_identity: false,
|
|
35
37
|
include_transactions: true,
|
|
36
38
|
is_mobile_webview: false,
|
|
37
39
|
mode: aggregation,
|
|
38
40
|
oauth_referral_source: BROWSER,
|
|
39
41
|
ui_message_version: 4,
|
|
40
|
-
ui_message_webview_url_scheme:
|
|
42
|
+
ui_message_webview_url_scheme: null,
|
|
41
43
|
update_credentials: false
|
|
42
44
|
)
|
|
43
45
|
```
|
data/docs/CreditCardProduct.md
CHANGED
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
require 'mx-platform-ruby'
|
|
26
26
|
|
|
27
27
|
instance = MxPlatformRuby::CreditCardProduct.new(
|
|
28
|
-
annual_fee: 45
|
|
28
|
+
annual_fee: 45,
|
|
29
29
|
duration_of_introductory_rate_on_balance_transfer: null,
|
|
30
30
|
duration_of_introductory_rate_on_purchases: null,
|
|
31
31
|
guid: CCA-b5bcd822-6d01-4e23-b8d6-846a225e714a,
|
data/docs/GoalResponse.md
CHANGED
|
@@ -28,7 +28,7 @@ require 'mx-platform-ruby'
|
|
|
28
28
|
|
|
29
29
|
instance = MxPlatformRuby::GoalResponse.new(
|
|
30
30
|
account_guid: ACT-4e431124-4a29-abf9-f059-ab232ac14dbf,
|
|
31
|
-
amount: 4500
|
|
31
|
+
amount: 4500,
|
|
32
32
|
completed_at: 2015-06-19T10:37:04-06:00,
|
|
33
33
|
current_amount: 1651.27,
|
|
34
34
|
goal_type_name: PAYOFF,
|