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,1228 @@
|
|
|
1
|
+
# MxPlatformRuby::ManagedDataApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://int-api.mx.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_managed_account**](ManagedDataApi.md#create_managed_account) | **POST** /users/{user_guid}/managed_members/{member_guid}/accounts | Create managed account |
|
|
8
|
+
| [**create_managed_member**](ManagedDataApi.md#create_managed_member) | **POST** /users/{user_guid}/managed_members | Create managed member |
|
|
9
|
+
| [**create_managed_transaction**](ManagedDataApi.md#create_managed_transaction) | **POST** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions | Create managed transaction |
|
|
10
|
+
| [**delete_managed_account**](ManagedDataApi.md#delete_managed_account) | **DELETE** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Delete managed account |
|
|
11
|
+
| [**delete_managed_member**](ManagedDataApi.md#delete_managed_member) | **DELETE** /users/{user_guid}/managed_members/{member_guid} | Delete managed member |
|
|
12
|
+
| [**delete_managed_transaction**](ManagedDataApi.md#delete_managed_transaction) | **DELETE** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid} | Delete managed transaction |
|
|
13
|
+
| [**list_managed_accounts**](ManagedDataApi.md#list_managed_accounts) | **GET** /users/{user_guid}/managed_members/{member_guid}/accounts | List managed accounts |
|
|
14
|
+
| [**list_managed_institutions**](ManagedDataApi.md#list_managed_institutions) | **GET** /managed_institutions | List managed institutions |
|
|
15
|
+
| [**list_managed_members**](ManagedDataApi.md#list_managed_members) | **GET** /users/{user_guid}/managed_members | List managed members |
|
|
16
|
+
| [**list_managed_transactions**](ManagedDataApi.md#list_managed_transactions) | **GET** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions | List managed transactions |
|
|
17
|
+
| [**read_managed_account**](ManagedDataApi.md#read_managed_account) | **GET** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Read managed account |
|
|
18
|
+
| [**read_managed_member**](ManagedDataApi.md#read_managed_member) | **GET** /users/{user_guid}/managed_members/{member_guid} | Read managed member |
|
|
19
|
+
| [**read_managed_transaction**](ManagedDataApi.md#read_managed_transaction) | **GET** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid} | Read managed transaction |
|
|
20
|
+
| [**update_managed_account**](ManagedDataApi.md#update_managed_account) | **PUT** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Update managed account |
|
|
21
|
+
| [**update_managed_member**](ManagedDataApi.md#update_managed_member) | **PUT** /users/{user_guid}/managed_members/{member_guid} | Update managed member |
|
|
22
|
+
| [**update_managed_transaction**](ManagedDataApi.md#update_managed_transaction) | **PUT** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid} | Update managed transaction |
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
## create_managed_account
|
|
26
|
+
|
|
27
|
+
> <AccountResponseBody> create_managed_account(member_guid, user_guid, managed_account_create_request_body)
|
|
28
|
+
|
|
29
|
+
Create managed account
|
|
30
|
+
|
|
31
|
+
Use this endpoint to create a partner-managed account.
|
|
32
|
+
|
|
33
|
+
### Examples
|
|
34
|
+
|
|
35
|
+
```ruby
|
|
36
|
+
require 'time'
|
|
37
|
+
require 'mx-platform-ruby'
|
|
38
|
+
# setup authorization
|
|
39
|
+
MxPlatformRuby.configure do |config|
|
|
40
|
+
# Configure HTTP basic authorization: basicAuth
|
|
41
|
+
config.username = 'YOUR USERNAME'
|
|
42
|
+
config.password = 'YOUR PASSWORD'
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
api_instance = MxPlatformRuby::ManagedDataApi.new
|
|
46
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
|
47
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
48
|
+
managed_account_create_request_body = MxPlatformRuby::ManagedAccountCreateRequestBody.new # ManagedAccountCreateRequestBody | Managed account to be created.
|
|
49
|
+
|
|
50
|
+
begin
|
|
51
|
+
# Create managed account
|
|
52
|
+
result = api_instance.create_managed_account(member_guid, user_guid, managed_account_create_request_body)
|
|
53
|
+
p result
|
|
54
|
+
rescue MxPlatformRuby::ApiError => e
|
|
55
|
+
puts "Error when calling ManagedDataApi->create_managed_account: #{e}"
|
|
56
|
+
end
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
#### Using the create_managed_account_with_http_info variant
|
|
60
|
+
|
|
61
|
+
This returns an Array which contains the response data, status code and headers.
|
|
62
|
+
|
|
63
|
+
> <Array(<AccountResponseBody>, Integer, Hash)> create_managed_account_with_http_info(member_guid, user_guid, managed_account_create_request_body)
|
|
64
|
+
|
|
65
|
+
```ruby
|
|
66
|
+
begin
|
|
67
|
+
# Create managed account
|
|
68
|
+
data, status_code, headers = api_instance.create_managed_account_with_http_info(member_guid, user_guid, managed_account_create_request_body)
|
|
69
|
+
p status_code # => 2xx
|
|
70
|
+
p headers # => { ... }
|
|
71
|
+
p data # => <AccountResponseBody>
|
|
72
|
+
rescue MxPlatformRuby::ApiError => e
|
|
73
|
+
puts "Error when calling ManagedDataApi->create_managed_account_with_http_info: #{e}"
|
|
74
|
+
end
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Parameters
|
|
78
|
+
|
|
79
|
+
| Name | Type | Description | Notes |
|
|
80
|
+
| ---- | ---- | ----------- | ----- |
|
|
81
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
|
82
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
83
|
+
| **managed_account_create_request_body** | [**ManagedAccountCreateRequestBody**](ManagedAccountCreateRequestBody.md) | Managed account to be created. | |
|
|
84
|
+
|
|
85
|
+
### Return type
|
|
86
|
+
|
|
87
|
+
[**AccountResponseBody**](AccountResponseBody.md)
|
|
88
|
+
|
|
89
|
+
### Authorization
|
|
90
|
+
|
|
91
|
+
[basicAuth](../README.md#basicAuth)
|
|
92
|
+
|
|
93
|
+
### HTTP request headers
|
|
94
|
+
|
|
95
|
+
- **Content-Type**: application/json
|
|
96
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
## create_managed_member
|
|
100
|
+
|
|
101
|
+
> <MemberResponseBody> create_managed_member(user_guid, managed_member_create_request_body)
|
|
102
|
+
|
|
103
|
+
Create managed member
|
|
104
|
+
|
|
105
|
+
Use this endpoint to create a new partner-managed `member`.
|
|
106
|
+
|
|
107
|
+
### Examples
|
|
108
|
+
|
|
109
|
+
```ruby
|
|
110
|
+
require 'time'
|
|
111
|
+
require 'mx-platform-ruby'
|
|
112
|
+
# setup authorization
|
|
113
|
+
MxPlatformRuby.configure do |config|
|
|
114
|
+
# Configure HTTP basic authorization: basicAuth
|
|
115
|
+
config.username = 'YOUR USERNAME'
|
|
116
|
+
config.password = 'YOUR PASSWORD'
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
api_instance = MxPlatformRuby::ManagedDataApi.new
|
|
120
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
121
|
+
managed_member_create_request_body = MxPlatformRuby::ManagedMemberCreateRequestBody.new # ManagedMemberCreateRequestBody | Managed member to be created.
|
|
122
|
+
|
|
123
|
+
begin
|
|
124
|
+
# Create managed member
|
|
125
|
+
result = api_instance.create_managed_member(user_guid, managed_member_create_request_body)
|
|
126
|
+
p result
|
|
127
|
+
rescue MxPlatformRuby::ApiError => e
|
|
128
|
+
puts "Error when calling ManagedDataApi->create_managed_member: #{e}"
|
|
129
|
+
end
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
#### Using the create_managed_member_with_http_info variant
|
|
133
|
+
|
|
134
|
+
This returns an Array which contains the response data, status code and headers.
|
|
135
|
+
|
|
136
|
+
> <Array(<MemberResponseBody>, Integer, Hash)> create_managed_member_with_http_info(user_guid, managed_member_create_request_body)
|
|
137
|
+
|
|
138
|
+
```ruby
|
|
139
|
+
begin
|
|
140
|
+
# Create managed member
|
|
141
|
+
data, status_code, headers = api_instance.create_managed_member_with_http_info(user_guid, managed_member_create_request_body)
|
|
142
|
+
p status_code # => 2xx
|
|
143
|
+
p headers # => { ... }
|
|
144
|
+
p data # => <MemberResponseBody>
|
|
145
|
+
rescue MxPlatformRuby::ApiError => e
|
|
146
|
+
puts "Error when calling ManagedDataApi->create_managed_member_with_http_info: #{e}"
|
|
147
|
+
end
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### Parameters
|
|
151
|
+
|
|
152
|
+
| Name | Type | Description | Notes |
|
|
153
|
+
| ---- | ---- | ----------- | ----- |
|
|
154
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
155
|
+
| **managed_member_create_request_body** | [**ManagedMemberCreateRequestBody**](ManagedMemberCreateRequestBody.md) | Managed member to be created. | |
|
|
156
|
+
|
|
157
|
+
### Return type
|
|
158
|
+
|
|
159
|
+
[**MemberResponseBody**](MemberResponseBody.md)
|
|
160
|
+
|
|
161
|
+
### Authorization
|
|
162
|
+
|
|
163
|
+
[basicAuth](../README.md#basicAuth)
|
|
164
|
+
|
|
165
|
+
### HTTP request headers
|
|
166
|
+
|
|
167
|
+
- **Content-Type**: application/json
|
|
168
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
## create_managed_transaction
|
|
172
|
+
|
|
173
|
+
> <TransactionResponseBody> create_managed_transaction(account_guid, member_guid, user_guid, managed_transaction_create_request_body)
|
|
174
|
+
|
|
175
|
+
Create managed transaction
|
|
176
|
+
|
|
177
|
+
Use this endpoint to create a new partner-managed `transaction`.
|
|
178
|
+
|
|
179
|
+
### Examples
|
|
180
|
+
|
|
181
|
+
```ruby
|
|
182
|
+
require 'time'
|
|
183
|
+
require 'mx-platform-ruby'
|
|
184
|
+
# setup authorization
|
|
185
|
+
MxPlatformRuby.configure do |config|
|
|
186
|
+
# Configure HTTP basic authorization: basicAuth
|
|
187
|
+
config.username = 'YOUR USERNAME'
|
|
188
|
+
config.password = 'YOUR PASSWORD'
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
api_instance = MxPlatformRuby::ManagedDataApi.new
|
|
192
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
|
193
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
|
194
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
195
|
+
managed_transaction_create_request_body = MxPlatformRuby::ManagedTransactionCreateRequestBody.new # ManagedTransactionCreateRequestBody | Managed transaction to be created.
|
|
196
|
+
|
|
197
|
+
begin
|
|
198
|
+
# Create managed transaction
|
|
199
|
+
result = api_instance.create_managed_transaction(account_guid, member_guid, user_guid, managed_transaction_create_request_body)
|
|
200
|
+
p result
|
|
201
|
+
rescue MxPlatformRuby::ApiError => e
|
|
202
|
+
puts "Error when calling ManagedDataApi->create_managed_transaction: #{e}"
|
|
203
|
+
end
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
#### Using the create_managed_transaction_with_http_info variant
|
|
207
|
+
|
|
208
|
+
This returns an Array which contains the response data, status code and headers.
|
|
209
|
+
|
|
210
|
+
> <Array(<TransactionResponseBody>, Integer, Hash)> create_managed_transaction_with_http_info(account_guid, member_guid, user_guid, managed_transaction_create_request_body)
|
|
211
|
+
|
|
212
|
+
```ruby
|
|
213
|
+
begin
|
|
214
|
+
# Create managed transaction
|
|
215
|
+
data, status_code, headers = api_instance.create_managed_transaction_with_http_info(account_guid, member_guid, user_guid, managed_transaction_create_request_body)
|
|
216
|
+
p status_code # => 2xx
|
|
217
|
+
p headers # => { ... }
|
|
218
|
+
p data # => <TransactionResponseBody>
|
|
219
|
+
rescue MxPlatformRuby::ApiError => e
|
|
220
|
+
puts "Error when calling ManagedDataApi->create_managed_transaction_with_http_info: #{e}"
|
|
221
|
+
end
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
### Parameters
|
|
225
|
+
|
|
226
|
+
| Name | Type | Description | Notes |
|
|
227
|
+
| ---- | ---- | ----------- | ----- |
|
|
228
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
|
229
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
|
230
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
231
|
+
| **managed_transaction_create_request_body** | [**ManagedTransactionCreateRequestBody**](ManagedTransactionCreateRequestBody.md) | Managed transaction to be created. | |
|
|
232
|
+
|
|
233
|
+
### Return type
|
|
234
|
+
|
|
235
|
+
[**TransactionResponseBody**](TransactionResponseBody.md)
|
|
236
|
+
|
|
237
|
+
### Authorization
|
|
238
|
+
|
|
239
|
+
[basicAuth](../README.md#basicAuth)
|
|
240
|
+
|
|
241
|
+
### HTTP request headers
|
|
242
|
+
|
|
243
|
+
- **Content-Type**: application/json
|
|
244
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
## delete_managed_account
|
|
248
|
+
|
|
249
|
+
> delete_managed_account(account_guid, member_guid, user_guid)
|
|
250
|
+
|
|
251
|
+
Delete managed account
|
|
252
|
+
|
|
253
|
+
Use this endpoint to delete a partner-managed account according to its unique GUID. If successful, the API will respond with a status of `204 No Content`.
|
|
254
|
+
|
|
255
|
+
### Examples
|
|
256
|
+
|
|
257
|
+
```ruby
|
|
258
|
+
require 'time'
|
|
259
|
+
require 'mx-platform-ruby'
|
|
260
|
+
# setup authorization
|
|
261
|
+
MxPlatformRuby.configure do |config|
|
|
262
|
+
# Configure HTTP basic authorization: basicAuth
|
|
263
|
+
config.username = 'YOUR USERNAME'
|
|
264
|
+
config.password = 'YOUR PASSWORD'
|
|
265
|
+
end
|
|
266
|
+
|
|
267
|
+
api_instance = MxPlatformRuby::ManagedDataApi.new
|
|
268
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
|
269
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
|
270
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
271
|
+
|
|
272
|
+
begin
|
|
273
|
+
# Delete managed account
|
|
274
|
+
api_instance.delete_managed_account(account_guid, member_guid, user_guid)
|
|
275
|
+
rescue MxPlatformRuby::ApiError => e
|
|
276
|
+
puts "Error when calling ManagedDataApi->delete_managed_account: #{e}"
|
|
277
|
+
end
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
#### Using the delete_managed_account_with_http_info variant
|
|
281
|
+
|
|
282
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
283
|
+
|
|
284
|
+
> <Array(nil, Integer, Hash)> delete_managed_account_with_http_info(account_guid, member_guid, user_guid)
|
|
285
|
+
|
|
286
|
+
```ruby
|
|
287
|
+
begin
|
|
288
|
+
# Delete managed account
|
|
289
|
+
data, status_code, headers = api_instance.delete_managed_account_with_http_info(account_guid, member_guid, user_guid)
|
|
290
|
+
p status_code # => 2xx
|
|
291
|
+
p headers # => { ... }
|
|
292
|
+
p data # => nil
|
|
293
|
+
rescue MxPlatformRuby::ApiError => e
|
|
294
|
+
puts "Error when calling ManagedDataApi->delete_managed_account_with_http_info: #{e}"
|
|
295
|
+
end
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
### Parameters
|
|
299
|
+
|
|
300
|
+
| Name | Type | Description | Notes |
|
|
301
|
+
| ---- | ---- | ----------- | ----- |
|
|
302
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
|
303
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
|
304
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
305
|
+
|
|
306
|
+
### Return type
|
|
307
|
+
|
|
308
|
+
nil (empty response body)
|
|
309
|
+
|
|
310
|
+
### Authorization
|
|
311
|
+
|
|
312
|
+
[basicAuth](../README.md#basicAuth)
|
|
313
|
+
|
|
314
|
+
### HTTP request headers
|
|
315
|
+
|
|
316
|
+
- **Content-Type**: Not defined
|
|
317
|
+
- **Accept**: Not defined
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
## delete_managed_member
|
|
321
|
+
|
|
322
|
+
> delete_managed_member(member_guid, accept, user_guid)
|
|
323
|
+
|
|
324
|
+
Delete managed member
|
|
325
|
+
|
|
326
|
+
Use this endpoint to delete the specified partner-managed `member`. The endpoint will respond with a status of `204 No Content` without a resource.
|
|
327
|
+
|
|
328
|
+
### Examples
|
|
329
|
+
|
|
330
|
+
```ruby
|
|
331
|
+
require 'time'
|
|
332
|
+
require 'mx-platform-ruby'
|
|
333
|
+
# setup authorization
|
|
334
|
+
MxPlatformRuby.configure do |config|
|
|
335
|
+
# Configure HTTP basic authorization: basicAuth
|
|
336
|
+
config.username = 'YOUR USERNAME'
|
|
337
|
+
config.password = 'YOUR PASSWORD'
|
|
338
|
+
end
|
|
339
|
+
|
|
340
|
+
api_instance = MxPlatformRuby::ManagedDataApi.new
|
|
341
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
|
342
|
+
accept = 'application/vnd.mx.api.v1+json' # String | Specifies the media type expected in the response.
|
|
343
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
344
|
+
|
|
345
|
+
begin
|
|
346
|
+
# Delete managed member
|
|
347
|
+
api_instance.delete_managed_member(member_guid, accept, user_guid)
|
|
348
|
+
rescue MxPlatformRuby::ApiError => e
|
|
349
|
+
puts "Error when calling ManagedDataApi->delete_managed_member: #{e}"
|
|
350
|
+
end
|
|
351
|
+
```
|
|
352
|
+
|
|
353
|
+
#### Using the delete_managed_member_with_http_info variant
|
|
354
|
+
|
|
355
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
356
|
+
|
|
357
|
+
> <Array(nil, Integer, Hash)> delete_managed_member_with_http_info(member_guid, accept, user_guid)
|
|
358
|
+
|
|
359
|
+
```ruby
|
|
360
|
+
begin
|
|
361
|
+
# Delete managed member
|
|
362
|
+
data, status_code, headers = api_instance.delete_managed_member_with_http_info(member_guid, accept, user_guid)
|
|
363
|
+
p status_code # => 2xx
|
|
364
|
+
p headers # => { ... }
|
|
365
|
+
p data # => nil
|
|
366
|
+
rescue MxPlatformRuby::ApiError => e
|
|
367
|
+
puts "Error when calling ManagedDataApi->delete_managed_member_with_http_info: #{e}"
|
|
368
|
+
end
|
|
369
|
+
```
|
|
370
|
+
|
|
371
|
+
### Parameters
|
|
372
|
+
|
|
373
|
+
| Name | Type | Description | Notes |
|
|
374
|
+
| ---- | ---- | ----------- | ----- |
|
|
375
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
|
376
|
+
| **accept** | **String** | Specifies the media type expected in the response. | |
|
|
377
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
378
|
+
|
|
379
|
+
### Return type
|
|
380
|
+
|
|
381
|
+
nil (empty response body)
|
|
382
|
+
|
|
383
|
+
### Authorization
|
|
384
|
+
|
|
385
|
+
[basicAuth](../README.md#basicAuth)
|
|
386
|
+
|
|
387
|
+
### HTTP request headers
|
|
388
|
+
|
|
389
|
+
- **Content-Type**: Not defined
|
|
390
|
+
- **Accept**: Not defined
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
## delete_managed_transaction
|
|
394
|
+
|
|
395
|
+
> delete_managed_transaction(account_guid, member_guid, transaction_guid, user_guid)
|
|
396
|
+
|
|
397
|
+
Delete managed transaction
|
|
398
|
+
|
|
399
|
+
Use this endpoint to delete the specified partner-managed `transaction`. The endpoint will respond with a status of `204 No Content` without a resource.
|
|
400
|
+
|
|
401
|
+
### Examples
|
|
402
|
+
|
|
403
|
+
```ruby
|
|
404
|
+
require 'time'
|
|
405
|
+
require 'mx-platform-ruby'
|
|
406
|
+
# setup authorization
|
|
407
|
+
MxPlatformRuby.configure do |config|
|
|
408
|
+
# Configure HTTP basic authorization: basicAuth
|
|
409
|
+
config.username = 'YOUR USERNAME'
|
|
410
|
+
config.password = 'YOUR PASSWORD'
|
|
411
|
+
end
|
|
412
|
+
|
|
413
|
+
api_instance = MxPlatformRuby::ManagedDataApi.new
|
|
414
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
|
415
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
|
416
|
+
transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
|
|
417
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
418
|
+
|
|
419
|
+
begin
|
|
420
|
+
# Delete managed transaction
|
|
421
|
+
api_instance.delete_managed_transaction(account_guid, member_guid, transaction_guid, user_guid)
|
|
422
|
+
rescue MxPlatformRuby::ApiError => e
|
|
423
|
+
puts "Error when calling ManagedDataApi->delete_managed_transaction: #{e}"
|
|
424
|
+
end
|
|
425
|
+
```
|
|
426
|
+
|
|
427
|
+
#### Using the delete_managed_transaction_with_http_info variant
|
|
428
|
+
|
|
429
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
430
|
+
|
|
431
|
+
> <Array(nil, Integer, Hash)> delete_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid)
|
|
432
|
+
|
|
433
|
+
```ruby
|
|
434
|
+
begin
|
|
435
|
+
# Delete managed transaction
|
|
436
|
+
data, status_code, headers = api_instance.delete_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid)
|
|
437
|
+
p status_code # => 2xx
|
|
438
|
+
p headers # => { ... }
|
|
439
|
+
p data # => nil
|
|
440
|
+
rescue MxPlatformRuby::ApiError => e
|
|
441
|
+
puts "Error when calling ManagedDataApi->delete_managed_transaction_with_http_info: #{e}"
|
|
442
|
+
end
|
|
443
|
+
```
|
|
444
|
+
|
|
445
|
+
### Parameters
|
|
446
|
+
|
|
447
|
+
| Name | Type | Description | Notes |
|
|
448
|
+
| ---- | ---- | ----------- | ----- |
|
|
449
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
|
450
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
|
451
|
+
| **transaction_guid** | **String** | The unique id for a `transaction`. | |
|
|
452
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
453
|
+
|
|
454
|
+
### Return type
|
|
455
|
+
|
|
456
|
+
nil (empty response body)
|
|
457
|
+
|
|
458
|
+
### Authorization
|
|
459
|
+
|
|
460
|
+
[basicAuth](../README.md#basicAuth)
|
|
461
|
+
|
|
462
|
+
### HTTP request headers
|
|
463
|
+
|
|
464
|
+
- **Content-Type**: Not defined
|
|
465
|
+
- **Accept**: Not defined
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
## list_managed_accounts
|
|
469
|
+
|
|
470
|
+
> <AccountsResponseBody> list_managed_accounts(member_guid, user_guid, opts)
|
|
471
|
+
|
|
472
|
+
List managed accounts
|
|
473
|
+
|
|
474
|
+
Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-managed member.
|
|
475
|
+
|
|
476
|
+
### Examples
|
|
477
|
+
|
|
478
|
+
```ruby
|
|
479
|
+
require 'time'
|
|
480
|
+
require 'mx-platform-ruby'
|
|
481
|
+
# setup authorization
|
|
482
|
+
MxPlatformRuby.configure do |config|
|
|
483
|
+
# Configure HTTP basic authorization: basicAuth
|
|
484
|
+
config.username = 'YOUR USERNAME'
|
|
485
|
+
config.password = 'YOUR PASSWORD'
|
|
486
|
+
end
|
|
487
|
+
|
|
488
|
+
api_instance = MxPlatformRuby::ManagedDataApi.new
|
|
489
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
|
490
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
491
|
+
opts = {
|
|
492
|
+
page: 1, # Integer | Results are paginated. Specify current page.
|
|
493
|
+
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.
|
|
494
|
+
}
|
|
495
|
+
|
|
496
|
+
begin
|
|
497
|
+
# List managed accounts
|
|
498
|
+
result = api_instance.list_managed_accounts(member_guid, user_guid, opts)
|
|
499
|
+
p result
|
|
500
|
+
rescue MxPlatformRuby::ApiError => e
|
|
501
|
+
puts "Error when calling ManagedDataApi->list_managed_accounts: #{e}"
|
|
502
|
+
end
|
|
503
|
+
```
|
|
504
|
+
|
|
505
|
+
#### Using the list_managed_accounts_with_http_info variant
|
|
506
|
+
|
|
507
|
+
This returns an Array which contains the response data, status code and headers.
|
|
508
|
+
|
|
509
|
+
> <Array(<AccountsResponseBody>, Integer, Hash)> list_managed_accounts_with_http_info(member_guid, user_guid, opts)
|
|
510
|
+
|
|
511
|
+
```ruby
|
|
512
|
+
begin
|
|
513
|
+
# List managed accounts
|
|
514
|
+
data, status_code, headers = api_instance.list_managed_accounts_with_http_info(member_guid, user_guid, opts)
|
|
515
|
+
p status_code # => 2xx
|
|
516
|
+
p headers # => { ... }
|
|
517
|
+
p data # => <AccountsResponseBody>
|
|
518
|
+
rescue MxPlatformRuby::ApiError => e
|
|
519
|
+
puts "Error when calling ManagedDataApi->list_managed_accounts_with_http_info: #{e}"
|
|
520
|
+
end
|
|
521
|
+
```
|
|
522
|
+
|
|
523
|
+
### Parameters
|
|
524
|
+
|
|
525
|
+
| Name | Type | Description | Notes |
|
|
526
|
+
| ---- | ---- | ----------- | ----- |
|
|
527
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
|
528
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
529
|
+
| **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
|
|
530
|
+
| **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] |
|
|
531
|
+
|
|
532
|
+
### Return type
|
|
533
|
+
|
|
534
|
+
[**AccountsResponseBody**](AccountsResponseBody.md)
|
|
535
|
+
|
|
536
|
+
### Authorization
|
|
537
|
+
|
|
538
|
+
[basicAuth](../README.md#basicAuth)
|
|
539
|
+
|
|
540
|
+
### HTTP request headers
|
|
541
|
+
|
|
542
|
+
- **Content-Type**: Not defined
|
|
543
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
## list_managed_institutions
|
|
547
|
+
|
|
548
|
+
> <InstitutionsResponseBody> list_managed_institutions(opts)
|
|
549
|
+
|
|
550
|
+
List managed institutions
|
|
551
|
+
|
|
552
|
+
This endpoint returns a list of institutions which can be used to create partner-managed members.
|
|
553
|
+
|
|
554
|
+
### Examples
|
|
555
|
+
|
|
556
|
+
```ruby
|
|
557
|
+
require 'time'
|
|
558
|
+
require 'mx-platform-ruby'
|
|
559
|
+
# setup authorization
|
|
560
|
+
MxPlatformRuby.configure do |config|
|
|
561
|
+
# Configure HTTP basic authorization: basicAuth
|
|
562
|
+
config.username = 'YOUR USERNAME'
|
|
563
|
+
config.password = 'YOUR PASSWORD'
|
|
564
|
+
end
|
|
565
|
+
|
|
566
|
+
api_instance = MxPlatformRuby::ManagedDataApi.new
|
|
567
|
+
opts = {
|
|
568
|
+
page: 1, # Integer | Results are paginated. Specify current page.
|
|
569
|
+
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.
|
|
570
|
+
}
|
|
571
|
+
|
|
572
|
+
begin
|
|
573
|
+
# List managed institutions
|
|
574
|
+
result = api_instance.list_managed_institutions(opts)
|
|
575
|
+
p result
|
|
576
|
+
rescue MxPlatformRuby::ApiError => e
|
|
577
|
+
puts "Error when calling ManagedDataApi->list_managed_institutions: #{e}"
|
|
578
|
+
end
|
|
579
|
+
```
|
|
580
|
+
|
|
581
|
+
#### Using the list_managed_institutions_with_http_info variant
|
|
582
|
+
|
|
583
|
+
This returns an Array which contains the response data, status code and headers.
|
|
584
|
+
|
|
585
|
+
> <Array(<InstitutionsResponseBody>, Integer, Hash)> list_managed_institutions_with_http_info(opts)
|
|
586
|
+
|
|
587
|
+
```ruby
|
|
588
|
+
begin
|
|
589
|
+
# List managed institutions
|
|
590
|
+
data, status_code, headers = api_instance.list_managed_institutions_with_http_info(opts)
|
|
591
|
+
p status_code # => 2xx
|
|
592
|
+
p headers # => { ... }
|
|
593
|
+
p data # => <InstitutionsResponseBody>
|
|
594
|
+
rescue MxPlatformRuby::ApiError => e
|
|
595
|
+
puts "Error when calling ManagedDataApi->list_managed_institutions_with_http_info: #{e}"
|
|
596
|
+
end
|
|
597
|
+
```
|
|
598
|
+
|
|
599
|
+
### Parameters
|
|
600
|
+
|
|
601
|
+
| Name | Type | Description | Notes |
|
|
602
|
+
| ---- | ---- | ----------- | ----- |
|
|
603
|
+
| **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
|
|
604
|
+
| **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] |
|
|
605
|
+
|
|
606
|
+
### Return type
|
|
607
|
+
|
|
608
|
+
[**InstitutionsResponseBody**](InstitutionsResponseBody.md)
|
|
609
|
+
|
|
610
|
+
### Authorization
|
|
611
|
+
|
|
612
|
+
[basicAuth](../README.md#basicAuth)
|
|
613
|
+
|
|
614
|
+
### HTTP request headers
|
|
615
|
+
|
|
616
|
+
- **Content-Type**: Not defined
|
|
617
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
## list_managed_members
|
|
621
|
+
|
|
622
|
+
> <MembersResponseBody> list_managed_members(user_guid, opts)
|
|
623
|
+
|
|
624
|
+
List managed members
|
|
625
|
+
|
|
626
|
+
This endpoint returns a list of all the partner-managed members associated with the specified `user`.
|
|
627
|
+
|
|
628
|
+
### Examples
|
|
629
|
+
|
|
630
|
+
```ruby
|
|
631
|
+
require 'time'
|
|
632
|
+
require 'mx-platform-ruby'
|
|
633
|
+
# setup authorization
|
|
634
|
+
MxPlatformRuby.configure do |config|
|
|
635
|
+
# Configure HTTP basic authorization: basicAuth
|
|
636
|
+
config.username = 'YOUR USERNAME'
|
|
637
|
+
config.password = 'YOUR PASSWORD'
|
|
638
|
+
end
|
|
639
|
+
|
|
640
|
+
api_instance = MxPlatformRuby::ManagedDataApi.new
|
|
641
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
642
|
+
opts = {
|
|
643
|
+
page: 1, # Integer | Results are paginated. Specify current page.
|
|
644
|
+
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.
|
|
645
|
+
}
|
|
646
|
+
|
|
647
|
+
begin
|
|
648
|
+
# List managed members
|
|
649
|
+
result = api_instance.list_managed_members(user_guid, opts)
|
|
650
|
+
p result
|
|
651
|
+
rescue MxPlatformRuby::ApiError => e
|
|
652
|
+
puts "Error when calling ManagedDataApi->list_managed_members: #{e}"
|
|
653
|
+
end
|
|
654
|
+
```
|
|
655
|
+
|
|
656
|
+
#### Using the list_managed_members_with_http_info variant
|
|
657
|
+
|
|
658
|
+
This returns an Array which contains the response data, status code and headers.
|
|
659
|
+
|
|
660
|
+
> <Array(<MembersResponseBody>, Integer, Hash)> list_managed_members_with_http_info(user_guid, opts)
|
|
661
|
+
|
|
662
|
+
```ruby
|
|
663
|
+
begin
|
|
664
|
+
# List managed members
|
|
665
|
+
data, status_code, headers = api_instance.list_managed_members_with_http_info(user_guid, opts)
|
|
666
|
+
p status_code # => 2xx
|
|
667
|
+
p headers # => { ... }
|
|
668
|
+
p data # => <MembersResponseBody>
|
|
669
|
+
rescue MxPlatformRuby::ApiError => e
|
|
670
|
+
puts "Error when calling ManagedDataApi->list_managed_members_with_http_info: #{e}"
|
|
671
|
+
end
|
|
672
|
+
```
|
|
673
|
+
|
|
674
|
+
### Parameters
|
|
675
|
+
|
|
676
|
+
| Name | Type | Description | Notes |
|
|
677
|
+
| ---- | ---- | ----------- | ----- |
|
|
678
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
679
|
+
| **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
|
|
680
|
+
| **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] |
|
|
681
|
+
|
|
682
|
+
### Return type
|
|
683
|
+
|
|
684
|
+
[**MembersResponseBody**](MembersResponseBody.md)
|
|
685
|
+
|
|
686
|
+
### Authorization
|
|
687
|
+
|
|
688
|
+
[basicAuth](../README.md#basicAuth)
|
|
689
|
+
|
|
690
|
+
### HTTP request headers
|
|
691
|
+
|
|
692
|
+
- **Content-Type**: Not defined
|
|
693
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
## list_managed_transactions
|
|
697
|
+
|
|
698
|
+
> <TransactionsResponseBody> list_managed_transactions(account_guid, member_guid, user_guid, opts)
|
|
699
|
+
|
|
700
|
+
List managed transactions
|
|
701
|
+
|
|
702
|
+
This endpoint returns a list of all the partner-managed transactions associated with the specified `account`, scoped through a `user` and a `member`.
|
|
703
|
+
|
|
704
|
+
### Examples
|
|
705
|
+
|
|
706
|
+
```ruby
|
|
707
|
+
require 'time'
|
|
708
|
+
require 'mx-platform-ruby'
|
|
709
|
+
# setup authorization
|
|
710
|
+
MxPlatformRuby.configure do |config|
|
|
711
|
+
# Configure HTTP basic authorization: basicAuth
|
|
712
|
+
config.username = 'YOUR USERNAME'
|
|
713
|
+
config.password = 'YOUR PASSWORD'
|
|
714
|
+
end
|
|
715
|
+
|
|
716
|
+
api_instance = MxPlatformRuby::ManagedDataApi.new
|
|
717
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
|
718
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
|
719
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
720
|
+
opts = {
|
|
721
|
+
page: 1, # Integer | Results are paginated. Specify current page.
|
|
722
|
+
from_date: '2024-01-01', # String | Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
|
|
723
|
+
to_date: '2024-03-31', # String | Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.
|
|
724
|
+
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.
|
|
725
|
+
}
|
|
726
|
+
|
|
727
|
+
begin
|
|
728
|
+
# List managed transactions
|
|
729
|
+
result = api_instance.list_managed_transactions(account_guid, member_guid, user_guid, opts)
|
|
730
|
+
p result
|
|
731
|
+
rescue MxPlatformRuby::ApiError => e
|
|
732
|
+
puts "Error when calling ManagedDataApi->list_managed_transactions: #{e}"
|
|
733
|
+
end
|
|
734
|
+
```
|
|
735
|
+
|
|
736
|
+
#### Using the list_managed_transactions_with_http_info variant
|
|
737
|
+
|
|
738
|
+
This returns an Array which contains the response data, status code and headers.
|
|
739
|
+
|
|
740
|
+
> <Array(<TransactionsResponseBody>, Integer, Hash)> list_managed_transactions_with_http_info(account_guid, member_guid, user_guid, opts)
|
|
741
|
+
|
|
742
|
+
```ruby
|
|
743
|
+
begin
|
|
744
|
+
# List managed transactions
|
|
745
|
+
data, status_code, headers = api_instance.list_managed_transactions_with_http_info(account_guid, member_guid, user_guid, opts)
|
|
746
|
+
p status_code # => 2xx
|
|
747
|
+
p headers # => { ... }
|
|
748
|
+
p data # => <TransactionsResponseBody>
|
|
749
|
+
rescue MxPlatformRuby::ApiError => e
|
|
750
|
+
puts "Error when calling ManagedDataApi->list_managed_transactions_with_http_info: #{e}"
|
|
751
|
+
end
|
|
752
|
+
```
|
|
753
|
+
|
|
754
|
+
### Parameters
|
|
755
|
+
|
|
756
|
+
| Name | Type | Description | Notes |
|
|
757
|
+
| ---- | ---- | ----------- | ----- |
|
|
758
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
|
759
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
|
760
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
761
|
+
| **page** | **Integer** | Results are paginated. Specify current page. | [optional] |
|
|
762
|
+
| **from_date** | **String** | Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided. | [optional] |
|
|
763
|
+
| **to_date** | **String** | Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions. | [optional] |
|
|
764
|
+
| **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] |
|
|
765
|
+
|
|
766
|
+
### Return type
|
|
767
|
+
|
|
768
|
+
[**TransactionsResponseBody**](TransactionsResponseBody.md)
|
|
769
|
+
|
|
770
|
+
### Authorization
|
|
771
|
+
|
|
772
|
+
[basicAuth](../README.md#basicAuth)
|
|
773
|
+
|
|
774
|
+
### HTTP request headers
|
|
775
|
+
|
|
776
|
+
- **Content-Type**: Not defined
|
|
777
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
## read_managed_account
|
|
781
|
+
|
|
782
|
+
> <AccountResponseBody> read_managed_account(account_guid, member_guid, user_guid)
|
|
783
|
+
|
|
784
|
+
Read managed account
|
|
785
|
+
|
|
786
|
+
Use this endpoint to read the attributes of a partner-managed account according to its unique guid.
|
|
787
|
+
|
|
788
|
+
### Examples
|
|
789
|
+
|
|
790
|
+
```ruby
|
|
791
|
+
require 'time'
|
|
792
|
+
require 'mx-platform-ruby'
|
|
793
|
+
# setup authorization
|
|
794
|
+
MxPlatformRuby.configure do |config|
|
|
795
|
+
# Configure HTTP basic authorization: basicAuth
|
|
796
|
+
config.username = 'YOUR USERNAME'
|
|
797
|
+
config.password = 'YOUR PASSWORD'
|
|
798
|
+
end
|
|
799
|
+
|
|
800
|
+
api_instance = MxPlatformRuby::ManagedDataApi.new
|
|
801
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
|
802
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
|
803
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
804
|
+
|
|
805
|
+
begin
|
|
806
|
+
# Read managed account
|
|
807
|
+
result = api_instance.read_managed_account(account_guid, member_guid, user_guid)
|
|
808
|
+
p result
|
|
809
|
+
rescue MxPlatformRuby::ApiError => e
|
|
810
|
+
puts "Error when calling ManagedDataApi->read_managed_account: #{e}"
|
|
811
|
+
end
|
|
812
|
+
```
|
|
813
|
+
|
|
814
|
+
#### Using the read_managed_account_with_http_info variant
|
|
815
|
+
|
|
816
|
+
This returns an Array which contains the response data, status code and headers.
|
|
817
|
+
|
|
818
|
+
> <Array(<AccountResponseBody>, Integer, Hash)> read_managed_account_with_http_info(account_guid, member_guid, user_guid)
|
|
819
|
+
|
|
820
|
+
```ruby
|
|
821
|
+
begin
|
|
822
|
+
# Read managed account
|
|
823
|
+
data, status_code, headers = api_instance.read_managed_account_with_http_info(account_guid, member_guid, user_guid)
|
|
824
|
+
p status_code # => 2xx
|
|
825
|
+
p headers # => { ... }
|
|
826
|
+
p data # => <AccountResponseBody>
|
|
827
|
+
rescue MxPlatformRuby::ApiError => e
|
|
828
|
+
puts "Error when calling ManagedDataApi->read_managed_account_with_http_info: #{e}"
|
|
829
|
+
end
|
|
830
|
+
```
|
|
831
|
+
|
|
832
|
+
### Parameters
|
|
833
|
+
|
|
834
|
+
| Name | Type | Description | Notes |
|
|
835
|
+
| ---- | ---- | ----------- | ----- |
|
|
836
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
|
837
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
|
838
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
839
|
+
|
|
840
|
+
### Return type
|
|
841
|
+
|
|
842
|
+
[**AccountResponseBody**](AccountResponseBody.md)
|
|
843
|
+
|
|
844
|
+
### Authorization
|
|
845
|
+
|
|
846
|
+
[basicAuth](../README.md#basicAuth)
|
|
847
|
+
|
|
848
|
+
### HTTP request headers
|
|
849
|
+
|
|
850
|
+
- **Content-Type**: Not defined
|
|
851
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
## read_managed_member
|
|
855
|
+
|
|
856
|
+
> <MemberResponseBody> read_managed_member(member_guid, user_guid)
|
|
857
|
+
|
|
858
|
+
Read managed member
|
|
859
|
+
|
|
860
|
+
This endpoint returns the attributes of the specified partner-managed`member`.
|
|
861
|
+
|
|
862
|
+
### Examples
|
|
863
|
+
|
|
864
|
+
```ruby
|
|
865
|
+
require 'time'
|
|
866
|
+
require 'mx-platform-ruby'
|
|
867
|
+
# setup authorization
|
|
868
|
+
MxPlatformRuby.configure do |config|
|
|
869
|
+
# Configure HTTP basic authorization: basicAuth
|
|
870
|
+
config.username = 'YOUR USERNAME'
|
|
871
|
+
config.password = 'YOUR PASSWORD'
|
|
872
|
+
end
|
|
873
|
+
|
|
874
|
+
api_instance = MxPlatformRuby::ManagedDataApi.new
|
|
875
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
|
876
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
877
|
+
|
|
878
|
+
begin
|
|
879
|
+
# Read managed member
|
|
880
|
+
result = api_instance.read_managed_member(member_guid, user_guid)
|
|
881
|
+
p result
|
|
882
|
+
rescue MxPlatformRuby::ApiError => e
|
|
883
|
+
puts "Error when calling ManagedDataApi->read_managed_member: #{e}"
|
|
884
|
+
end
|
|
885
|
+
```
|
|
886
|
+
|
|
887
|
+
#### Using the read_managed_member_with_http_info variant
|
|
888
|
+
|
|
889
|
+
This returns an Array which contains the response data, status code and headers.
|
|
890
|
+
|
|
891
|
+
> <Array(<MemberResponseBody>, Integer, Hash)> read_managed_member_with_http_info(member_guid, user_guid)
|
|
892
|
+
|
|
893
|
+
```ruby
|
|
894
|
+
begin
|
|
895
|
+
# Read managed member
|
|
896
|
+
data, status_code, headers = api_instance.read_managed_member_with_http_info(member_guid, user_guid)
|
|
897
|
+
p status_code # => 2xx
|
|
898
|
+
p headers # => { ... }
|
|
899
|
+
p data # => <MemberResponseBody>
|
|
900
|
+
rescue MxPlatformRuby::ApiError => e
|
|
901
|
+
puts "Error when calling ManagedDataApi->read_managed_member_with_http_info: #{e}"
|
|
902
|
+
end
|
|
903
|
+
```
|
|
904
|
+
|
|
905
|
+
### Parameters
|
|
906
|
+
|
|
907
|
+
| Name | Type | Description | Notes |
|
|
908
|
+
| ---- | ---- | ----------- | ----- |
|
|
909
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
|
910
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
911
|
+
|
|
912
|
+
### Return type
|
|
913
|
+
|
|
914
|
+
[**MemberResponseBody**](MemberResponseBody.md)
|
|
915
|
+
|
|
916
|
+
### Authorization
|
|
917
|
+
|
|
918
|
+
[basicAuth](../README.md#basicAuth)
|
|
919
|
+
|
|
920
|
+
### HTTP request headers
|
|
921
|
+
|
|
922
|
+
- **Content-Type**: Not defined
|
|
923
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
## read_managed_transaction
|
|
927
|
+
|
|
928
|
+
> <TransactionResponseBody> read_managed_transaction(account_guid, member_guid, transaction_guid, user_guid)
|
|
929
|
+
|
|
930
|
+
Read managed transaction
|
|
931
|
+
|
|
932
|
+
Requests to this endpoint will return the attributes of the specified partner-managed `transaction`.
|
|
933
|
+
|
|
934
|
+
### Examples
|
|
935
|
+
|
|
936
|
+
```ruby
|
|
937
|
+
require 'time'
|
|
938
|
+
require 'mx-platform-ruby'
|
|
939
|
+
# setup authorization
|
|
940
|
+
MxPlatformRuby.configure do |config|
|
|
941
|
+
# Configure HTTP basic authorization: basicAuth
|
|
942
|
+
config.username = 'YOUR USERNAME'
|
|
943
|
+
config.password = 'YOUR PASSWORD'
|
|
944
|
+
end
|
|
945
|
+
|
|
946
|
+
api_instance = MxPlatformRuby::ManagedDataApi.new
|
|
947
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
|
948
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
|
949
|
+
transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
|
|
950
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
951
|
+
|
|
952
|
+
begin
|
|
953
|
+
# Read managed transaction
|
|
954
|
+
result = api_instance.read_managed_transaction(account_guid, member_guid, transaction_guid, user_guid)
|
|
955
|
+
p result
|
|
956
|
+
rescue MxPlatformRuby::ApiError => e
|
|
957
|
+
puts "Error when calling ManagedDataApi->read_managed_transaction: #{e}"
|
|
958
|
+
end
|
|
959
|
+
```
|
|
960
|
+
|
|
961
|
+
#### Using the read_managed_transaction_with_http_info variant
|
|
962
|
+
|
|
963
|
+
This returns an Array which contains the response data, status code and headers.
|
|
964
|
+
|
|
965
|
+
> <Array(<TransactionResponseBody>, Integer, Hash)> read_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid)
|
|
966
|
+
|
|
967
|
+
```ruby
|
|
968
|
+
begin
|
|
969
|
+
# Read managed transaction
|
|
970
|
+
data, status_code, headers = api_instance.read_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid)
|
|
971
|
+
p status_code # => 2xx
|
|
972
|
+
p headers # => { ... }
|
|
973
|
+
p data # => <TransactionResponseBody>
|
|
974
|
+
rescue MxPlatformRuby::ApiError => e
|
|
975
|
+
puts "Error when calling ManagedDataApi->read_managed_transaction_with_http_info: #{e}"
|
|
976
|
+
end
|
|
977
|
+
```
|
|
978
|
+
|
|
979
|
+
### Parameters
|
|
980
|
+
|
|
981
|
+
| Name | Type | Description | Notes |
|
|
982
|
+
| ---- | ---- | ----------- | ----- |
|
|
983
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
|
984
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
|
985
|
+
| **transaction_guid** | **String** | The unique id for a `transaction`. | |
|
|
986
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
987
|
+
|
|
988
|
+
### Return type
|
|
989
|
+
|
|
990
|
+
[**TransactionResponseBody**](TransactionResponseBody.md)
|
|
991
|
+
|
|
992
|
+
### Authorization
|
|
993
|
+
|
|
994
|
+
[basicAuth](../README.md#basicAuth)
|
|
995
|
+
|
|
996
|
+
### HTTP request headers
|
|
997
|
+
|
|
998
|
+
- **Content-Type**: Not defined
|
|
999
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
## update_managed_account
|
|
1003
|
+
|
|
1004
|
+
> <AccountResponseBody> update_managed_account(account_guid, member_guid, user_guid, managed_account_update_request_body)
|
|
1005
|
+
|
|
1006
|
+
Update managed account
|
|
1007
|
+
|
|
1008
|
+
Use this endpoint to update the attributes of a partner-managed account according to its unique GUID.
|
|
1009
|
+
|
|
1010
|
+
### Examples
|
|
1011
|
+
|
|
1012
|
+
```ruby
|
|
1013
|
+
require 'time'
|
|
1014
|
+
require 'mx-platform-ruby'
|
|
1015
|
+
# setup authorization
|
|
1016
|
+
MxPlatformRuby.configure do |config|
|
|
1017
|
+
# Configure HTTP basic authorization: basicAuth
|
|
1018
|
+
config.username = 'YOUR USERNAME'
|
|
1019
|
+
config.password = 'YOUR PASSWORD'
|
|
1020
|
+
end
|
|
1021
|
+
|
|
1022
|
+
api_instance = MxPlatformRuby::ManagedDataApi.new
|
|
1023
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
|
1024
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
|
1025
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
1026
|
+
managed_account_update_request_body = MxPlatformRuby::ManagedAccountUpdateRequestBody.new # ManagedAccountUpdateRequestBody | Managed account object to be updated (While no single parameter is required, the request body can't be empty)
|
|
1027
|
+
|
|
1028
|
+
begin
|
|
1029
|
+
# Update managed account
|
|
1030
|
+
result = api_instance.update_managed_account(account_guid, member_guid, user_guid, managed_account_update_request_body)
|
|
1031
|
+
p result
|
|
1032
|
+
rescue MxPlatformRuby::ApiError => e
|
|
1033
|
+
puts "Error when calling ManagedDataApi->update_managed_account: #{e}"
|
|
1034
|
+
end
|
|
1035
|
+
```
|
|
1036
|
+
|
|
1037
|
+
#### Using the update_managed_account_with_http_info variant
|
|
1038
|
+
|
|
1039
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1040
|
+
|
|
1041
|
+
> <Array(<AccountResponseBody>, Integer, Hash)> update_managed_account_with_http_info(account_guid, member_guid, user_guid, managed_account_update_request_body)
|
|
1042
|
+
|
|
1043
|
+
```ruby
|
|
1044
|
+
begin
|
|
1045
|
+
# Update managed account
|
|
1046
|
+
data, status_code, headers = api_instance.update_managed_account_with_http_info(account_guid, member_guid, user_guid, managed_account_update_request_body)
|
|
1047
|
+
p status_code # => 2xx
|
|
1048
|
+
p headers # => { ... }
|
|
1049
|
+
p data # => <AccountResponseBody>
|
|
1050
|
+
rescue MxPlatformRuby::ApiError => e
|
|
1051
|
+
puts "Error when calling ManagedDataApi->update_managed_account_with_http_info: #{e}"
|
|
1052
|
+
end
|
|
1053
|
+
```
|
|
1054
|
+
|
|
1055
|
+
### Parameters
|
|
1056
|
+
|
|
1057
|
+
| Name | Type | Description | Notes |
|
|
1058
|
+
| ---- | ---- | ----------- | ----- |
|
|
1059
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
|
1060
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
|
1061
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
1062
|
+
| **managed_account_update_request_body** | [**ManagedAccountUpdateRequestBody**](ManagedAccountUpdateRequestBody.md) | Managed account object to be updated (While no single parameter is required, the request body can't be empty) | |
|
|
1063
|
+
|
|
1064
|
+
### Return type
|
|
1065
|
+
|
|
1066
|
+
[**AccountResponseBody**](AccountResponseBody.md)
|
|
1067
|
+
|
|
1068
|
+
### Authorization
|
|
1069
|
+
|
|
1070
|
+
[basicAuth](../README.md#basicAuth)
|
|
1071
|
+
|
|
1072
|
+
### HTTP request headers
|
|
1073
|
+
|
|
1074
|
+
- **Content-Type**: application/json
|
|
1075
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
## update_managed_member
|
|
1079
|
+
|
|
1080
|
+
> <MemberResponseBody> update_managed_member(member_guid, user_guid, managed_member_update_request_body)
|
|
1081
|
+
|
|
1082
|
+
Update managed member
|
|
1083
|
+
|
|
1084
|
+
Use this endpoint to update the attributes of the specified partner_managed `member`.
|
|
1085
|
+
|
|
1086
|
+
### Examples
|
|
1087
|
+
|
|
1088
|
+
```ruby
|
|
1089
|
+
require 'time'
|
|
1090
|
+
require 'mx-platform-ruby'
|
|
1091
|
+
# setup authorization
|
|
1092
|
+
MxPlatformRuby.configure do |config|
|
|
1093
|
+
# Configure HTTP basic authorization: basicAuth
|
|
1094
|
+
config.username = 'YOUR USERNAME'
|
|
1095
|
+
config.password = 'YOUR PASSWORD'
|
|
1096
|
+
end
|
|
1097
|
+
|
|
1098
|
+
api_instance = MxPlatformRuby::ManagedDataApi.new
|
|
1099
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
|
1100
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
1101
|
+
managed_member_update_request_body = MxPlatformRuby::ManagedMemberUpdateRequestBody.new # ManagedMemberUpdateRequestBody | Managed member object to be updated (While no single parameter is required, the request body can't be empty)
|
|
1102
|
+
|
|
1103
|
+
begin
|
|
1104
|
+
# Update managed member
|
|
1105
|
+
result = api_instance.update_managed_member(member_guid, user_guid, managed_member_update_request_body)
|
|
1106
|
+
p result
|
|
1107
|
+
rescue MxPlatformRuby::ApiError => e
|
|
1108
|
+
puts "Error when calling ManagedDataApi->update_managed_member: #{e}"
|
|
1109
|
+
end
|
|
1110
|
+
```
|
|
1111
|
+
|
|
1112
|
+
#### Using the update_managed_member_with_http_info variant
|
|
1113
|
+
|
|
1114
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1115
|
+
|
|
1116
|
+
> <Array(<MemberResponseBody>, Integer, Hash)> update_managed_member_with_http_info(member_guid, user_guid, managed_member_update_request_body)
|
|
1117
|
+
|
|
1118
|
+
```ruby
|
|
1119
|
+
begin
|
|
1120
|
+
# Update managed member
|
|
1121
|
+
data, status_code, headers = api_instance.update_managed_member_with_http_info(member_guid, user_guid, managed_member_update_request_body)
|
|
1122
|
+
p status_code # => 2xx
|
|
1123
|
+
p headers # => { ... }
|
|
1124
|
+
p data # => <MemberResponseBody>
|
|
1125
|
+
rescue MxPlatformRuby::ApiError => e
|
|
1126
|
+
puts "Error when calling ManagedDataApi->update_managed_member_with_http_info: #{e}"
|
|
1127
|
+
end
|
|
1128
|
+
```
|
|
1129
|
+
|
|
1130
|
+
### Parameters
|
|
1131
|
+
|
|
1132
|
+
| Name | Type | Description | Notes |
|
|
1133
|
+
| ---- | ---- | ----------- | ----- |
|
|
1134
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
|
1135
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
1136
|
+
| **managed_member_update_request_body** | [**ManagedMemberUpdateRequestBody**](ManagedMemberUpdateRequestBody.md) | Managed member object to be updated (While no single parameter is required, the request body can't be empty) | |
|
|
1137
|
+
|
|
1138
|
+
### Return type
|
|
1139
|
+
|
|
1140
|
+
[**MemberResponseBody**](MemberResponseBody.md)
|
|
1141
|
+
|
|
1142
|
+
### Authorization
|
|
1143
|
+
|
|
1144
|
+
[basicAuth](../README.md#basicAuth)
|
|
1145
|
+
|
|
1146
|
+
### HTTP request headers
|
|
1147
|
+
|
|
1148
|
+
- **Content-Type**: application/json
|
|
1149
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
## update_managed_transaction
|
|
1153
|
+
|
|
1154
|
+
> <TransactionResponseBody> update_managed_transaction(account_guid, member_guid, transaction_guid, user_guid, managed_transaction_update_request_body)
|
|
1155
|
+
|
|
1156
|
+
Update managed transaction
|
|
1157
|
+
|
|
1158
|
+
Use this endpoint to update the attributes of the specified partner_managed `transaction`.
|
|
1159
|
+
|
|
1160
|
+
### Examples
|
|
1161
|
+
|
|
1162
|
+
```ruby
|
|
1163
|
+
require 'time'
|
|
1164
|
+
require 'mx-platform-ruby'
|
|
1165
|
+
# setup authorization
|
|
1166
|
+
MxPlatformRuby.configure do |config|
|
|
1167
|
+
# Configure HTTP basic authorization: basicAuth
|
|
1168
|
+
config.username = 'YOUR USERNAME'
|
|
1169
|
+
config.password = 'YOUR PASSWORD'
|
|
1170
|
+
end
|
|
1171
|
+
|
|
1172
|
+
api_instance = MxPlatformRuby::ManagedDataApi.new
|
|
1173
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
|
1174
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
|
1175
|
+
transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
|
|
1176
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
|
|
1177
|
+
managed_transaction_update_request_body = MxPlatformRuby::ManagedTransactionUpdateRequestBody.new # ManagedTransactionUpdateRequestBody | Managed transaction object to be updated (While no single parameter is required, the request body can't be empty)
|
|
1178
|
+
|
|
1179
|
+
begin
|
|
1180
|
+
# Update managed transaction
|
|
1181
|
+
result = api_instance.update_managed_transaction(account_guid, member_guid, transaction_guid, user_guid, managed_transaction_update_request_body)
|
|
1182
|
+
p result
|
|
1183
|
+
rescue MxPlatformRuby::ApiError => e
|
|
1184
|
+
puts "Error when calling ManagedDataApi->update_managed_transaction: #{e}"
|
|
1185
|
+
end
|
|
1186
|
+
```
|
|
1187
|
+
|
|
1188
|
+
#### Using the update_managed_transaction_with_http_info variant
|
|
1189
|
+
|
|
1190
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1191
|
+
|
|
1192
|
+
> <Array(<TransactionResponseBody>, Integer, Hash)> update_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid, managed_transaction_update_request_body)
|
|
1193
|
+
|
|
1194
|
+
```ruby
|
|
1195
|
+
begin
|
|
1196
|
+
# Update managed transaction
|
|
1197
|
+
data, status_code, headers = api_instance.update_managed_transaction_with_http_info(account_guid, member_guid, transaction_guid, user_guid, managed_transaction_update_request_body)
|
|
1198
|
+
p status_code # => 2xx
|
|
1199
|
+
p headers # => { ... }
|
|
1200
|
+
p data # => <TransactionResponseBody>
|
|
1201
|
+
rescue MxPlatformRuby::ApiError => e
|
|
1202
|
+
puts "Error when calling ManagedDataApi->update_managed_transaction_with_http_info: #{e}"
|
|
1203
|
+
end
|
|
1204
|
+
```
|
|
1205
|
+
|
|
1206
|
+
### Parameters
|
|
1207
|
+
|
|
1208
|
+
| Name | Type | Description | Notes |
|
|
1209
|
+
| ---- | ---- | ----------- | ----- |
|
|
1210
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
|
1211
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
|
1212
|
+
| **transaction_guid** | **String** | The unique id for a `transaction`. | |
|
|
1213
|
+
| **user_guid** | **String** | The unique identifier for a `user`, beginning with the prefix `USR-`. | |
|
|
1214
|
+
| **managed_transaction_update_request_body** | [**ManagedTransactionUpdateRequestBody**](ManagedTransactionUpdateRequestBody.md) | Managed transaction object to be updated (While no single parameter is required, the request body can't be empty) | |
|
|
1215
|
+
|
|
1216
|
+
### Return type
|
|
1217
|
+
|
|
1218
|
+
[**TransactionResponseBody**](TransactionResponseBody.md)
|
|
1219
|
+
|
|
1220
|
+
### Authorization
|
|
1221
|
+
|
|
1222
|
+
[basicAuth](../README.md#basicAuth)
|
|
1223
|
+
|
|
1224
|
+
### HTTP request headers
|
|
1225
|
+
|
|
1226
|
+
- **Content-Type**: application/json
|
|
1227
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
|
1228
|
+
|