Project

up_banking

0.0
Low commit activity in last 3 years
No release in over a year
up_bankingben-gy/up_bankingHomepageDocumentationSource CodeBug Tracker
Unofficial Ruby gem for the Up Banking API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
736
Stars
0
Forks
0
Watchers
0
 Releases
Current version
1.0.0
Total releases
1
First release
2022-10-05
Latest release
2022-10-05
 Development
Primary Language
Ruby
Licenses
Unlicense
Average date of last 50 commits
2021-08-05
Reverse Dependencies
0

 Dependencies

Development

rspec
~> 3.6, >= 3.6.0

Runtime

typhoeus
~> 1.0, >= 1.0.1
 Project Readme

up_banking

UpBankingClient - the Ruby gem for the Up API

The Up API gives you programmatic access to your balances and transaction data. You can request past transactions or set up webhooks to receive real-time events when new transactions hit your account. It’s new, it’s exciting and it’s just the beginning.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://github.com/up-banking/api

Installation

Build a gem

To build the Ruby code into a gem:

gem build up_banking.gemspec

Then either install the gem locally:

gem install ./up_banking-1.0.0.gem

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

# Setup authorization
UpBankingClient.configure do |config|
  # Configure Bearer authorization: bearer_auth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = UpBankingClient::AccountsApi.new
opts = {
  page_size: 30, # Integer | The number of records to return in each page. 
  filter_account_type: UpBankingClient::AccountTypeEnum::SAVER, # AccountTypeEnum | The type of account for which to return records. This can be used to filter Savers from spending accounts. 
  filter_ownership_type: UpBankingClient::OwnershipTypeEnum::INDIVIDUAL # OwnershipTypeEnum | The account ownership structure for which to return records. This can be used to filter 2Up accounts from Up accounts. 
}

begin
  #List accounts
  result = api_instance.accounts_get(opts)
  p result
rescue UpBankingClient::ApiError => e
  puts "Exception when calling AccountsApi->accounts_get: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.up.com.au/api/v1

Class Method HTTP request Description
UpBankingClient::AccountsApi accounts_get GET /accounts List accounts
UpBankingClient::AccountsApi accounts_id_get GET /accounts/{id} Retrieve account
UpBankingClient::CategoriesApi categories_get GET /categories List categories
UpBankingClient::CategoriesApi categories_id_get GET /categories/{id} Retrieve category
UpBankingClient::CategoriesApi transactions_transaction_id_relationships_category_patch PATCH /transactions/{transactionId}/relationships/category Categorize transaction
UpBankingClient::TagsApi tags_get GET /tags List tags
UpBankingClient::TagsApi transactions_transaction_id_relationships_tags_delete DELETE /transactions/{transactionId}/relationships/tags Remove tags from transaction
UpBankingClient::TagsApi transactions_transaction_id_relationships_tags_post POST /transactions/{transactionId}/relationships/tags Add tags to transaction
UpBankingClient::TransactionsApi accounts_account_id_transactions_get GET /accounts/{accountId}/transactions List transactions by account
UpBankingClient::TransactionsApi transactions_get GET /transactions List transactions
UpBankingClient::TransactionsApi transactions_id_get GET /transactions/{id} Retrieve transaction
UpBankingClient::UtilityEndpointsApi util_ping_get GET /util/ping Ping
UpBankingClient::WebhooksApi webhooks_get GET /webhooks List webhooks
UpBankingClient::WebhooksApi webhooks_id_delete DELETE /webhooks/{id} Delete webhook
UpBankingClient::WebhooksApi webhooks_id_get GET /webhooks/{id} Retrieve webhook
UpBankingClient::WebhooksApi webhooks_post POST /webhooks Create webhook
UpBankingClient::WebhooksApi webhooks_webhook_id_logs_get GET /webhooks/{webhookId}/logs List webhook logs
UpBankingClient::WebhooksApi webhooks_webhook_id_ping_post POST /webhooks/{webhookId}/ping Ping webhook

Documentation for Models

Documentation for Authorization

bearer_auth

  • Type: Bearer authentication