firefly-iii-client 1.0.0

data/docs/Currency.md

@@ -0,0 +1,32 @@
+# OpenapiClient::Currency
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  | [optional][readonly] |
+| **updated_at** | **Time** |  | [optional][readonly] |
+| **enabled** | **Boolean** | defaults to true | [optional] |
+| **default** | **Boolean** | Make this currency the default currency. | [optional] |
+| **code** | **String** |  |  |
+| **name** | **String** |  |  |
+| **symbol** | **String** |  |  |
+| **decimal_places** | **Integer** | Supports 0-16 decimals. | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::Currency.new(
+  created_at: 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  updated_at : 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  enabled : true,
+    default : false,
+    code : AMS,
+    name : Ankh - Morpork dollar,
+  symbol : AM $,
+decimal_places : 2
+)
+```
+

data/docs/CurrencyArray.md

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

data/docs/CurrencyExchangeRatesApi.md

@@ -0,0 +1,86 @@
+# OpenapiClient::CurrencyExchangeRatesApi
+
+All URIs are relative to *https://demo.firefly-iii.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_exchange_rate**](CurrencyExchangeRatesApi.md#get_exchange_rate) | **GET** /api/v1/cer | Get an exchange rate. |
+
+
+## get_exchange_rate
+
+> <ExchangeRate> get_exchange_rate(opts)
+
+Get an exchange rate.
+
+Get an exchange rate. If Firefly III doesn't know the rate it will set the rate to 1.0.
+
+### 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::CurrencyExchangeRatesApi.new
+opts = {
+  from: 'EUR', # String | The source currency code. If omitted, defaults to EUR.
+  to: 'USD', # String | The destination currency code. If omitted, defaults to USD.
+  date: Date.parse('Mon Sep 17 00:00:00 GMT 2018'), # Date | The date you want to know the exchange rate on.
+  amount: 120.12 # Float | The amount in the source currency. If added, Firefly III will calculate the amount in the destination currency.
+}
+
+begin
+  # Get an exchange rate.
+  result = api_instance.get_exchange_rate(opts)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling CurrencyExchangeRatesApi->get_exchange_rate: #{e}"
+end
+```
+
+#### Using the get_exchange_rate_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ExchangeRate>, Integer, Hash)> get_exchange_rate_with_http_info(opts)
+
+```ruby
+
+begin
+  # Get an exchange rate.
+  data, status_code, headers = api_instance.get_exchange_rate_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExchangeRate>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling CurrencyExchangeRatesApi->get_exchange_rate_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | **String** | The source currency code. If omitted, defaults to EUR. | [optional] |
+| **to** | **String** | The destination currency code. If omitted, defaults to USD. | [optional] |
+| **date** | **Date** | The date you want to know the exchange rate on. | [optional] |
+| **amount** | **Float** | The amount in the source currency. If added, Firefly III will calculate the amount in the destination currency. | [optional] |
+
+### Return type
+
+[**ExchangeRate**](ExchangeRate.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CurrencyRead.md

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

data/docs/CurrencySingle.md

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

data/docs/ExchangeRate.md

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

data/docs/ExchangeRateArray.md

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

data/docs/ExchangeRateAttributes.md

@@ -0,0 +1,44 @@
+# OpenapiClient::ExchangeRateAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  | [optional] |
+| **updated_at** | **Time** |  | [optional] |
+| **from_currency_id** | **Integer** |  | [optional] |
+| **from_currency_name** | **String** |  | [optional] |
+| **from_currency_code** | **String** |  | [optional] |
+| **from_currency_symbol** | **String** |  | [optional] |
+| **from_currency_decimal_places** | **Integer** |  | [optional] |
+| **to_currency_id** | **Integer** |  | [optional] |
+| **to_currency_code** | **String** |  | [optional] |
+| **to_currency_symbol** | **String** |  | [optional] |
+| **to_currency_decimal_places** | **Integer** |  | [optional] |
+| **date** | **Date** |  | [optional] |
+| **rate** | **Float** |  | [optional] |
+| **amount** | **Float** | The amount in the \"to\"-currency, if provided in the request. | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::ExchangeRateAttributes.new(
+  created_at: 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  updated_at : 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  from_currency_id : 5,
+  from_currency_name : Euro,
+    from_currency_code : EUR,
+    from_currency_symbol : $,
+from_currency_decimal_places : 2,
+  to_currency_id : 5,
+  to_currency_code : EUR,
+    to_currency_symbol : $,
+to_currency_decimal_places : 2,
+  date : Mon Sep 17 00 : 00 : 00 GMT 2018,
+                                     rate: 1.1213,
+                                     amount: 82.12
+)
+```
+

data/docs/ImportApi.md

@@ -0,0 +1,232 @@
+# OpenapiClient::ImportApi
+
+All URIs are relative to *https://demo.firefly-iii.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_import**](ImportApi.md#get_import) | **GET** /api/v1/import/{key} | Show info on a single import |
+| [**list_import**](ImportApi.md#list_import) | **GET** /api/v1/import/list | List al imports |
+| [**list_transaction_by_import**](ImportApi.md#list_transaction_by_import) | **GET** /api/v1/import/{key}/transactions | List all transactions related to the import job. The correlation is made through the tag. |
+
+
+## get_import
+
+> <ImportJobSingle> get_import(key)
+
+Show info on a single import
+
+Show info on single import.
+
+### 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::ImportApi.new
+key = 'x2Akaijm2' # String | The job key of an import job.
+
+begin
+  # Show info on a single import
+  result = api_instance.get_import(key)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling ImportApi->get_import: #{e}"
+end
+```
+
+#### Using the get_import_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ImportJobSingle>, Integer, Hash)> get_import_with_http_info(key)
+
+```ruby
+
+begin
+  # Show info on a single import
+  data, status_code, headers = api_instance.get_import_with_http_info(key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ImportJobSingle>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling ImportApi->get_import_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The job key of an import job. |  |
+
+### Return type
+
+[**ImportJobSingle**](ImportJobSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_import
+
+> <ImportJobArray> list_import(opts)
+
+List al imports
+
+List all imports
+
+### 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::ImportApi.new
+opts = {
+  page: 1 # Integer | Page number. The default pagination is per 50 items.
+}
+
+begin
+  # List al imports
+  result = api_instance.list_import(opts)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling ImportApi->list_import: #{e}"
+end
+```
+
+#### Using the list_import_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ImportJobArray>, Integer, Hash)> list_import_with_http_info(opts)
+
+```ruby
+
+begin
+  # List al imports
+  data, status_code, headers = api_instance.list_import_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ImportJobArray>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling ImportApi->list_import_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page number. The default pagination is per 50 items. | [optional] |
+
+### Return type
+
+[**ImportJobArray**](ImportJobArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_transaction_by_import
+
+> <TransactionArray> list_transaction_by_import(key, opts)
+
+List all transactions related to the import job. The correlation is made through the tag.
+
+See summary 
+
+### 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::ImportApi.new
+key = 'abcde' # String | The key of the import job
+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 transactions related to the import job. The correlation is made through the tag.
+  result = api_instance.list_transaction_by_import(key, opts)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling ImportApi->list_transaction_by_import: #{e}"
+end
+```
+
+#### Using the list_transaction_by_import_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionArray>, Integer, Hash)> list_transaction_by_import_with_http_info(key, opts)
+
+```ruby
+
+begin
+  # List all transactions related to the import job. The correlation is made through the tag.
+  data, status_code, headers = api_instance.list_transaction_by_import_with_http_info(key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionArray>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling ImportApi->list_transaction_by_import_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The key of the import job |  |
+| **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
+