fuse_client

FuseClient - the Ruby gem for the Fuse

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 0.3.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build fuse_client.gemspec

Then either install the gem locally:

gem install ./fuse_client-0.3.0.gem

(for development, run gem install --dev ./fuse_client-0.3.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 'fuse_client', '~> 0.3.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 'fuse_client', :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 'fuse_client'

# Setup authorization
FuseClient.configure do |config|
  # Configure API key authorization: fuseApiKey
  config.api_key['fuseApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['fuseApiKey'] = 'Bearer'

  # Configure API key authorization: fuseClientId
  config.api_key['fuseClientId'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['fuseClientId'] = 'Bearer'
end

api_instance = FuseClient::FuseApi.new
opts = {
  create_asset_report_request: FuseClient::CreateAssetReportRequest.new({access_token: 'access_token_example', days_requested: 3.56}) # CreateAssetReportRequest | 
}

begin
  result = api_instance.create_asset_report(opts)
  p result
rescue FuseClient::ApiError => e
  puts "Exception when calling FuseApi->create_asset_report: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://yz9sph5c42.execute-api.us-east-1.amazonaws.com

Class	Method	HTTP request	Description
FuseClient::FuseApi	create_asset_report	POST /v1/asset_report/create
FuseClient::FuseApi	create_link_token	POST /v1/link/token
FuseClient::FuseApi	create_session	POST /v1/session
FuseClient::FuseApi	exchange_public_token	POST /v1/financial_connections/public_token/exchange
FuseClient::FuseApi	get_asset_report	POST /v1/asset_report
FuseClient::FuseApi	get_financial_connections_account_details	POST /v1/financial_connections/accounts/details	Get account details
FuseClient::FuseApi	get_financial_connections_accounts	POST /v1/financial_connections/accounts	Get accounts
FuseClient::FuseApi	get_financial_connections_balances	POST /v1/financial_connections/balances	Get balances
FuseClient::FuseApi	get_financial_connections_owners	POST /v1/financial_connections/owners	Get account owners
FuseClient::FuseApi	get_financial_connections_transactions	POST /v1/financial_connections/transactions	Get transactions
FuseClient::FuseApi	get_investment_holdings	POST /v1/financial_connections/investments/holdings	Get investment holdings
FuseClient::FuseApi	get_investment_transactions	POST /v1/financial_connections/investments/transactions	Get investment holdings
FuseClient::FuseApi	sync_financial_connections_data	POST /v1/financial_connections/sync	Sync financial connections data
FuseClient::FuseApi	sync_financial_connections_transactions	POST /v1/financial_connections/transactions/sync	Sync transactions
FuseClient::FuseApi	v1_financial_connections_liabilities_post	POST /v1/financial_connections/liabilities	Get liabilities

Documentation for Models

• FuseClient::CreateAssetReportRequest
• FuseClient::CreateAssetReportResponse
• FuseClient::CreateLinkTokenRequest
• FuseClient::CreateLinkTokenRequestMx
• FuseClient::CreateLinkTokenRequestPlaid
• FuseClient::CreateLinkTokenRequestPlaidConfig
• FuseClient::CreateLinkTokenResponse
• FuseClient::CreateSessionRequest
• FuseClient::CreateSessionRequestMx
• FuseClient::CreateSessionRequestPlaid
• FuseClient::CreateSessionResponse
• FuseClient::ExchangeFinancialConnectionsPublicTokenRequest
• FuseClient::ExchangeFinancialConnectionsPublicTokenResponse
• FuseClient::FinancialConnectionsAccount
• FuseClient::FinancialConnectionsAccountBalance
• FuseClient::FinancialConnectionsAccountDetails
• FuseClient::FinancialConnectionsAccountDetailsAch
• FuseClient::FinancialConnectionsAccountInstitution
• FuseClient::FinancialConnectionsAccountLiability
• FuseClient::FinancialConnectionsAccountLiabilityAllOf
• FuseClient::FinancialConnectionsAccountLiabilityAllOfAprs
• FuseClient::FinancialConnectionsHolding
• FuseClient::FinancialConnectionsInvestmentAccount
• FuseClient::FinancialConnectionsInvestmentSecurity
• FuseClient::FinancialConnectionsInvestmentTransaction
• FuseClient::FinancialConnectionsInvestmentTransactionDataInner
• FuseClient::FinancialConnectionsOwner
• FuseClient::FinancialConnectionsOwnerAddressesInner
• FuseClient::FinancialConnectionsOwnerAddressesInnerData
• FuseClient::FinancialConnectionsOwnerEmailsInner
• FuseClient::FinancialConnectionsOwnerNamesInner
• FuseClient::FinancialConnectionsOwnerPhoneNumbersInner
• FuseClient::FuseApiError
• FuseClient::FuseApiErrorData
• FuseClient::FuseApiWarning
• FuseClient::FuseApiWarningData
• FuseClient::GetAssetReportRequest
• FuseClient::GetAssetReportResponse
• FuseClient::GetAssetReportResponseReport
• FuseClient::GetAssetReportResponseReportAccountsInner
• FuseClient::GetAssetReportResponseReportAccountsInnerBalances
• FuseClient::GetAssetReportResponseReportAccountsInnerHistoricalBalancesInner
• FuseClient::GetFinancialConnectionsAccountBalanceResponse
• FuseClient::GetFinancialConnectionsAccountDetailsRequest
• FuseClient::GetFinancialConnectionsAccountDetailsResponse
• FuseClient::GetFinancialConnectionsAccountsRequest
• FuseClient::GetFinancialConnectionsAccountsResponse
• FuseClient::GetFinancialConnectionsBalanceRequest
• FuseClient::GetFinancialConnectionsOwnersRequest
• FuseClient::GetFinancialConnectionsOwnersResponse
• FuseClient::GetFinancialConnectionsOwnersResponseAccountsInner
• FuseClient::GetInvestmentHoldingsRequest
• FuseClient::GetInvestmentHoldingsResponse
• FuseClient::GetInvestmentTransactionsRequest
• FuseClient::GetInvestmentTransactionsResponse
• FuseClient::GetLiabilitiesRequest
• FuseClient::GetLiabilitiesResponse
• FuseClient::GetTransactionsRequest
• FuseClient::GetTransactionsResponse
• FuseClient::GetTransactionsResponseDataInner
• FuseClient::GetTransactionsResponseDataInnerMerchant
• FuseClient::SyncFinancialConnectionsDataResponse
• FuseClient::SyncTransactionsRequest
• FuseClient::SyncTransactionsResponse
• FuseClient::SyncTransactionsResponseRemovedInner
• FuseClient::TransactionCommonModel

Documentation for Authorization

fuseApiKey

• Type: API key
• API key parameter name: Fuse-Api-Key
• Location: HTTP header

fuseClientId

• Type: API key
• API key parameter name: Fuse-Client-Id
• Location: HTTP header

mxApiKey

• Type: API key
• API key parameter name: Mx-Api-Key
• Location: HTTP header

mxClientId

• Type: API key
• API key parameter name: Mx-Client-Id
• Location: HTTP header

plaidClientId

• Type: API key
• API key parameter name: Plaid-Client-Id
• Location: HTTP header

plaidSecret

• Type: API key
• API key parameter name: Plaid-Secret
• Location: HTTP header

tellerApplicationId

• Type: API key
• API key parameter name: Teller-Application-Id
• Location: HTTP header

tellerCertificate

• Type: API key
• API key parameter name: Teller-Certificate
• Location: HTTP header

tellerPrivateKey

• Type: API key
• API key parameter name: Teller-Private-Key
• Location: HTTP header

tellerSigningSecret

• Type: API key
• API key parameter name: Teller-Signing-Secret
• Location: HTTP header

tellerTokenSigningKey

• Type: API key
• API key parameter name: Teller-Token-Signing-Key
• Location: HTTP header