Module: MxPlatformRuby

Defined in:
lib/mx-platform-ruby/version.rb,
lib/mx-platform-ruby.rb,
lib/mx-platform-ruby/api_error.rb,
lib/mx-platform-ruby/api_client.rb,
lib/mx-platform-ruby/api/goals_api.rb,
lib/mx-platform-ruby/configuration.rb,
lib/mx-platform-ruby/api/budgets_api.rb,
lib/mx-platform-ruby/api/insights_api.rb,
lib/mx-platform-ruby/api/mx_platform_api.rb,
lib/mx-platform-ruby/models/goal_request.rb,
lib/mx-platform-ruby/models/tag_response.rb,
lib/mx-platform-ruby/api/transactions_api.rb,
lib/mx-platform-ruby/models/goal_response.rb,
lib/mx-platform-ruby/models/user_response.rb,
lib/mx-platform-ruby/api/microdeposits_api.rb,
lib/mx-platform-ruby/api/spending_plan_api.rb,
lib/mx-platform-ruby/models/goals_response.rb,
lib/mx-platform-ruby/models/widget_request.rb,
lib/mx-platform-ruby/models/budget_response.rb,
lib/mx-platform-ruby/models/member_response.rb,
lib/mx-platform-ruby/models/option_response.rb,
lib/mx-platform-ruby/models/reward_response.rb,
lib/mx-platform-ruby/models/widget_response.rb,
lib/mx-platform-ruby/models/account_response.rb,
lib/mx-platform-ruby/models/holding_response.rb,
lib/mx-platform-ruby/models/insight_response.rb,
lib/mx-platform-ruby/models/rewards_response.rb,
lib/mx-platform-ruby/models/tagging_response.rb,
lib/mx-platform-ruby/models/category_response.rb,
lib/mx-platform-ruby/models/goal_request_body.rb,
lib/mx-platform-ruby/models/merchant_response.rb,
lib/mx-platform-ruby/models/tag_response_body.rb,
lib/mx-platform-ruby/models/challenge_response.rb,
lib/mx-platform-ruby/models/credential_request.rb,
lib/mx-platform-ruby/models/goal_response_body.rb,
lib/mx-platform-ruby/models/reposition_request.rb,
lib/mx-platform-ruby/models/statement_response.rb,
lib/mx-platform-ruby/models/tag_create_request.rb,
lib/mx-platform-ruby/models/tag_update_request.rb,
lib/mx-platform-ruby/models/tags_response_body.rb,
lib/mx-platform-ruby/models/user_response_body.rb,
lib/mx-platform-ruby/models/credential_response.rb,
lib/mx-platform-ruby/models/credit_card_product.rb,
lib/mx-platform-ruby/models/goals_response_body.rb,
lib/mx-platform-ruby/models/pagination_response.rb,
lib/mx-platform-ruby/models/update_goal_request.rb,
lib/mx-platform-ruby/models/user_create_request.rb,
lib/mx-platform-ruby/models/user_update_request.rb,
lib/mx-platform-ruby/models/users_response_body.rb,
lib/mx-platform-ruby/models/widget_request_body.rb,
lib/mx-platform-ruby/models/budget_response_body.rb,
lib/mx-platform-ruby/models/institution_response.rb,
lib/mx-platform-ruby/models/member_response_body.rb,
lib/mx-platform-ruby/models/microdeposit_request.rb,
lib/mx-platform-ruby/models/reward_response_body.rb,
lib/mx-platform-ruby/models/transaction_response.rb,
lib/mx-platform-ruby/models/widget_response_body.rb,
lib/mx-platform-ruby/models/account_response_body.rb,
lib/mx-platform-ruby/models/budget_create_request.rb,
lib/mx-platform-ruby/models/budget_update_request.rb,
lib/mx-platform-ruby/models/holding_response_body.rb,
lib/mx-platform-ruby/models/image_option_response.rb,
lib/mx-platform-ruby/models/insight_response_body.rb,
lib/mx-platform-ruby/models/member_create_request.rb,
lib/mx-platform-ruby/models/member_resume_request.rb,
lib/mx-platform-ruby/models/member_update_request.rb,
lib/mx-platform-ruby/models/members_response_body.rb,
lib/mx-platform-ruby/models/microdeposit_response.rb,
lib/mx-platform-ruby/models/rewards_response_body.rb,
lib/mx-platform-ruby/models/tagging_response_body.rb,
lib/mx-platform-ruby/models/tax_document_response.rb,
lib/mx-platform-ruby/models/account_create_request.rb,
lib/mx-platform-ruby/models/account_owner_response.rb,
lib/mx-platform-ruby/models/account_update_request.rb,
lib/mx-platform-ruby/models/accounts_response_body.rb,
lib/mx-platform-ruby/models/category_response_body.rb,
lib/mx-platform-ruby/models/connect_widget_request.rb,
lib/mx-platform-ruby/models/holdings_response_body.rb,
lib/mx-platform-ruby/models/insight_update_request.rb,
lib/mx-platform-ruby/models/insights_response_body.rb,
lib/mx-platform-ruby/models/member_status_response.rb,
lib/mx-platform-ruby/models/merchant_response_body.rb,
lib/mx-platform-ruby/models/o_auth_window_response.rb,
lib/mx-platform-ruby/models/spending_plan_response.rb,
lib/mx-platform-ruby/models/tagging_create_request.rb,
lib/mx-platform-ruby/models/tagging_update_request.rb,
lib/mx-platform-ruby/models/taggings_response_body.rb,
lib/mx-platform-ruby/models/account_number_response.rb,
lib/mx-platform-ruby/models/category_create_request.rb,
lib/mx-platform-ruby/models/category_update_request.rb,
lib/mx-platform-ruby/models/connect_widget_response.rb,
lib/mx-platform-ruby/models/merchants_response_body.rb,
lib/mx-platform-ruby/models/reposition_request_body.rb,
lib/mx-platform-ruby/models/statement_response_body.rb,
lib/mx-platform-ruby/models/tag_create_request_body.rb,
lib/mx-platform-ruby/models/tag_update_request_body.rb,
lib/mx-platform-ruby/models/categories_response_body.rb,
lib/mx-platform-ruby/models/challenges_response_body.rb,
lib/mx-platform-ruby/models/reposition_response_body.rb,
lib/mx-platform-ruby/models/statements_response_body.rb,
lib/mx-platform-ruby/models/update_goal_request_body.rb,
lib/mx-platform-ruby/models/user_create_request_body.rb,
lib/mx-platform-ruby/models/user_update_request_body.rb,
lib/mx-platform-ruby/models/credentials_response_body.rb,
lib/mx-platform-ruby/models/institution_response_body.rb,
lib/mx-platform-ruby/models/microdeposit_request_body.rb,
lib/mx-platform-ruby/models/split_transaction_request.rb,
lib/mx-platform-ruby/models/transaction_response_body.rb,
lib/mx-platform-ruby/models/transaction_rule_response.rb,
lib/mx-platform-ruby/models/authorization_code_request.rb,
lib/mx-platform-ruby/models/budget_create_request_body.rb,
lib/mx-platform-ruby/models/budget_update_request_body.rb,
lib/mx-platform-ruby/models/institutions_response_body.rb,
lib/mx-platform-ruby/models/member_create_request_body.rb,
lib/mx-platform-ruby/models/member_resume_request_body.rb,
lib/mx-platform-ruby/models/member_update_request_body.rb,
lib/mx-platform-ruby/models/merchant_location_response.rb,
lib/mx-platform-ruby/models/microdeposit_response_body.rb,
lib/mx-platform-ruby/models/monthly_cash_flow_response.rb,
lib/mx-platform-ruby/models/scheduled_payment_response.rb,
lib/mx-platform-ruby/models/tax_document_response_body.rb,
lib/mx-platform-ruby/models/transaction_create_request.rb,
lib/mx-platform-ruby/models/transaction_update_request.rb,
lib/mx-platform-ruby/models/transactions_response_body.rb,
lib/mx-platform-ruby/models/account_create_request_body.rb,
lib/mx-platform-ruby/models/account_update_request_body.rb,
lib/mx-platform-ruby/models/authorization_code_response.rb,
lib/mx-platform-ruby/models/connect_widget_request_body.rb,
lib/mx-platform-ruby/models/member_status_response_body.rb,
lib/mx-platform-ruby/models/microdeposit_verify_request.rb,
lib/mx-platform-ruby/models/microdeposits_response_body.rb,
lib/mx-platform-ruby/models/o_auth_window_response_body.rb,
lib/mx-platform-ruby/models/tagging_create_request_body.rb,
lib/mx-platform-ruby/models/tagging_update_request_body.rb,
lib/mx-platform-ruby/models/tax_documents_response_body.rb,
lib/mx-platform-ruby/models/account_owners_response_body.rb,
lib/mx-platform-ruby/models/category_create_request_body.rb,
lib/mx-platform-ruby/models/category_update_request_body.rb,
lib/mx-platform-ruby/models/connect_widget_response_body.rb,
lib/mx-platform-ruby/models/credit_card_product_response.rb,
lib/mx-platform-ruby/models/enhance_transaction_response.rb,
lib/mx-platform-ruby/models/enhance_transactions_request.rb,
lib/mx-platform-ruby/models/spending_plans_response_body.rb,
lib/mx-platform-ruby/models/account_numbers_response_body.rb,
lib/mx-platform-ruby/models/managed_member_create_request.rb,
lib/mx-platform-ruby/models/managed_member_update_request.rb,
lib/mx-platform-ruby/models/managed_account_create_request.rb,
lib/mx-platform-ruby/models/managed_account_update_request.rb,
lib/mx-platform-ruby/models/spending_plan_account_response.rb,
lib/mx-platform-ruby/models/split_transaction_request_body.rb,
lib/mx-platform-ruby/models/transaction_rule_response_body.rb,
lib/mx-platform-ruby/models/authorization_code_request_body.rb,
lib/mx-platform-ruby/models/merchant_location_response_body.rb,
lib/mx-platform-ruby/models/monthly_cash_flow_response_body.rb,
lib/mx-platform-ruby/models/spending_plan_accounts_response.rb,
lib/mx-platform-ruby/models/transaction_create_request_body.rb,
lib/mx-platform-ruby/models/transaction_rule_create_request.rb,
lib/mx-platform-ruby/models/transaction_rule_update_request.rb,
lib/mx-platform-ruby/models/transaction_rules_response_body.rb,
lib/mx-platform-ruby/models/transaction_update_request_body.rb,
lib/mx-platform-ruby/models/authorization_code_response_body.rb,
lib/mx-platform-ruby/models/microdeposit_verify_request_body.rb,
lib/mx-platform-ruby/models/scheduled_payments_response_body.rb,
lib/mx-platform-ruby/models/spending_plan_iteration_response.rb,
lib/mx-platform-ruby/models/split_transactions_response_body.rb,
lib/mx-platform-ruby/models/transaction_create_response_body.rb,
lib/mx-platform-ruby/models/enhance_transactions_request_body.rb,
lib/mx-platform-ruby/models/monthly_cash_flow_profile_request.rb,
lib/mx-platform-ruby/models/spending_plan_iterations_response.rb,
lib/mx-platform-ruby/models/enhance_transactions_response_body.rb,
lib/mx-platform-ruby/models/managed_member_create_request_body.rb,
lib/mx-platform-ruby/models/managed_member_update_request_body.rb,
lib/mx-platform-ruby/models/managed_transaction_create_request.rb,
lib/mx-platform-ruby/models/managed_transaction_update_request.rb,
lib/mx-platform-ruby/models/managed_account_create_request_body.rb,
lib/mx-platform-ruby/models/managed_account_update_request_body.rb,
lib/mx-platform-ruby/models/transaction_rule_create_request_body.rb,
lib/mx-platform-ruby/models/transaction_rule_update_request_body.rb,
lib/mx-platform-ruby/models/spending_plan_iteration_item_response.rb,
lib/mx-platform-ruby/models/monthly_cash_flow_profile_request_body.rb,
lib/mx-platform-ruby/models/managed_transaction_create_request_body.rb,
lib/mx-platform-ruby/models/managed_transaction_update_request_body.rb,
lib/mx-platform-ruby/models/spending_plan_iteration_items_response_body.rb,
lib/mx-platform-ruby/models/payment_processor_authorization_code_request.rb,
lib/mx-platform-ruby/models/payment_processor_authorization_code_response.rb,
lib/mx-platform-ruby/models/spending_plan_iteration_item_create_request_body.rb,
lib/mx-platform-ruby/models/payment_processor_authorization_code_request_body.rb,
lib/mx-platform-ruby/models/payment_processor_authorization_code_response_body.rb

Overview

#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.

The version of the OpenAPI document: 0.1.0

Generated by: openapi-generator.tech Generator version: 7.8.0

Defined Under Namespace

Classes: AccountCreateRequest, AccountCreateRequestBody, AccountNumberResponse, AccountNumbersResponseBody, AccountOwnerResponse, AccountOwnersResponseBody, AccountResponse, AccountResponseBody, AccountUpdateRequest, AccountUpdateRequestBody, AccountsResponseBody, ApiClient, ApiError, AuthorizationCodeRequest, AuthorizationCodeRequestBody, AuthorizationCodeResponse, AuthorizationCodeResponseBody, BudgetCreateRequest, BudgetCreateRequestBody, BudgetResponse, BudgetResponseBody, BudgetUpdateRequest, BudgetUpdateRequestBody, BudgetsApi, CategoriesResponseBody, CategoryCreateRequest, CategoryCreateRequestBody, CategoryResponse, CategoryResponseBody, CategoryUpdateRequest, CategoryUpdateRequestBody, ChallengeResponse, ChallengesResponseBody, Configuration, ConnectWidgetRequest, ConnectWidgetRequestBody, ConnectWidgetResponse, ConnectWidgetResponseBody, CredentialRequest, CredentialResponse, CredentialsResponseBody, CreditCardProduct, CreditCardProductResponse, EnhanceTransactionResponse, EnhanceTransactionsRequest, EnhanceTransactionsRequestBody, EnhanceTransactionsResponseBody, GoalRequest, GoalRequestBody, GoalResponse, GoalResponseBody, GoalsApi, GoalsResponse, GoalsResponseBody, HoldingResponse, HoldingResponseBody, HoldingsResponseBody, ImageOptionResponse, InsightResponse, InsightResponseBody, InsightUpdateRequest, InsightsApi, InsightsResponseBody, InstitutionResponse, InstitutionResponseBody, InstitutionsResponseBody, ManagedAccountCreateRequest, ManagedAccountCreateRequestBody, ManagedAccountUpdateRequest, ManagedAccountUpdateRequestBody, ManagedMemberCreateRequest, ManagedMemberCreateRequestBody, ManagedMemberUpdateRequest, ManagedMemberUpdateRequestBody, ManagedTransactionCreateRequest, ManagedTransactionCreateRequestBody, ManagedTransactionUpdateRequest, ManagedTransactionUpdateRequestBody, MemberCreateRequest, MemberCreateRequestBody, MemberResponse, MemberResponseBody, MemberResumeRequest, MemberResumeRequestBody, MemberStatusResponse, MemberStatusResponseBody, MemberUpdateRequest, MemberUpdateRequestBody, MembersResponseBody, MerchantLocationResponse, MerchantLocationResponseBody, MerchantResponse, MerchantResponseBody, MerchantsResponseBody, MicrodepositRequest, MicrodepositRequestBody, MicrodepositResponse, MicrodepositResponseBody, MicrodepositVerifyRequest, MicrodepositVerifyRequestBody, MicrodepositsApi, MicrodepositsResponseBody, MonthlyCashFlowProfileRequest, MonthlyCashFlowProfileRequestBody, MonthlyCashFlowResponse, MonthlyCashFlowResponseBody, MxPlatformApi, OAuthWindowResponse, OAuthWindowResponseBody, OptionResponse, PaginationResponse, PaymentProcessorAuthorizationCodeRequest, PaymentProcessorAuthorizationCodeRequestBody, PaymentProcessorAuthorizationCodeResponse, PaymentProcessorAuthorizationCodeResponseBody, RepositionRequest, RepositionRequestBody, RepositionResponseBody, RewardResponse, RewardResponseBody, RewardsResponse, RewardsResponseBody, ScheduledPaymentResponse, ScheduledPaymentsResponseBody, SpendingPlanAccountResponse, SpendingPlanAccountsResponse, SpendingPlanApi, SpendingPlanIterationItemCreateRequestBody, SpendingPlanIterationItemResponse, SpendingPlanIterationItemsResponseBody, SpendingPlanIterationResponse, SpendingPlanIterationsResponse, SpendingPlanResponse, SpendingPlansResponseBody, SplitTransactionRequest, SplitTransactionRequestBody, SplitTransactionsResponseBody, StatementResponse, StatementResponseBody, StatementsResponseBody, TagCreateRequest, TagCreateRequestBody, TagResponse, TagResponseBody, TagUpdateRequest, TagUpdateRequestBody, TaggingCreateRequest, TaggingCreateRequestBody, TaggingResponse, TaggingResponseBody, TaggingUpdateRequest, TaggingUpdateRequestBody, TaggingsResponseBody, TagsResponseBody, TaxDocumentResponse, TaxDocumentResponseBody, TaxDocumentsResponseBody, TransactionCreateRequest, TransactionCreateRequestBody, TransactionCreateResponseBody, TransactionResponse, TransactionResponseBody, TransactionRuleCreateRequest, TransactionRuleCreateRequestBody, TransactionRuleResponse, TransactionRuleResponseBody, TransactionRuleUpdateRequest, TransactionRuleUpdateRequestBody, TransactionRulesResponseBody, TransactionUpdateRequest, TransactionUpdateRequestBody, TransactionsApi, TransactionsResponseBody, UpdateGoalRequest, UpdateGoalRequestBody, UserCreateRequest, UserCreateRequestBody, UserResponse, UserResponseBody, UserUpdateRequest, UserUpdateRequestBody, UsersResponseBody, WidgetRequest, WidgetRequestBody, WidgetResponse, WidgetResponseBody

Constant Summary collapse

VERSION = 
'1.1.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

MxPlatformRuby.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



214
215
216
217
218
219
220
 
# File 'lib/mx-platform-ruby.rb', line 214

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end