/friendlyscore-ruby

Primary LanguageRuby

friendlyscore_ruby

FriendlyscoreClient - the Ruby gem for the FriendlyScore Public API

Public API for communication with FriendlyScore

This SDK is automatically generated by the Swagger Codegen project:

  • API version: v1
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build friendlyscore_ruby.gemspec

Then either install the gem locally:

gem install ./friendlyscore_ruby-1.0.0.gem

(for development, run gem install --dev ./friendlyscore_ruby-1.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 'friendlyscore_ruby', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:

gem 'friendlyscore_ruby', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.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 'friendlyscore_ruby'

api_instance = FriendlyscoreClient::AuthAndRegistrationApi.new

opts = { 
  oauth_token_request: FriendlyscoreClient::OAuthTokenRequestType.new # OAuthTokenRequestType | OAuth token request data
}

begin
  #Returns OAuth 2.0 token
  result = api_instance.oauth_v2_token_post(opts)
  p result
rescue FriendlyscoreClient::ApiError => e
  puts "Exception when calling AuthAndRegistrationApi->oauth_v2_token_post: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://localhost

Class Method HTTP request Description
FriendlyscoreClient::AuthAndRegistrationApi oauth_v2_token_post POST /oauth/v2/token Returns OAuth 2.0 token
FriendlyscoreClient::BankingDataApi public_version_account_types_account_type_transaction_categories_get GET /public/{version}/account_types/{account_type}/transaction_categories Get the available transaction categories
FriendlyscoreClient::BankingDataApi public_version_banks_get GET /public/{version}/banks Get available banks.
FriendlyscoreClient::BankingDataApi public_version_customers_customer_id_accounts_get GET /public/{version}/customers/{customer_id}/accounts Get bank account list for a given customer.
FriendlyscoreClient::BankingDataApi public_version_customers_customer_id_balances_get GET /public/{version}/customers/{customer_id}/balances Get bank balance list for a given customer.
FriendlyscoreClient::BankingDataApi public_version_customers_customer_id_bank_bank_slug_consent_consent_type_get GET /public/{version}/customers/{customer_id}/bank/{bank_slug}/consent/{consent_type} Get the current user consent for given bank
FriendlyscoreClient::BankingDataApi public_version_customers_customer_id_banks_get GET /public/{version}/customers/{customer_id}/banks Get customer's connected banks with embedded consent objects.
FriendlyscoreClient::BankingDataApi public_version_customers_customer_id_transaction_categorisation_account_type_patch PATCH /public/{version}/customers/{customer_id}/transaction_categorisation/{account_type} Update given set of transactions with a new category.
FriendlyscoreClient::BankingDataApi public_version_customers_customer_id_transactions_get GET /public/{version}/customers/{customer_id}/transactions Get bank transaction list for a given customer.
FriendlyscoreClient::DataInputApi public_version_customers_customer_id_account_collections_post POST /public/{version}/customers/{customer_id}/account_collections Post bank account collection for given customer.
FriendlyscoreClient::DataInputApi public_version_customers_customer_id_balance_collections_post POST /public/{version}/customers/{customer_id}/balance_collections Post bank balance collection for given customer and bank. This is an asynchronous endpoint.
FriendlyscoreClient::DataInputApi public_version_customers_customer_id_transaction_collections_post POST /public/{version}/customers/{customer_id}/transaction_collections Post bank transaction collection for given customer and bank. This is an asynchronous endpoint.
FriendlyscoreClient::InvitationApi public_version_invitations_get GET /public/{version}/invitations Get invitations
FriendlyscoreClient::InvitationApi public_version_invitations_id_revoke_patch PATCH /public/{version}/invitations/{id}/revoke Revoke an invitation
FriendlyscoreClient::InvitationApi public_version_invitations_post POST /public/{version}/invitations Post new invitation
FriendlyscoreClient::ReportsApi public_version_customers_customer_id_forecasts_forecast_id_get GET /public/{version}/customers/{customer_id}/forecasts/{forecast_id} Get the the forecasts for customer
FriendlyscoreClient::ReportsApi public_version_customers_customer_id_insights_current_business_get GET /public/{version}/customers/{customer_id}/insights/current_business Get the insights for customer's business accounts
FriendlyscoreClient::ReportsApi public_version_customers_customer_id_insights_current_personal_get GET /public/{version}/customers/{customer_id}/insights/current_personal Get the insights for customer's personal accounts
FriendlyscoreClient::UsersApi public_version_customers_get GET /public/{version}/customers Returns the list of users. Can be used for seeking users.
FriendlyscoreClient::UsersApi public_version_customers_post POST /public/{version}/customers Creates a new "empty" user.
FriendlyscoreClient::UtilApi public_version_customers_customer_id_data_processing_statuses_dtn_slug_get GET /public/{version}/customers/{customer_id}/data_processing_statuses/{dtn_slug} Get the current status of a certain data processing request.
FriendlyscoreClient::UtilApi public_version_customers_customer_id_data_processing_statuses_get GET /public/{version}/customers/{customer_id}/data_processing_statuses Get the current status of a all data processing requests for current user.
FriendlyscoreClient::UtilApi public_version_customers_customer_id_report_readiness_statuses_get GET /public/{version}/customers/{customer_id}/report_readiness_statuses Get the current readiness status for all reports for current user.
FriendlyscoreClient::UtilApi public_version_customers_customer_id_report_readiness_statuses_report_name_get GET /public/{version}/customers/{customer_id}/report_readiness_statuses/{report_name} Get the current readiness status for a certain report.

Documentation for Models

Documentation for Authorization

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header