mx-platform-ruby
MxPlatformRuby - the Ruby gem for the MX Platform API
The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 0.1.0
- Package version: 0.2.0
- Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://www.mx.com/products/platform-api
Installation
Build a gem
To build the Ruby code into a gem:
gem build mx-platform-ruby.gemspec
Then either install the gem locally:
gem install ./mx-platform-ruby-0.2.0.gem
(for development, run gem install --dev ./mx-platform-ruby-0.2.0.gem
to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'mx-platform-ruby', '~> 0.2.0'
Install from Git
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
gem 'mx-platform-ruby', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
Include the Ruby code directly
Include the Ruby code directly using -I
as follows:
ruby -Ilib script.rb
Getting Started
Please follow the installation procedure and then run the following code:
# Load the gem
require 'mx-platform-ruby'
# Setup authorization
MxPlatformRuby.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = 'YOUR_USERNAME'
config.password = 'YOUR_PASSWORD'
end
api_instance = MxPlatformRuby::MxPlatformApi.new
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
begin
#Aggregate member
result = api_instance.aggregate_member(member_guid, user_guid)
p result
rescue MxPlatformRuby::ApiError => e
puts "Exception when calling MxPlatformApi->aggregate_member: #{e}"
end
Documentation for API Endpoints
All URIs are relative to https://api.mx.com
Class | Method | HTTP request | Description |
---|---|---|---|
MxPlatformRuby::MxPlatformApi | aggregate_member | POST /users/user_guid/members/member_guid/aggregate | Aggregate member |
MxPlatformRuby::MxPlatformApi | check_balances | POST /users/user_guid/members/member_guid/check_balance | Check balances |
MxPlatformRuby::MxPlatformApi | create_category | POST /users/user_guid/categories | Create category |
MxPlatformRuby::MxPlatformApi | create_member | POST /users/user_guid/members | Create member |
MxPlatformRuby::MxPlatformApi | create_tag | POST /users/user_guid/tags | Create tag |
MxPlatformRuby::MxPlatformApi | create_tagging | POST /users/user_guid/taggings | Create tagging |
MxPlatformRuby::MxPlatformApi | create_transaction_rule | POST /users/user_guid/transaction_rules | Create transaction rule |
MxPlatformRuby::MxPlatformApi | create_user | POST /users | Create user |
MxPlatformRuby::MxPlatformApi | delete_category | DELETE /users/user_guid/categories/category_guid | Delete category |
MxPlatformRuby::MxPlatformApi | delete_member | DELETE /users/user_guid/members/member_guid | Delete member |
MxPlatformRuby::MxPlatformApi | delete_tag | DELETE /users/user_guid/tags/tag_guid | Delete tag |
MxPlatformRuby::MxPlatformApi | delete_tagging | DELETE /users/user_guid/taggings/tagging_guid | Delete tagging |
MxPlatformRuby::MxPlatformApi | delete_transaction_rule | DELETE /users/user_guid/transaction_rules/transaction_rule_guid | Delete transaction rule |
MxPlatformRuby::MxPlatformApi | delete_user | DELETE /users/user_guid | Delete user |
MxPlatformRuby::MxPlatformApi | download_statement_pdf | GET /users/user_guid/members/member_guid/statements/statement_guid.pdf | Download statement PDF |
MxPlatformRuby::MxPlatformApi | enhance_transactions | POST /transactions/enhance | Enhance transactions |
MxPlatformRuby::MxPlatformApi | extend_history | POST /users/user_guid/members/member_guid/extend_history | Extend history |
MxPlatformRuby::MxPlatformApi | fetch_statements_by_member | POST /users/user_guid/members/member_guid/fetch_statements | Fetch statements by member |
MxPlatformRuby::MxPlatformApi | identify_member | POST /users/user_guid/members/member_guid/identify | Identify member |
MxPlatformRuby::MxPlatformApi | list_account_numbers_by_account | GET /users/user_guid/accounts/account_guid/account_numbers | List account numbers by account |
MxPlatformRuby::MxPlatformApi | list_account_numbers_by_member | GET /users/user_guid/members/member_guid/account_numbers | List account numbers by member |
MxPlatformRuby::MxPlatformApi | list_account_owners | GET /users/user_guid/members/member_guid/account_owners | List account owners |
MxPlatformRuby::MxPlatformApi | list_categories | GET /users/user_guid/categories | List categories |
MxPlatformRuby::MxPlatformApi | list_default_categories | GET /users/user_guid/categories/default | List default categories |
MxPlatformRuby::MxPlatformApi | list_favorites | GET /institutions/favorites | List favorites |
MxPlatformRuby::MxPlatformApi | list_holdings_by_member | GET /users/user_guid/members/member_guid/holdings | List holdings by member |
MxPlatformRuby::MxPlatformApi | list_holdings_by_user | GET /users/user_guid/holdings | List holdings by user |
MxPlatformRuby::MxPlatformApi | list_institution_required_credentials | GET /institutions/institution_code/credentials | List institution-required credentials |
MxPlatformRuby::MxPlatformApi | list_institutions | GET /institutions | List institutions |
MxPlatformRuby::MxPlatformApi | list_member_challenges | GET /users/user_guid/members/member_guid/challenges | List member challenges |
MxPlatformRuby::MxPlatformApi | list_member_credentials | GET /users/user_guid/members/member_guid/credentials | List member credentials |
MxPlatformRuby::MxPlatformApi | list_members | GET /users/user_guid/members | List members |
MxPlatformRuby::MxPlatformApi | list_merchants | GET /merchants | List merchants |
MxPlatformRuby::MxPlatformApi | list_statements_by_member | GET /users/user_guid/members/member_guid/statements | List statements by member |
MxPlatformRuby::MxPlatformApi | list_taggings | GET /users/user_guid/taggings | List taggings |
MxPlatformRuby::MxPlatformApi | list_tags | GET /users/user_guid/tags | List tags |
MxPlatformRuby::MxPlatformApi | list_transaction_rules_by_user | GET /users/user_guid/transaction_rules | List transaction rules by user |
MxPlatformRuby::MxPlatformApi | list_transactions_by_account | GET /users/user_guid/accounts/account_guid/transactions | List transactions by account |
MxPlatformRuby::MxPlatformApi | list_transactions_by_member | GET /users/user_guid/members/member_guid/transactions | List transactions by member |
MxPlatformRuby::MxPlatformApi | list_transactions_by_tag | GET /users/user_guid/tags/tag_guid/transactions | List transactions by tag |
MxPlatformRuby::MxPlatformApi | list_transactions_by_user | GET /users/user_guid/transactions | List transactions by user |
MxPlatformRuby::MxPlatformApi | list_user_accounts | GET /users/user_guid/accounts | List accounts |
MxPlatformRuby::MxPlatformApi | list_users | GET /users | List users |
MxPlatformRuby::MxPlatformApi | read_account | GET /users/user_guid/accounts/account_guid | Read account |
MxPlatformRuby::MxPlatformApi | read_category | GET /users/user_guid/categories/category_guid | Read category |
MxPlatformRuby::MxPlatformApi | read_holding | GET /users/user_guid/holdings/holding_guid | Read holding |
MxPlatformRuby::MxPlatformApi | read_institution | GET /institutions/institution_code | Read institution |
MxPlatformRuby::MxPlatformApi | read_member | GET /users/user_guid/members/member_guid | Read member |
MxPlatformRuby::MxPlatformApi | read_member_status | GET /users/user_guid/members/member_guid/status | Read member status |
MxPlatformRuby::MxPlatformApi | read_merchant | GET /merchants/merchant_guid | Read merchant |
MxPlatformRuby::MxPlatformApi | read_statement_by_member | GET /users/user_guid/members/member_guid/statements/statement_guid | Read statement by member |
MxPlatformRuby::MxPlatformApi | read_tag | GET /users/user_guid/tags/tag_guid | Read tag |
MxPlatformRuby::MxPlatformApi | read_tagging | GET /users/user_guid/taggings/tagging_guid | Read tagging |
MxPlatformRuby::MxPlatformApi | read_transaction | GET /users/user_guid/transactions/transaction_guid | Read transaction |
MxPlatformRuby::MxPlatformApi | read_transaction_rule | GET /users/user_guid/transaction_rules/transaction_rule_guid | Read transaction rule |
MxPlatformRuby::MxPlatformApi | read_user | GET /users/user_guid | Read user |
MxPlatformRuby::MxPlatformApi | request_connect_widget_url | POST /users/user_guid/connect_widget_url | Request connect widget URL |
MxPlatformRuby::MxPlatformApi | request_o_auth_window | GET /users/user_guid/members/member_guid/oauth_window_uri | Read member |
MxPlatformRuby::MxPlatformApi | request_widget_url | POST /users/user_guid/widget_urls | Request a widget URL |
MxPlatformRuby::MxPlatformApi | resume_aggregation | PUT /users/user_guid/members/member_guid/resume | Resume aggregation |
MxPlatformRuby::MxPlatformApi | update_account | PUT /users/user_guid/members/member_guid/accounts/account_guid | Update account |
MxPlatformRuby::MxPlatformApi | update_category | PUT /users/user_guid/categories/category_guid | Update category |
MxPlatformRuby::MxPlatformApi | update_member | PUT /users/user_guid/members/member_guid | Update member |
MxPlatformRuby::MxPlatformApi | update_tag | PUT /users/user_guid/tags/tag_guid | Update tag |
MxPlatformRuby::MxPlatformApi | update_tagging | PUT /users/user_guid/taggings/tagging_guid | Update tagging |
MxPlatformRuby::MxPlatformApi | update_transaction | PUT /users/user_guid/transactions/transaction_guid | Update transaction |
MxPlatformRuby::MxPlatformApi | update_transaction_rule | PUT /users/user_guid/transaction_rules/transaction_rule_guid | Update transaction_rule |
MxPlatformRuby::MxPlatformApi | update_user | PUT /users/user_guid | Update user |
MxPlatformRuby::MxPlatformApi | verify_member | POST /users/user_guid/members/member_guid/verify | Verify member |
Documentation for Models
- MxPlatformRuby::Account
- MxPlatformRuby::AccountNumber
- MxPlatformRuby::AccountNumbersResponseBody
- MxPlatformRuby::AccountOwner
- MxPlatformRuby::AccountOwnersResponseBody
- MxPlatformRuby::AccountResponseBody
- MxPlatformRuby::AccountUpdateRequest
- MxPlatformRuby::AccountUpdateRequestBody
- MxPlatformRuby::AccountsResponseBody
- MxPlatformRuby::CategoriesResponseBody
- MxPlatformRuby::Category
- MxPlatformRuby::CategoryCreateRequest
- MxPlatformRuby::CategoryCreateRequestBody
- MxPlatformRuby::CategoryResponseBody
- MxPlatformRuby::CategoryUpdateRequest
- MxPlatformRuby::CategoryUpdateRequestBody
- MxPlatformRuby::Challenge
- MxPlatformRuby::ChallengeImageOptions
- MxPlatformRuby::ChallengeOptions
- MxPlatformRuby::ChallengesResponseBody
- MxPlatformRuby::ConnectWidget
- MxPlatformRuby::ConnectWidgetRequest
- MxPlatformRuby::ConnectWidgetRequestBody
- MxPlatformRuby::ConnectWidgetResponseBody
- MxPlatformRuby::Credential
- MxPlatformRuby::CredentialRequest
- MxPlatformRuby::CredentialsResponseBody
- MxPlatformRuby::EnhanceTransaction
- MxPlatformRuby::EnhanceTransactionsRequest
- MxPlatformRuby::EnhanceTransactionsRequestBody
- MxPlatformRuby::EnhanceTransactionsResponseBody
- MxPlatformRuby::Holding
- MxPlatformRuby::HoldingResponseBody
- MxPlatformRuby::HoldingsResponseBody
- MxPlatformRuby::InlineResponse200
- MxPlatformRuby::Institution
- MxPlatformRuby::InstitutionResponseBody
- MxPlatformRuby::InstitutionsResponseBody
- MxPlatformRuby::Member
- MxPlatformRuby::MemberCreateRequest
- MxPlatformRuby::MemberCreateRequestBody
- MxPlatformRuby::MemberResponseBody
- MxPlatformRuby::MemberResumeRequest
- MxPlatformRuby::MemberResumeRequestBody
- MxPlatformRuby::MemberStatus
- MxPlatformRuby::MemberStatusResponseBody
- MxPlatformRuby::MemberUpdateRequest
- MxPlatformRuby::MemberUpdateRequestBody
- MxPlatformRuby::MembersResponseBody
- MxPlatformRuby::Merchant
- MxPlatformRuby::MerchantResponseBody
- MxPlatformRuby::MerchantsResponseBody
- MxPlatformRuby::OAuthWindow
- MxPlatformRuby::OAuthWindowResponseBody
- MxPlatformRuby::Pagination
- MxPlatformRuby::Statement
- MxPlatformRuby::StatementResponseBody
- MxPlatformRuby::StatementsResponseBody
- MxPlatformRuby::Tag
- MxPlatformRuby::TagCreateRequest
- MxPlatformRuby::TagCreateRequestBody
- MxPlatformRuby::TagResponseBody
- MxPlatformRuby::TagUpdateRequest
- MxPlatformRuby::TagUpdateRequestBody
- MxPlatformRuby::Tagging
- MxPlatformRuby::TaggingCreateRequest
- MxPlatformRuby::TaggingCreateRequestBody
- MxPlatformRuby::TaggingResponseBody
- MxPlatformRuby::TaggingUpdateRequest
- MxPlatformRuby::TaggingUpdateRequestBody
- MxPlatformRuby::TaggingsResponseBody
- MxPlatformRuby::TagsResponseBody
- MxPlatformRuby::Transaction
- MxPlatformRuby::TransactionResponseBody
- MxPlatformRuby::TransactionRule
- MxPlatformRuby::TransactionRuleCreateRequest
- MxPlatformRuby::TransactionRuleCreateRequestBody
- MxPlatformRuby::TransactionRuleResponseBody
- MxPlatformRuby::TransactionRuleUpdateRequest
- MxPlatformRuby::TransactionRuleUpdateRequestBody
- MxPlatformRuby::TransactionRulesResponseBody
- MxPlatformRuby::TransactionUpdateRequest
- MxPlatformRuby::TransactionUpdateRequestBody
- MxPlatformRuby::TransactionsResponseBody
- MxPlatformRuby::User
- MxPlatformRuby::UserCreateRequest
- MxPlatformRuby::UserCreateRequestBody
- MxPlatformRuby::UserResponseBody
- MxPlatformRuby::UserUpdateRequest
- MxPlatformRuby::UserUpdateRequestBody
- MxPlatformRuby::UsersResponseBody
- MxPlatformRuby::Widget
- MxPlatformRuby::WidgetRequest
- MxPlatformRuby::WidgetRequestBody
- MxPlatformRuby::WidgetResponseBody
Documentation for Authorization
basicAuth
- Type: HTTP basic authentication