firefly-iii-client 1.0.0

data/docs/Transaction.md

@@ -0,0 +1,26 @@
+# OpenapiClient::Transaction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  | [optional][readonly] |
+| **updated_at** | **Time** |  | [optional][readonly] |
+| **user** | **Integer** | User ID | [optional][readonly] |
+| **group_title** | **String** | Title of the transaction if it has been split in more than one piece. Empty otherwise. | [optional][readonly] |
+| **transactions** | [**Array<TransactionSplit>**](TransactionSplit.md) |  |  |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::Transaction.new(
+  created_at: 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  updated_at : 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  user : 3,
+  group_title : Split transaction title.,
+                                  transactions: null
+)
+```
+

data/docs/TransactionArray.md

@@ -0,0 +1,22 @@
+# OpenapiClient::TransactionArray
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<TransactionRead>**](TransactionRead.md) |  | [optional] |
+| **meta** | [**Meta**](Meta.md) |  | [optional] |
+| **links** | [**PageLink**](PageLink.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::TransactionArray.new(
+  data: null,
+  meta: null,
+  links: null
+)
+```
+

data/docs/TransactionLink.md

@@ -0,0 +1,30 @@
+# OpenapiClient::TransactionLink
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  | [optional][readonly] |
+| **updated_at** | **Time** |  | [optional][readonly] |
+| **link_type_id** | **Integer** | The link type ID to use. You can also use the link_type_name field. |  |
+| **link_type_name** | **String** | The link type name to use. You can also use the link_type_id field. | [optional] |
+| **inward_id** | **Integer** | The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set. |  |
+| **outward_id** | **Integer** | The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set. |  |
+| **notes** | **String** | Optional. Some notes. | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::TransactionLink.new(
+  created_at: 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  updated_at : 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  link_type_id : 5,
+  link_type_name : Is paid by,
+                           inward_id: 131,
+                           outward_id: 131,
+                           notes: Some example notes
+)
+```
+

data/docs/TransactionLinkArray.md

@@ -0,0 +1,22 @@
+# OpenapiClient::TransactionLinkArray
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<TransactionLinkRead>**](TransactionLinkRead.md) |  | [optional] |
+| **meta** | [**Meta**](Meta.md) |  | [optional] |
+| **links** | [**PageLink**](PageLink.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::TransactionLinkArray.new(
+  data: null,
+  meta: null,
+  links: null
+)
+```
+

data/docs/TransactionLinkRead.md

@@ -0,0 +1,24 @@
+# OpenapiClient::TransactionLinkRead
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Immutable value | [optional] |
+| **id** | **Integer** |  | [optional] |
+| **attributes** | [**TransactionLink**](TransactionLink.md) |  | [optional] |
+| **links** | [**ObjectLink**](ObjectLink.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::TransactionLinkRead.new(
+  type: transactionLinks,
+  id: 2,
+  attributes: null,
+  links: null
+)
+```
+

data/docs/TransactionLinkSingle.md

@@ -0,0 +1,18 @@
+# OpenapiClient::TransactionLinkSingle
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**TransactionLinkRead**](TransactionLinkRead.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::TransactionLinkSingle.new(
+  data: null
+)
+```
+

data/docs/TransactionRead.md

@@ -0,0 +1,24 @@
+# OpenapiClient::TransactionRead
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Immutable value | [optional] |
+| **id** | **Integer** |  | [optional] |
+| **attributes** | [**Transaction**](Transaction.md) |  | [optional] |
+| **links** | [**ObjectLink**](ObjectLink.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::TransactionRead.new(
+  type: transactions,
+  id: 2,
+  attributes: null,
+  links: null
+)
+```
+

data/docs/TransactionSingle.md

@@ -0,0 +1,18 @@
+# OpenapiClient::TransactionSingle
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**TransactionRead**](TransactionRead.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::TransactionSingle.new(
+  data: null
+)
+```
+

data/docs/TransactionSplit.md

@@ -0,0 +1,128 @@
+# OpenapiClient::TransactionSplit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | **Integer** | User ID | [optional][readonly] |
+| **transaction_journal_id** | **Integer** | ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals making up the splits of the transaction.  | [optional][readonly] |
+| **type** | **String** | Type of transaction. expense cannot be written. | [optional] |
+| **date** | **Date** | Date of the transaction |  |
+| **amount** | **Float** | Amount of the transaction. |  |
+| **description** | **String** | Description of the transaction. Will only be used if more than one split is submitted. |  |
+| **order** | **Integer** | Order of this entry in the list of transactions. | [optional] |
+| **currency_id** | **Integer** | Currency ID. Default is the source account's currency, or the user's default currency. Can be used instead of currency_code. | [optional] |
+| **currency_code** | **String** | Currency code. Default is the source account's currency, or the user's default currency. Can be used instead of currency_id. | [optional] |
+| **currency_symbol** | **String** |  | [optional][readonly] |
+| **currency_name** | **String** |  | [optional][readonly] |
+| **currency_decimal_places** | **Integer** | Number of decimals used in this currency. | [optional][readonly] |
+| **foreign_amount** | **Float** | The amount in a foreign currency. | [optional] |
+| **foreign_currency_id** | **Integer** | Currency ID. Default is null. Is required when you submit a foreign amount. | [optional] |
+| **foreign_currency_code** | **String** | Currency code. Default is NULL. Can be used instead of the foreign_currency_id, but either is required when submitting a foreign amount. | [optional] |
+| **foreign_currency_symbol** | **String** |  | [optional][readonly] |
+| **foreign_currency_decimal_places** | **Integer** | Number of decimals in the currency | [optional][readonly] |
+| **budget_id** | **Integer** | The budget ID for this transaction. | [optional] |
+| **budget_name** | **String** | The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored. | [optional][readonly] |
+| **category_id** | **Integer** | The category ID for this transaction. | [optional] |
+| **category_name** | **String** | The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. | [optional] |
+| **source_id** | **Integer** | ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. | [optional] |
+| **source_name** | **String** | Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. | [optional] |
+| **source_iban** | **String** |  | [optional][readonly] |
+| **source_type** | [**AccountTypeProperty**](AccountTypeProperty.md) |  | [optional] |
+| **destination_id** | **Integer** | ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. | [optional] |
+| **destination_name** | **String** | Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. | [optional] |
+| **destination_iban** | **String** |  | [optional][readonly] |
+| **destination_type** | [**AccountTypeProperty**](AccountTypeProperty.md) |  | [optional] |
+| **reconciled** | **Boolean** | If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. | [optional] |
+| **piggy_bank_id** | **Integer** | Optional. Use either this or the piggy_bank_name | [optional] |
+| **piggy_bank_name** | **String** | Optional. Use either this or the piggy_bank_id | [optional] |
+| **bill_id** | **Integer** | Optional. Use either this or the bill_name | [optional] |
+| **bill_name** | **String** | Optional. Use either this or the bill_id | [optional] |
+| **tags** | **Array<String>** | Array of tags. | [optional] |
+| **notes** | **String** |  | [optional] |
+| **internal_reference** | **String** | Reference to internal reference of other systems. | [optional] |
+| **external_id** | **String** | Reference to external ID in other systems. | [optional] |
+| **original_source** | **String** | System generated identifier for original creator of transaction. | [optional][readonly] |
+| **recurrence_id** | **Integer** | Reference to recurrence that made the transaction. | [optional][readonly] |
+| **bunq_payment_id** | **String** | Internal ID of bunq transaction. | [optional] |
+| **import_hash_v2** | **String** | Hash value of original import transaction (for duplicate detection). | [optional][readonly] |
+| **sepa_cc** | **String** | SEPA Clearing Code | [optional] |
+| **sepa_ct_op** | **String** | SEPA Opposing Account Identifier | [optional] |
+| **sepa_ct_id** | **String** | SEPA end-to-end Identifier | [optional] |
+| **sepa_db** | **String** | SEPA mandate identifier | [optional] |
+| **sepa_country** | **String** | SEPA Country | [optional] |
+| **sepa_ep** | **String** | SEPA External Purpose indicator | [optional] |
+| **sepa_ci** | **String** | SEPA Creditor Identifier | [optional] |
+| **sepa_batch_id** | **String** | SEPA Batch ID | [optional] |
+| **interest_date** | **Date** |  | [optional] |
+| **book_date** | **Date** |  | [optional] |
+| **process_date** | **Date** |  | [optional] |
+| **due_date** | **Date** |  | [optional] |
+| **payment_date** | **Date** |  | [optional] |
+| **invoice_date** | **Date** |  | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::TransactionSplit.new(
+  user: 3,
+  transaction_journal_id: 10421,
+  type: withdrawal,
+  date: Mon Sep 17 00 : 00 : 00 GMT 2018,
+                                    amount: 12.95,
+                                    description: Vegetables,
+                                    order: 0,
+                                    currency_id: 12,
+                                    currency_code: EUR,
+                                    currency_symbol: $,
+currency_name : Euro,
+    currency_decimal_places : 2,
+  foreign_amount : 16.95,
+  foreign_currency_id : 17,
+  foreign_currency_code : USD,
+    foreign_currency_symbol : $,
+foreign_currency_decimal_places : 2,
+  budget_id : 4,
+  budget_name : Groceries,
+    category_id : 43,
+  category_name : Groceries,
+    source_id : 2,
+  source_name : Checking account,
+                         source_iban: NL02ABNA0123456789,
+                         source_type: null,
+                         destination_id: 2,
+                         destination_name: Buy and Large,
+  destination_iban : NL02ABNA0123456789,
+    destination_type : null,
+    reconciled : false,
+    piggy_bank_id : null,
+    piggy_bank_name : null,
+    bill_id : 111,
+  bill_name : Monthly rent,
+                      tags: null,
+                      notes: Some example notes,
+                                          internal_reference: null,
+                                          external_id: null,
+                                          original_source: null,
+                                          recurrence_id: null,
+                                          bunq_payment_id: null,
+                                          import_hash_v2: null,
+                                          sepa_cc: null,
+                                          sepa_ct_op: null,
+                                          sepa_ct_id: null,
+                                          sepa_db: null,
+                                          sepa_country: null,
+                                          sepa_ep: null,
+                                          sepa_ci: null,
+                                          sepa_batch_id: null,
+                                          interest_date: null,
+                                          book_date: null,
+                                          process_date: null,
+                                          due_date: null,
+                                          payment_date: null,
+                                          invoice_date: null
+)
+```
+

data/docs/TransactionTypeFilter.md

@@ -0,0 +1,15 @@
+# OpenapiClient::TransactionTypeFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::TransactionTypeFilter.new()
+```
+

data/docs/TransactionsApi.md

@@ -0,0 +1,592 @@
+# OpenapiClient::TransactionsApi
+
+All URIs are relative to *https://demo.firefly-iii.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_transaction**](TransactionsApi.md#delete_transaction) | **DELETE** /api/v1/transactions/{id} | Delete a transaction. |
+| [**get_transaction**](TransactionsApi.md#get_transaction) | **GET** /api/v1/transactions/{id} | Get a single transaction. |
+| [**get_transaction_by_journal**](TransactionsApi.md#get_transaction_by_journal) | **GET** /api/v1/transaction-journals/{id} | Get a single transaction, based on one of the underlying transaction journals. |
+| [**list_attachment_by_transaction**](TransactionsApi.md#list_attachment_by_transaction) | **GET** /api/v1/transactions/{id}/attachments | Lists all attachments. |
+| [**list_event_by_transaction**](TransactionsApi.md#list_event_by_transaction) | **GET** /api/v1/transactions/{id}/piggy_bank_events | Lists all piggy bank events. |
+| [**list_transaction**](TransactionsApi.md#list_transaction) | **GET** /api/v1/transactions | List all the user's transactions.  |
+| [**store_transaction**](TransactionsApi.md#store_transaction) | **POST** /api/v1/transactions | Store a new transaction |
+| [**update_transaction**](TransactionsApi.md#update_transaction) | **PUT** /api/v1/transactions/{id} | Update existing transaction. |
+
+
+## delete_transaction
+
+> delete_transaction(id)
+
+Delete a transaction.
+
+Delete a transaction.
+
+### Examples
+
+```ruby
+require 'time'
+require 'firefly_iii_client'
+# setup authorization
+FireflyIIIClient.configure do |config|
+  # Configure OAuth2 access token for authorization: firefly_iii_auth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FireflyIIIClient::TransactionsApi.new
+id = 1 # Integer | The ID of the transaction.
+
+begin
+  # Delete a transaction.
+  api_instance.delete_transaction(id)
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TransactionsApi->delete_transaction: #{e}"
+end
+```
+
+#### Using the delete_transaction_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_transaction_with_http_info(id)
+
+```ruby
+
+begin
+  # Delete a transaction.
+  data, status_code, headers = api_instance.delete_transaction_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TransactionsApi->delete_transaction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The ID of the transaction. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## get_transaction
+
+> <TransactionSingle> get_transaction(id)
+
+Get a single transaction.
+
+Get a single transaction.
+
+### Examples
+
+```ruby
+require 'time'
+require 'firefly_iii_client'
+# setup authorization
+FireflyIIIClient.configure do |config|
+  # Configure OAuth2 access token for authorization: firefly_iii_auth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FireflyIIIClient::TransactionsApi.new
+id = 1 # Integer | The ID of the transaction.
+
+begin
+  # Get a single transaction.
+  result = api_instance.get_transaction(id)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TransactionsApi->get_transaction: #{e}"
+end
+```
+
+#### Using the get_transaction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionSingle>, Integer, Hash)> get_transaction_with_http_info(id)
+
+```ruby
+
+begin
+  # Get a single transaction.
+  data, status_code, headers = api_instance.get_transaction_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionSingle>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TransactionsApi->get_transaction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The ID of the transaction. |  |
+
+### Return type
+
+[**TransactionSingle**](TransactionSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_transaction_by_journal
+
+> <TransactionSingle> get_transaction_by_journal(id)
+
+Get a single transaction, based on one of the underlying transaction journals.
+
+Get a single transaction by underlying journal.
+
+### Examples
+
+```ruby
+require 'time'
+require 'firefly_iii_client'
+# setup authorization
+FireflyIIIClient.configure do |config|
+  # Configure OAuth2 access token for authorization: firefly_iii_auth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FireflyIIIClient::TransactionsApi.new
+id = 1 # Integer | The ID of the transaction journal.
+
+begin
+  # Get a single transaction, based on one of the underlying transaction journals.
+  result = api_instance.get_transaction_by_journal(id)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TransactionsApi->get_transaction_by_journal: #{e}"
+end
+```
+
+#### Using the get_transaction_by_journal_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionSingle>, Integer, Hash)> get_transaction_by_journal_with_http_info(id)
+
+```ruby
+
+begin
+  # Get a single transaction, based on one of the underlying transaction journals.
+  data, status_code, headers = api_instance.get_transaction_by_journal_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionSingle>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TransactionsApi->get_transaction_by_journal_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The ID of the transaction journal. |  |
+
+### Return type
+
+[**TransactionSingle**](TransactionSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_attachment_by_transaction
+
+> <AttachmentArray> list_attachment_by_transaction(id, opts)
+
+Lists all attachments.
+
+Lists all attachments.
+
+### Examples
+
+```ruby
+require 'time'
+require 'firefly_iii_client'
+# setup authorization
+FireflyIIIClient.configure do |config|
+  # Configure OAuth2 access token for authorization: firefly_iii_auth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FireflyIIIClient::TransactionsApi.new
+id = 1 # Integer | The ID of the transaction.
+opts = {
+  page: 1 # Integer | Page number. The default pagination is 50.
+}
+
+begin
+  # Lists all attachments.
+  result = api_instance.list_attachment_by_transaction(id, opts)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TransactionsApi->list_attachment_by_transaction: #{e}"
+end
+```
+
+#### Using the list_attachment_by_transaction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AttachmentArray>, Integer, Hash)> list_attachment_by_transaction_with_http_info(id, opts)
+
+```ruby
+
+begin
+  # Lists all attachments.
+  data, status_code, headers = api_instance.list_attachment_by_transaction_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AttachmentArray>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TransactionsApi->list_attachment_by_transaction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The ID of the transaction. |  |
+| **page** | **Integer** | Page number. The default pagination is 50. | [optional] |
+
+### Return type
+
+[**AttachmentArray**](AttachmentArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_event_by_transaction
+
+> <PiggyBankEventArray> list_event_by_transaction(id, opts)
+
+Lists all piggy bank events.
+
+Lists all piggy bank events.
+
+### Examples
+
+```ruby
+require 'time'
+require 'firefly_iii_client'
+# setup authorization
+FireflyIIIClient.configure do |config|
+  # Configure OAuth2 access token for authorization: firefly_iii_auth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FireflyIIIClient::TransactionsApi.new
+id = 1 # Integer | The ID of the transaction.
+opts = {
+  page: 1 # Integer | Page number. The default pagination is 50.
+}
+
+begin
+  # Lists all piggy bank events.
+  result = api_instance.list_event_by_transaction(id, opts)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TransactionsApi->list_event_by_transaction: #{e}"
+end
+```
+
+#### Using the list_event_by_transaction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PiggyBankEventArray>, Integer, Hash)> list_event_by_transaction_with_http_info(id, opts)
+
+```ruby
+
+begin
+  # Lists all piggy bank events.
+  data, status_code, headers = api_instance.list_event_by_transaction_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PiggyBankEventArray>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TransactionsApi->list_event_by_transaction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The ID of the transaction. |  |
+| **page** | **Integer** | Page number. The default pagination is 50. | [optional] |
+
+### Return type
+
+[**PiggyBankEventArray**](PiggyBankEventArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_transaction
+
+> <TransactionArray> list_transaction(opts)
+
+List all the user's transactions. 
+
+List all the user's transactions.
+
+### Examples
+
+```ruby
+require 'time'
+require 'firefly_iii_client'
+# setup authorization
+FireflyIIIClient.configure do |config|
+  # Configure OAuth2 access token for authorization: firefly_iii_auth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FireflyIIIClient::TransactionsApi.new
+opts = {
+  page: 1, # Integer | Page number. The default pagination is 50.
+  start: Date.parse('Mon Sep 17 00:00:00 GMT 2018'), # Date | A date formatted YYYY-MM-DD. This is the start date of the selected range (inclusive). 
+  _end: Date.parse('Mon Sep 17 00:00:00 GMT 2018'), # Date | A date formatted YYYY-MM-DD. This is the end date of the selected range (inclusive). 
+  type: FireflyIIIClient::TransactionTypeFilter::ALL # TransactionTypeFilter | Optional filter on the transaction type(s) returned.
+}
+
+begin
+  # List all the user's transactions. 
+  result = api_instance.list_transaction(opts)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TransactionsApi->list_transaction: #{e}"
+end
+```
+
+#### Using the list_transaction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionArray>, Integer, Hash)> list_transaction_with_http_info(opts)
+
+```ruby
+
+begin
+  # List all the user's transactions. 
+  data, status_code, headers = api_instance.list_transaction_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionArray>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TransactionsApi->list_transaction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page number. The default pagination is 50. | [optional] |
+| **start** | **Date** | A date formatted YYYY-MM-DD. This is the start date of the selected range (inclusive).  | [optional] |
+| **_end** | **Date** | A date formatted YYYY-MM-DD. This is the end date of the selected range (inclusive).  | [optional] |
+| **type** | [**TransactionTypeFilter**](.md) | Optional filter on the transaction type(s) returned. | [optional] |
+
+### Return type
+
+[**TransactionArray**](TransactionArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## store_transaction
+
+> <TransactionSingle> store_transaction(transaction)
+
+Store a new transaction
+
+Creates a new transaction. The data required can be submitted as a JSON body or as a list of parameters.
+
+### Examples
+
+```ruby
+require 'time'
+require 'firefly_iii_client'
+# setup authorization
+FireflyIIIClient.configure do |config|
+  # Configure OAuth2 access token for authorization: firefly_iii_auth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FireflyIIIClient::TransactionsApi.new
+transaction = FireflyIIIClient::Transaction.new({ transactions: [FireflyIIIClient::TransactionSplit.new({ date: Date.parse('Mon Sep 17 00:00:00 GMT 2018'), amount: 12.95, description: 'Vegetables' })] }) # Transaction | JSON array or key=value pairs with the necessary transaction information. See the model for the exact specifications.
+
+begin
+  # Store a new transaction
+  result = api_instance.store_transaction(transaction)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TransactionsApi->store_transaction: #{e}"
+end
+```
+
+#### Using the store_transaction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionSingle>, Integer, Hash)> store_transaction_with_http_info(transaction)
+
+```ruby
+
+begin
+  # Store a new transaction
+  data, status_code, headers = api_instance.store_transaction_with_http_info(transaction)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionSingle>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TransactionsApi->store_transaction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction** | [**Transaction**](Transaction.md) | JSON array or key&#x3D;value pairs with the necessary transaction information. See the model for the exact specifications. |  |
+
+### Return type
+
+[**TransactionSingle**](TransactionSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## update_transaction
+
+> <TransactionSingle> update_transaction(id, transaction)
+
+Update existing transaction.
+
+Update an existing transaction.
+
+### Examples
+
+```ruby
+require 'time'
+require 'firefly_iii_client'
+# setup authorization
+FireflyIIIClient.configure do |config|
+  # Configure OAuth2 access token for authorization: firefly_iii_auth
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = FireflyIIIClient::TransactionsApi.new
+id = 1 # Integer | The ID of the transaction.
+transaction = FireflyIIIClient::Transaction.new({ transactions: [FireflyIIIClient::TransactionSplit.new({ date: Date.parse('Mon Sep 17 00:00:00 GMT 2018'), amount: 12.95, description: 'Vegetables' })] }) # Transaction | JSON array with updated transaction information. See the model for the exact specifications.
+
+begin
+  # Update existing transaction.
+  result = api_instance.update_transaction(id, transaction)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TransactionsApi->update_transaction: #{e}"
+end
+```
+
+#### Using the update_transaction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionSingle>, Integer, Hash)> update_transaction_with_http_info(id, transaction)
+
+```ruby
+
+begin
+  # Update existing transaction.
+  data, status_code, headers = api_instance.update_transaction_with_http_info(id, transaction)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionSingle>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TransactionsApi->update_transaction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The ID of the transaction. |  |
+| **transaction** | [**Transaction**](Transaction.md) | JSON array with updated transaction information. See the model for the exact specifications. |  |
+
+### Return type
+
+[**TransactionSingle**](TransactionSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded
+- **Accept**: application/json
+