moneykit

MoneyKit - the Ruby gem for the MoneyKit API

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: 0.1.0
  • Package version: 0.0.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build moneykit.gemspec

Then either install the gem locally:

gem install ./moneykit-0.0.0.gem

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

# Setup authorization
MoneyKit.configure do |config|
  # Configure HTTP basic authorization: HTTPBasic
  config.username = 'YOUR_USERNAME'
  config.password = 'YOUR_PASSWORD'
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
end

api_instance = MoneyKit::AccessTokenApi.new
opts = {
  moneykit_version: { ... }, # SupportedVersion | 
  grant_type: 'grant_type_example', # String | Token grant type. Only `client_credentials` supported.
  scope: 'scope_example', # String | Actions to be allowed for this token, given as one or more strings separated by spaces.             If omitted, all actions allowed for your application will be granted to this token.
  client_id: 'client_id_example', # String | Your application's MoneyKit client ID.
  client_secret: 'client_secret_example' # String | Your application's MoneyKit client secret.
}

begin
  #/auth/token
  result = api_instance.generate_access_token(opts)
  p result
rescue MoneyKit::ApiError => e
  puts "Exception when calling AccessTokenApi->generate_access_token: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://production.moneykit.com

Class Method HTTP request Description
MoneyKit::AccessTokenApi generate_access_token POST /auth/token /auth/token
MoneyKit::AccessTokenApi get_well_known_jwks GET /.well-known/jwks.json JSON Web Key Set
MoneyKit::AccessTokenApi instrospect_client GET /auth/introspect /auth/introspect
MoneyKit::AccountNumbersApi get_account_numbers GET /links/id/accounts/numbers /links/id/accounts/numbers
MoneyKit::AccountsApi get_account GET /links/id/accounts/account_id /links/id/accounts/account_id
MoneyKit::AccountsApi get_account_numbers GET /links/id/accounts/numbers /links/id/accounts/numbers
MoneyKit::AccountsApi get_accounts GET /links/id/accounts /links/id/accounts
MoneyKit::AccountsApi get_user_accounts GET /users/id/accounts /users/id/accounts
MoneyKit::IdentityApi get_identities GET /links/id/identity /links/id/identity
MoneyKit::InstitutionsApi get_institution GET /institutions/institution_id /institutions/institution_id
MoneyKit::InstitutionsApi get_institution_styling GET /institutions/institution_id/styling /institutions/institution_id/styling
MoneyKit::InstitutionsApi get_institutions GET /institutions /institutions
MoneyKit::LinkSessionApi create_link_session POST /link-session /link-session
MoneyKit::LinkSessionApi exchange_token POST /link-session/exchange-token /link-session/exchange-token
MoneyKit::LinksApi disconnect DELETE /links/id /links/id
MoneyKit::LinksApi get_link GET /links/id /links/id
MoneyKit::LinksApi get_user_links GET /users/id/links /users/id/links
MoneyKit::LinksApi update_link PATCH /links/id /links/id
MoneyKit::ProductsApi refresh_products POST /links/id/products /links/id/products
MoneyKit::TransactionsApi get_transactions GET /links/id/transactions /links/id/transactions
MoneyKit::TransactionsApi get_transactions_diff GET /links/id/transactions/sync /links/id/transactions/sync
MoneyKit::TransactionsApi get_user_transactions GET /users/id/transactions /users/id/transactions
MoneyKit::UsersApi get_user_accounts GET /users/id/accounts /users/id/accounts
MoneyKit::UsersApi get_user_links GET /users/id/links /users/id/links
MoneyKit::UsersApi get_user_transactions GET /users/id/transactions /users/id/transactions

Documentation for Models

Documentation for Authorization

OAuth2ClientCredentials

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
    • link_session:create: Client can create a Link Session for MoneyLink SDKs
    • link_session:tags:moneykit_reserved: Client can use Link tags that contain reserved MoneyKit prefixes
    • link_session:features:bug_reporter: Client can enable in-sdk bug reporter on a Link Session
    • link_session:features:money_id: Client can enable in-sdk Money ID login/registration on a Link Session
    • link_session:features:provider_sandbox_institutions: Client can select non-MoneyKit institutions in sandbox
    • link:data:read: Client can read all data associated with a Link (accounts, transactions, auth, identity etc)
    • link:data:refresh: Client can trigger a manual refresh of data associated with a Link
    • link:delete: Client can delete a Link
    • institutions:read: Client can fetch institutions
    • institutions:assets:read: Client can include assets when fetching institutions
    • api_compatibility:plaid: Client can access Plaid compatible API layer

clientId

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

clientSecret

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

HTTPBasic

  • Type: HTTP basic authentication