firefly-iii-client 1.0.0

data/docs/Meta.md

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

data/docs/MetaPagination.md

@@ -0,0 +1,26 @@
+# OpenapiClient::MetaPagination
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** |  | [optional] |
+| **count** | **Integer** |  | [optional] |
+| **per_page** | **Integer** |  | [optional] |
+| **current_page** | **Integer** |  | [optional] |
+| **total_pages** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::MetaPagination.new(
+  total: 3,
+  count: 20,
+  per_page: 100,
+  current_page: 1,
+  total_pages: 1
+)
+```
+

data/docs/ObjectLink.md

@@ -0,0 +1,20 @@
+# OpenapiClient::ObjectLink
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_0** | [**ObjectLink0**](ObjectLink0.md) |  | [optional] |
+| **_self** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::ObjectLink.new(
+  _0: null,
+  _self: https : // demo.firefly - iii.org / api / v1 / OBJECTS / 1
+)
+```
+

data/docs/ObjectLink0.md

@@ -0,0 +1,20 @@
+# OpenapiClient::ObjectLink0
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rel** | **String** |  | [optional] |
+| **uri** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::ObjectLink0.new(
+  rel: self,
+  uri: /OBJECTS/ 1
+)
+```
+

data/docs/PageLink.md

@@ -0,0 +1,22 @@
+# OpenapiClient::PageLink
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_self** | **String** |  | [optional] |
+| **first** | **String** |  | [optional] |
+| **last** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::PageLink.new(
+  _self: https : // demo.firefly - iii.org / api / v1 / OBJECT? & amp; page & #x3D;4,
+  first : https : // demo.firefly - iii.org / api / v1 / OBJECT? & amp; page & #x3D;1,
+  last : https : // demo.firefly - iii.org / api / v1 / OBJECT? & amp; page & #x3D;12
+)
+```
+

data/docs/PiggyBank.md

@@ -0,0 +1,54 @@
+# OpenapiClient::PiggyBank
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  | [optional][readonly] |
+| **updated_at** | **Time** |  | [optional][readonly] |
+| **name** | **String** |  |  |
+| **account_id** | **Integer** | The ID of the asset account this piggy bank is connected to. |  |
+| **account_name** | **String** | The name of the asset account this piggy bank is connected to. | [optional][readonly] |
+| **currency_id** | **Integer** |  | [optional][readonly] |
+| **currency_code** | **String** |  | [optional][readonly] |
+| **currency_symbol** | **String** |  | [optional][readonly] |
+| **currency_decimal_places** | **Integer** | Number of decimals supported by the currency | [optional][readonly] |
+| **target_amount** | **Float** |  |  |
+| **percentage** | **Float** |  | [optional][readonly] |
+| **current_amount** | **Float** |  | [optional] |
+| **left_to_save** | **Float** |  | [optional][readonly] |
+| **save_per_month** | **Float** |  | [optional][readonly] |
+| **start_date** | **Date** | The date you started with this piggy bank. | [optional] |
+| **target_date** | **Date** | The date you intend to finish saving money. | [optional] |
+| **order** | **Integer** |  | [optional][readonly] |
+| **active** | **Boolean** |  | [optional][readonly] |
+| **notes** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::PiggyBank.new(
+  created_at: 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  updated_at : 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  name : New digital camera,
+                     account_id: 13,
+                     account_name: Savings account,
+  currency_id : 5,
+  currency_code : USD,
+    currency_symbol : $,
+currency_decimal_places : 2,
+  target_amount : 800,
+  percentage : 12.5,
+  current_amount : 100,
+  left_to_save : 700,
+  save_per_month : 12.45,
+  start_date : Mon Sep 17 00 : 00 : 00 GMT 2018,
+                                           target_date: Thu Sep 17 00 : 00 : 00 GMT 2020,
+                                                                                    order: 5,
+                                                                                    active: true,
+                                                                                    notes: Some notes
+)
+```
+

data/docs/PiggyBankArray.md

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

data/docs/PiggyBankEvent.md

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

data/docs/PiggyBankEventArray.md

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

data/docs/PiggyBankEventAttributes.md

@@ -0,0 +1,34 @@
+# OpenapiClient::PiggyBankEventAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **updated_at** | **Time** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **currency_id** | **Integer** |  | [optional] |
+| **currency_code** | **String** |  | [optional] |
+| **currency_symbol** | **String** |  | [optional] |
+| **currency_decimal_places** | **Integer** |  | [optional] |
+| **amount** | **Float** |  | [optional] |
+| **journal_id** | **Integer** | The journal associated with the event. | [optional] |
+| **transaction_id** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::PiggyBankEventAttributes.new(
+  updated_at: 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  created_at : 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  currency_id : 5,
+  currency_code : EUR,
+    currency_symbol : $,
+currency_decimal_places : 2,
+  amount : 250,
+  journal_id : 4291,
+  transaction_id : 4291
+)
+```
+

data/docs/PiggyBankRead.md

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

data/docs/PiggyBankSingle.md

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

data/docs/PiggyBanksApi.md

@@ -0,0 +1,440 @@
+# OpenapiClient::PiggyBanksApi
+
+All URIs are relative to *https://demo.firefly-iii.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_piggy_bank**](PiggyBanksApi.md#delete_piggy_bank) | **DELETE** /api/v1/piggy_banks/{id} | Delete a piggy bank. |
+| [**get_piggy_bank**](PiggyBanksApi.md#get_piggy_bank) | **GET** /api/v1/piggy_banks/{id} | Get a single piggy bank. |
+| [**list_event_by_piggy_bank**](PiggyBanksApi.md#list_event_by_piggy_bank) | **GET** /api/v1/piggy_banks/{id}/events | List all events linked to a piggy bank. |
+| [**list_piggy_bank**](PiggyBanksApi.md#list_piggy_bank) | **GET** /api/v1/piggy_banks | List all piggy banks. |
+| [**store_piggy_bank**](PiggyBanksApi.md#store_piggy_bank) | **POST** /api/v1/piggy_banks | Store a new piggy bank |
+| [**update_piggy_bank**](PiggyBanksApi.md#update_piggy_bank) | **PUT** /api/v1/piggy_banks/{id} | Update existing piggy bank. |
+
+
+## delete_piggy_bank
+
+> delete_piggy_bank(id)
+
+Delete a piggy bank.
+
+Delete a piggy bank.
+
+### 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::PiggyBanksApi.new
+id = 1 # Integer | The ID of the piggy bank.
+
+begin
+  # Delete a piggy bank.
+  api_instance.delete_piggy_bank(id)
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling PiggyBanksApi->delete_piggy_bank: #{e}"
+end
+```
+
+#### Using the delete_piggy_bank_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_piggy_bank_with_http_info(id)
+
+```ruby
+
+begin
+  # Delete a piggy bank.
+  data, status_code, headers = api_instance.delete_piggy_bank_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling PiggyBanksApi->delete_piggy_bank_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The ID of the piggy bank. |  |
+
+### 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_piggy_bank
+
+> <PiggyBankSingle> get_piggy_bank(id)
+
+Get a single piggy bank.
+
+Get a single piggy bank.
+
+### 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::PiggyBanksApi.new
+id = 1 # Integer | The ID of the piggy bank.
+
+begin
+  # Get a single piggy bank.
+  result = api_instance.get_piggy_bank(id)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling PiggyBanksApi->get_piggy_bank: #{e}"
+end
+```
+
+#### Using the get_piggy_bank_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PiggyBankSingle>, Integer, Hash)> get_piggy_bank_with_http_info(id)
+
+```ruby
+
+begin
+  # Get a single piggy bank.
+  data, status_code, headers = api_instance.get_piggy_bank_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PiggyBankSingle>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling PiggyBanksApi->get_piggy_bank_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The ID of the piggy bank. |  |
+
+### Return type
+
+[**PiggyBankSingle**](PiggyBankSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_event_by_piggy_bank
+
+> <PiggyBankEventArray> list_event_by_piggy_bank(id, opts)
+
+List all events linked to a piggy bank.
+
+List all events linked to a piggy bank (adding and removing money).
+
+### 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::PiggyBanksApi.new
+id = 1 # Integer | The ID of the piggy bank
+opts = {
+  page: 1 # Integer | Page number. The default pagination is 50.
+}
+
+begin
+  # List all events linked to a piggy bank.
+  result = api_instance.list_event_by_piggy_bank(id, opts)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling PiggyBanksApi->list_event_by_piggy_bank: #{e}"
+end
+```
+
+#### Using the list_event_by_piggy_bank_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PiggyBankEventArray>, Integer, Hash)> list_event_by_piggy_bank_with_http_info(id, opts)
+
+```ruby
+
+begin
+  # List all events linked to a piggy bank.
+  data, status_code, headers = api_instance.list_event_by_piggy_bank_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PiggyBankEventArray>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling PiggyBanksApi->list_event_by_piggy_bank_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The ID of the piggy bank |  |
+| **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_piggy_bank
+
+> <PiggyBankArray> list_piggy_bank(opts)
+
+List all piggy banks.
+
+List all piggy banks.
+
+### 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::PiggyBanksApi.new
+opts = {
+  page: 1 # Integer | Page number. The default pagination is 50.
+}
+
+begin
+  # List all piggy banks.
+  result = api_instance.list_piggy_bank(opts)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling PiggyBanksApi->list_piggy_bank: #{e}"
+end
+```
+
+#### Using the list_piggy_bank_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PiggyBankArray>, Integer, Hash)> list_piggy_bank_with_http_info(opts)
+
+```ruby
+
+begin
+  # List all piggy banks.
+  data, status_code, headers = api_instance.list_piggy_bank_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PiggyBankArray>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling PiggyBanksApi->list_piggy_bank_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page number. The default pagination is 50. | [optional] |
+
+### Return type
+
+[**PiggyBankArray**](PiggyBankArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## store_piggy_bank
+
+> <PiggyBankSingle> store_piggy_bank(piggy_bank)
+
+Store a new piggy bank
+
+Creates a new piggy bank. 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::PiggyBanksApi.new
+piggy_bank = FireflyIIIClient::PiggyBank.new({ name: 'New digital camera', account_id: 13, target_amount: 800 }) # PiggyBank | JSON array or key=value pairs with the necessary piggy bank information. See the model for the exact specifications.
+
+begin
+  # Store a new piggy bank
+  result = api_instance.store_piggy_bank(piggy_bank)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling PiggyBanksApi->store_piggy_bank: #{e}"
+end
+```
+
+#### Using the store_piggy_bank_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PiggyBankSingle>, Integer, Hash)> store_piggy_bank_with_http_info(piggy_bank)
+
+```ruby
+
+begin
+  # Store a new piggy bank
+  data, status_code, headers = api_instance.store_piggy_bank_with_http_info(piggy_bank)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PiggyBankSingle>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling PiggyBanksApi->store_piggy_bank_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **piggy_bank** | [**PiggyBank**](PiggyBank.md) | JSON array or key&#x3D;value pairs with the necessary piggy bank information. See the model for the exact specifications. |  |
+
+### Return type
+
+[**PiggyBankSingle**](PiggyBankSingle.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_piggy_bank
+
+> <PiggyBankSingle> update_piggy_bank(id, piggy_bank)
+
+Update existing piggy bank.
+
+Update existing piggy bank.
+
+### 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::PiggyBanksApi.new
+id = 1 # Integer | The ID of the piggy bank
+piggy_bank = FireflyIIIClient::PiggyBank.new({ name: 'New digital camera', account_id: 13, target_amount: 800 }) # PiggyBank | JSON array with updated piggy bank information. See the model for the exact specifications.
+
+begin
+  # Update existing piggy bank.
+  result = api_instance.update_piggy_bank(id, piggy_bank)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling PiggyBanksApi->update_piggy_bank: #{e}"
+end
+```
+
+#### Using the update_piggy_bank_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PiggyBankSingle>, Integer, Hash)> update_piggy_bank_with_http_info(id, piggy_bank)
+
+```ruby
+
+begin
+  # Update existing piggy bank.
+  data, status_code, headers = api_instance.update_piggy_bank_with_http_info(id, piggy_bank)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PiggyBankSingle>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling PiggyBanksApi->update_piggy_bank_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The ID of the piggy bank |  |
+| **piggy_bank** | [**PiggyBank**](PiggyBank.md) | JSON array with updated piggy bank information. See the model for the exact specifications. |  |
+
+### Return type
+
+[**PiggyBankSingle**](PiggyBankSingle.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
+