up_banking 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8295d7f7c28d47f98e689d0c7537f46a358f3210da5c250e964d2ae64a72e806
+  data.tar.gz: '0309e653257e0c51d344da2c90ea21d11b03e497928e1a6a0154443491add2d5'
+SHA512:
+  metadata.gz: 6214779804a10699248f2863e08fde683c66b74e139bf46a66a273fbb693b7bdb894bcc7005482c3d6e2e2ee8020831d1d873032d1db0eac37ad0338130a788e
+  data.tar.gz: ea0aa1fe20a4ce27f89d77810c17d3c953dc2382c4659ce4343ddecdf579a3de0f62d137eaeb0425e19e40a044367c7f04965ad4135d74c96d71b134bba40320

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,219 @@
+# 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](https://openapi-generator.tech) 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](https://github.com/up-banking/api)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build up_banking.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+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](https://rubygems.org/).
+
+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:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# 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**](docs/AccountsApi.md#accounts_get) | **GET** /accounts | List accounts
+*UpBankingClient::AccountsApi* | [**accounts_id_get**](docs/AccountsApi.md#accounts_id_get) | **GET** /accounts/{id} | Retrieve account
+*UpBankingClient::CategoriesApi* | [**categories_get**](docs/CategoriesApi.md#categories_get) | **GET** /categories | List categories
+*UpBankingClient::CategoriesApi* | [**categories_id_get**](docs/CategoriesApi.md#categories_id_get) | **GET** /categories/{id} | Retrieve category
+*UpBankingClient::CategoriesApi* | [**transactions_transaction_id_relationships_category_patch**](docs/CategoriesApi.md#transactions_transaction_id_relationships_category_patch) | **PATCH** /transactions/{transactionId}/relationships/category | Categorize transaction
+*UpBankingClient::TagsApi* | [**tags_get**](docs/TagsApi.md#tags_get) | **GET** /tags | List tags
+*UpBankingClient::TagsApi* | [**transactions_transaction_id_relationships_tags_delete**](docs/TagsApi.md#transactions_transaction_id_relationships_tags_delete) | **DELETE** /transactions/{transactionId}/relationships/tags | Remove tags from transaction
+*UpBankingClient::TagsApi* | [**transactions_transaction_id_relationships_tags_post**](docs/TagsApi.md#transactions_transaction_id_relationships_tags_post) | **POST** /transactions/{transactionId}/relationships/tags | Add tags to transaction
+*UpBankingClient::TransactionsApi* | [**accounts_account_id_transactions_get**](docs/TransactionsApi.md#accounts_account_id_transactions_get) | **GET** /accounts/{accountId}/transactions | List transactions by account
+*UpBankingClient::TransactionsApi* | [**transactions_get**](docs/TransactionsApi.md#transactions_get) | **GET** /transactions | List transactions
+*UpBankingClient::TransactionsApi* | [**transactions_id_get**](docs/TransactionsApi.md#transactions_id_get) | **GET** /transactions/{id} | Retrieve transaction
+*UpBankingClient::UtilityEndpointsApi* | [**util_ping_get**](docs/UtilityEndpointsApi.md#util_ping_get) | **GET** /util/ping | Ping
+*UpBankingClient::WebhooksApi* | [**webhooks_get**](docs/WebhooksApi.md#webhooks_get) | **GET** /webhooks | List webhooks
+*UpBankingClient::WebhooksApi* | [**webhooks_id_delete**](docs/WebhooksApi.md#webhooks_id_delete) | **DELETE** /webhooks/{id} | Delete webhook
+*UpBankingClient::WebhooksApi* | [**webhooks_id_get**](docs/WebhooksApi.md#webhooks_id_get) | **GET** /webhooks/{id} | Retrieve webhook
+*UpBankingClient::WebhooksApi* | [**webhooks_post**](docs/WebhooksApi.md#webhooks_post) | **POST** /webhooks | Create webhook
+*UpBankingClient::WebhooksApi* | [**webhooks_webhook_id_logs_get**](docs/WebhooksApi.md#webhooks_webhook_id_logs_get) | **GET** /webhooks/{webhookId}/logs | List webhook logs
+*UpBankingClient::WebhooksApi* | [**webhooks_webhook_id_ping_post**](docs/WebhooksApi.md#webhooks_webhook_id_ping_post) | **POST** /webhooks/{webhookId}/ping | Ping webhook
+
+
+## Documentation for Models
+
+ - [UpBankingClient::AccountResource](docs/AccountResource.md)
+ - [UpBankingClient::AccountResourceAttributes](docs/AccountResourceAttributes.md)
+ - [UpBankingClient::AccountResourceAttributesBalance](docs/AccountResourceAttributesBalance.md)
+ - [UpBankingClient::AccountResourceLinks](docs/AccountResourceLinks.md)
+ - [UpBankingClient::AccountResourceRelationships](docs/AccountResourceRelationships.md)
+ - [UpBankingClient::AccountResourceRelationshipsTransactions](docs/AccountResourceRelationshipsTransactions.md)
+ - [UpBankingClient::AccountResourceRelationshipsTransactionsLinks](docs/AccountResourceRelationshipsTransactionsLinks.md)
+ - [UpBankingClient::AccountTypeEnum](docs/AccountTypeEnum.md)
+ - [UpBankingClient::CashbackObject](docs/CashbackObject.md)
+ - [UpBankingClient::CashbackObjectAmount](docs/CashbackObjectAmount.md)
+ - [UpBankingClient::CategoryInputResourceIdentifier](docs/CategoryInputResourceIdentifier.md)
+ - [UpBankingClient::CategoryResource](docs/CategoryResource.md)
+ - [UpBankingClient::CategoryResourceAttributes](docs/CategoryResourceAttributes.md)
+ - [UpBankingClient::CategoryResourceRelationships](docs/CategoryResourceRelationships.md)
+ - [UpBankingClient::CategoryResourceRelationshipsChildren](docs/CategoryResourceRelationshipsChildren.md)
+ - [UpBankingClient::CategoryResourceRelationshipsChildrenDataInner](docs/CategoryResourceRelationshipsChildrenDataInner.md)
+ - [UpBankingClient::CategoryResourceRelationshipsParent](docs/CategoryResourceRelationshipsParent.md)
+ - [UpBankingClient::CategoryResourceRelationshipsParentData](docs/CategoryResourceRelationshipsParentData.md)
+ - [UpBankingClient::CreateWebhookRequest](docs/CreateWebhookRequest.md)
+ - [UpBankingClient::CreateWebhookRequestData](docs/CreateWebhookRequestData.md)
+ - [UpBankingClient::CreateWebhookResponse](docs/CreateWebhookResponse.md)
+ - [UpBankingClient::CreateWebhookResponseData](docs/CreateWebhookResponseData.md)
+ - [UpBankingClient::ErrorObject](docs/ErrorObject.md)
+ - [UpBankingClient::ErrorObjectSource](docs/ErrorObjectSource.md)
+ - [UpBankingClient::ErrorResponse](docs/ErrorResponse.md)
+ - [UpBankingClient::GetAccountResponse](docs/GetAccountResponse.md)
+ - [UpBankingClient::GetAccountResponseData](docs/GetAccountResponseData.md)
+ - [UpBankingClient::GetCategoryResponse](docs/GetCategoryResponse.md)
+ - [UpBankingClient::GetCategoryResponseData](docs/GetCategoryResponseData.md)
+ - [UpBankingClient::GetTransactionResponse](docs/GetTransactionResponse.md)
+ - [UpBankingClient::GetTransactionResponseData](docs/GetTransactionResponseData.md)
+ - [UpBankingClient::GetWebhookResponse](docs/GetWebhookResponse.md)
+ - [UpBankingClient::GetWebhookResponseData](docs/GetWebhookResponseData.md)
+ - [UpBankingClient::HoldInfoObject](docs/HoldInfoObject.md)
+ - [UpBankingClient::HoldInfoObjectAmount](docs/HoldInfoObjectAmount.md)
+ - [UpBankingClient::HoldInfoObjectForeignAmount](docs/HoldInfoObjectForeignAmount.md)
+ - [UpBankingClient::ListAccountsResponse](docs/ListAccountsResponse.md)
+ - [UpBankingClient::ListAccountsResponseLinks](docs/ListAccountsResponseLinks.md)
+ - [UpBankingClient::ListCategoriesResponse](docs/ListCategoriesResponse.md)
+ - [UpBankingClient::ListTagsResponse](docs/ListTagsResponse.md)
+ - [UpBankingClient::ListTransactionsResponse](docs/ListTransactionsResponse.md)
+ - [UpBankingClient::ListWebhookDeliveryLogsResponse](docs/ListWebhookDeliveryLogsResponse.md)
+ - [UpBankingClient::ListWebhooksResponse](docs/ListWebhooksResponse.md)
+ - [UpBankingClient::MoneyObject](docs/MoneyObject.md)
+ - [UpBankingClient::OwnershipTypeEnum](docs/OwnershipTypeEnum.md)
+ - [UpBankingClient::PingResponse](docs/PingResponse.md)
+ - [UpBankingClient::PingResponseMeta](docs/PingResponseMeta.md)
+ - [UpBankingClient::RoundUpObject](docs/RoundUpObject.md)
+ - [UpBankingClient::RoundUpObjectAmount](docs/RoundUpObjectAmount.md)
+ - [UpBankingClient::RoundUpObjectBoostPortion](docs/RoundUpObjectBoostPortion.md)
+ - [UpBankingClient::TagInputResourceIdentifier](docs/TagInputResourceIdentifier.md)
+ - [UpBankingClient::TagResource](docs/TagResource.md)
+ - [UpBankingClient::TransactionResource](docs/TransactionResource.md)
+ - [UpBankingClient::TransactionResourceAttributes](docs/TransactionResourceAttributes.md)
+ - [UpBankingClient::TransactionResourceAttributesAmount](docs/TransactionResourceAttributesAmount.md)
+ - [UpBankingClient::TransactionResourceAttributesCashback](docs/TransactionResourceAttributesCashback.md)
+ - [UpBankingClient::TransactionResourceAttributesForeignAmount](docs/TransactionResourceAttributesForeignAmount.md)
+ - [UpBankingClient::TransactionResourceAttributesHoldInfo](docs/TransactionResourceAttributesHoldInfo.md)
+ - [UpBankingClient::TransactionResourceAttributesRoundUp](docs/TransactionResourceAttributesRoundUp.md)
+ - [UpBankingClient::TransactionResourceRelationships](docs/TransactionResourceRelationships.md)
+ - [UpBankingClient::TransactionResourceRelationshipsAccount](docs/TransactionResourceRelationshipsAccount.md)
+ - [UpBankingClient::TransactionResourceRelationshipsAccountData](docs/TransactionResourceRelationshipsAccountData.md)
+ - [UpBankingClient::TransactionResourceRelationshipsCategory](docs/TransactionResourceRelationshipsCategory.md)
+ - [UpBankingClient::TransactionResourceRelationshipsCategoryLinks](docs/TransactionResourceRelationshipsCategoryLinks.md)
+ - [UpBankingClient::TransactionResourceRelationshipsTags](docs/TransactionResourceRelationshipsTags.md)
+ - [UpBankingClient::TransactionResourceRelationshipsTagsDataInner](docs/TransactionResourceRelationshipsTagsDataInner.md)
+ - [UpBankingClient::TransactionResourceRelationshipsTagsLinks](docs/TransactionResourceRelationshipsTagsLinks.md)
+ - [UpBankingClient::TransactionResourceRelationshipsTransferAccount](docs/TransactionResourceRelationshipsTransferAccount.md)
+ - [UpBankingClient::TransactionResourceRelationshipsTransferAccountData](docs/TransactionResourceRelationshipsTransferAccountData.md)
+ - [UpBankingClient::TransactionStatusEnum](docs/TransactionStatusEnum.md)
+ - [UpBankingClient::UpdateTransactionCategoryRequest](docs/UpdateTransactionCategoryRequest.md)
+ - [UpBankingClient::UpdateTransactionCategoryRequestData](docs/UpdateTransactionCategoryRequestData.md)
+ - [UpBankingClient::UpdateTransactionTagsRequest](docs/UpdateTransactionTagsRequest.md)
+ - [UpBankingClient::WebhookDeliveryLogResource](docs/WebhookDeliveryLogResource.md)
+ - [UpBankingClient::WebhookDeliveryLogResourceAttributes](docs/WebhookDeliveryLogResourceAttributes.md)
+ - [UpBankingClient::WebhookDeliveryLogResourceAttributesRequest](docs/WebhookDeliveryLogResourceAttributesRequest.md)
+ - [UpBankingClient::WebhookDeliveryLogResourceAttributesResponse](docs/WebhookDeliveryLogResourceAttributesResponse.md)
+ - [UpBankingClient::WebhookDeliveryLogResourceRelationships](docs/WebhookDeliveryLogResourceRelationships.md)
+ - [UpBankingClient::WebhookDeliveryLogResourceRelationshipsWebhookEvent](docs/WebhookDeliveryLogResourceRelationshipsWebhookEvent.md)
+ - [UpBankingClient::WebhookDeliveryLogResourceRelationshipsWebhookEventData](docs/WebhookDeliveryLogResourceRelationshipsWebhookEventData.md)
+ - [UpBankingClient::WebhookDeliveryStatusEnum](docs/WebhookDeliveryStatusEnum.md)
+ - [UpBankingClient::WebhookEventCallback](docs/WebhookEventCallback.md)
+ - [UpBankingClient::WebhookEventCallbackData](docs/WebhookEventCallbackData.md)
+ - [UpBankingClient::WebhookEventResource](docs/WebhookEventResource.md)
+ - [UpBankingClient::WebhookEventResourceAttributes](docs/WebhookEventResourceAttributes.md)
+ - [UpBankingClient::WebhookEventResourceRelationships](docs/WebhookEventResourceRelationships.md)
+ - [UpBankingClient::WebhookEventResourceRelationshipsTransaction](docs/WebhookEventResourceRelationshipsTransaction.md)
+ - [UpBankingClient::WebhookEventResourceRelationshipsTransactionData](docs/WebhookEventResourceRelationshipsTransactionData.md)
+ - [UpBankingClient::WebhookEventResourceRelationshipsWebhook](docs/WebhookEventResourceRelationshipsWebhook.md)
+ - [UpBankingClient::WebhookEventResourceRelationshipsWebhookData](docs/WebhookEventResourceRelationshipsWebhookData.md)
+ - [UpBankingClient::WebhookEventTypeEnum](docs/WebhookEventTypeEnum.md)
+ - [UpBankingClient::WebhookInputResource](docs/WebhookInputResource.md)
+ - [UpBankingClient::WebhookInputResourceAttributes](docs/WebhookInputResourceAttributes.md)
+ - [UpBankingClient::WebhookResource](docs/WebhookResource.md)
+ - [UpBankingClient::WebhookResourceAttributes](docs/WebhookResourceAttributes.md)
+ - [UpBankingClient::WebhookResourceRelationships](docs/WebhookResourceRelationships.md)
+
+
+## Documentation for Authorization
+
+
+### bearer_auth
+
+- **Type**: Bearer authentication
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/config.json

@@ -0,0 +1,11 @@
+{
+  "gemName": "UpBanking",
+  "gemAuthor": "Ben Richardson",
+  "gemDescription": "Unofficial Ruby gem for the Up Banking API",
+  "gemHomepage": "https://github.com/ben-gy/up-banking",
+  "gemName": "up_banking",
+  "gemSummary": "Unofficial Ruby gem for the Up Banking API",
+  "moduleName": "UpBankingClient"
+}
+
+// openapi-generator generate -i https://raw.githubusercontent.com/up-banking/api/master/v1/openapi.json -g ruby -o /Users/benrichardson/Code/up-banking-ruby/ -c /Users/benrichardson/Code/up-banking-ruby/config.json

data/docs/AccountResource.md

@@ -0,0 +1,26 @@
+# UpBankingClient::AccountResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of this resource: `accounts` |  |
+| **id** | **String** | The unique identifier for this account.  |  |
+| **attributes** | [**AccountResourceAttributes**](AccountResourceAttributes.md) |  |  |
+| **relationships** | [**AccountResourceRelationships**](AccountResourceRelationships.md) |  |  |
+| **links** | [**AccountResourceLinks**](AccountResourceLinks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::AccountResource.new(
+  type: null,
+  id: null,
+  attributes: null,
+  relationships: null,
+  links: null
+)
+```
+

data/docs/AccountResourceAttributes.md

@@ -0,0 +1,26 @@
+# UpBankingClient::AccountResourceAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **display_name** | **String** | The name associated with the account in the Up application.  |  |
+| **account_type** | [**AccountTypeEnum**](AccountTypeEnum.md) | The bank account type of this account.  |  |
+| **ownership_type** | [**OwnershipTypeEnum**](OwnershipTypeEnum.md) | The ownership structure for this account.  |  |
+| **balance** | [**AccountResourceAttributesBalance**](AccountResourceAttributesBalance.md) |  |  |
+| **created_at** | **Time** | The date-time at which this account was first opened.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::AccountResourceAttributes.new(
+  display_name: null,
+  account_type: null,
+  ownership_type: null,
+  balance: null,
+  created_at: null
+)
+```
+

data/docs/AccountResourceAttributesBalance.md

@@ -0,0 +1,22 @@
+# UpBankingClient::AccountResourceAttributesBalance
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency_code** | **String** | The ISO 4217 currency code.  |  |
+| **value** | **String** | The amount of money, formatted as a string in the relevant currency. For example, for an Australian dollar value of $10.56, this field will be `\"10.56\"`. The currency symbol is not included in the string.  |  |
+| **value_in_base_units** | **Integer** | The amount of money in the smallest denomination for the currency, as a 64-bit integer.  For example, for an Australian dollar value of $10.56, this field will be `1056`.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::AccountResourceAttributesBalance.new(
+  currency_code: null,
+  value: null,
+  value_in_base_units: null
+)
+```
+

data/docs/AccountResourceLinks.md

@@ -0,0 +1,18 @@
+# UpBankingClient::AccountResourceLinks
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_self** | **String** | The canonical link to this resource within the API.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::AccountResourceLinks.new(
+  _self: null
+)
+```
+

data/docs/AccountResourceRelationships.md

@@ -0,0 +1,18 @@
+# UpBankingClient::AccountResourceRelationships
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transactions** | [**AccountResourceRelationshipsTransactions**](AccountResourceRelationshipsTransactions.md) |  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::AccountResourceRelationships.new(
+  transactions: null
+)
+```
+

data/docs/AccountResourceRelationshipsTransactions.md

@@ -0,0 +1,18 @@
+# UpBankingClient::AccountResourceRelationshipsTransactions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **links** | [**AccountResourceRelationshipsTransactionsLinks**](AccountResourceRelationshipsTransactionsLinks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::AccountResourceRelationshipsTransactions.new(
+  links: null
+)
+```
+

data/docs/AccountResourceRelationshipsTransactionsLinks.md

@@ -0,0 +1,18 @@
+# UpBankingClient::AccountResourceRelationshipsTransactionsLinks
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **related** | **String** | The link to retrieve the related resource(s) in this relationship.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::AccountResourceRelationshipsTransactionsLinks.new(
+  related: null
+)
+```
+

data/docs/AccountTypeEnum.md

@@ -0,0 +1,15 @@
+# UpBankingClient::AccountTypeEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::AccountTypeEnum.new()
+```
+

data/docs/AccountsApi.md

@@ -0,0 +1,153 @@
+# UpBankingClient::AccountsApi
+
+All URIs are relative to *https://api.up.com.au/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**accounts_get**](AccountsApi.md#accounts_get) | **GET** /accounts | List accounts |
+| [**accounts_id_get**](AccountsApi.md#accounts_id_get) | **GET** /accounts/{id} | Retrieve account |
+
+
+## accounts_get
+
+> <ListAccountsResponse> accounts_get(opts)
+
+List accounts
+
+Retrieve a paginated list of all accounts for the currently authenticated user. The returned list is paginated and can be scrolled by following the `prev` and `next` links where present. 
+
+### Examples
+
+```ruby
+require 'time'
+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 "Error when calling AccountsApi->accounts_get: #{e}"
+end
+```
+
+#### Using the accounts_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListAccountsResponse>, Integer, Hash)> accounts_get_with_http_info(opts)
+
+```ruby
+begin
+  # List accounts
+  data, status_code, headers = api_instance.accounts_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListAccountsResponse>
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling AccountsApi->accounts_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page_size** | **Integer** | The number of records to return in each page.  | [optional] |
+| **filter_account_type** | [**AccountTypeEnum**](.md) | The type of account for which to return records. This can be used to filter Savers from spending accounts.  | [optional] |
+| **filter_ownership_type** | [**OwnershipTypeEnum**](.md) | The account ownership structure for which to return records. This can be used to filter 2Up accounts from Up accounts.  | [optional] |
+
+### Return type
+
+[**ListAccountsResponse**](ListAccountsResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## accounts_id_get
+
+> <GetAccountResponse> accounts_id_get(id)
+
+Retrieve account
+
+Retrieve a specific account by providing its unique identifier. 
+
+### Examples
+
+```ruby
+require 'time'
+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
+id = '92b41408-6b7b-4fca-982b-3fb1fdd77220' # String | The unique identifier for the account. 
+
+begin
+  # Retrieve account
+  result = api_instance.accounts_id_get(id)
+  p result
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling AccountsApi->accounts_id_get: #{e}"
+end
+```
+
+#### Using the accounts_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetAccountResponse>, Integer, Hash)> accounts_id_get_with_http_info(id)
+
+```ruby
+begin
+  # Retrieve account
+  data, status_code, headers = api_instance.accounts_id_get_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetAccountResponse>
+rescue UpBankingClient::ApiError => e
+  puts "Error when calling AccountsApi->accounts_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique identifier for the account.  |  |
+
+### Return type
+
+[**GetAccountResponse**](GetAccountResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CashbackObject.md

@@ -0,0 +1,20 @@
+# UpBankingClient::CashbackObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | A brief description of why this cashback was paid.  |  |
+| **amount** | [**CashbackObjectAmount**](CashbackObjectAmount.md) |  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::CashbackObject.new(
+  description: null,
+  amount: null
+)
+```
+

data/docs/CashbackObjectAmount.md

@@ -0,0 +1,22 @@
+# UpBankingClient::CashbackObjectAmount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency_code** | **String** | The ISO 4217 currency code.  |  |
+| **value** | **String** | The amount of money, formatted as a string in the relevant currency. For example, for an Australian dollar value of $10.56, this field will be `\"10.56\"`. The currency symbol is not included in the string.  |  |
+| **value_in_base_units** | **Integer** | The amount of money in the smallest denomination for the currency, as a 64-bit integer.  For example, for an Australian dollar value of $10.56, this field will be `1056`.  |  |
+
+## Example
+
+```ruby
+require 'up_banking'
+
+instance = UpBankingClient::CashbackObjectAmount.new(
+  currency_code: null,
+  value: null,
+  value_in_base_units: null
+)
+```
+