firefly-iii-client 1.0.0

data/docs/CategoryArray.md

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

data/docs/CategoryEarned.md

@@ -0,0 +1,30 @@
+# OpenapiClient::CategoryEarned
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start** | **Date** |  | [optional] |
+| **_end** | **Date** |  | [optional] |
+| **currency_id** | **Integer** |  | [optional] |
+| **currency_code** | **String** |  | [optional] |
+| **currency_symbol** | **String** |  | [optional] |
+| **currency_decimal_places** | **Integer** | Number of decimals supported by the currency | [optional] |
+| **amount** | **Float** | The amount earned. | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::CategoryEarned.new(
+  start: Sun Apr 01 00 : 00 : 00 GMT 2018,
+                                     _end: Mon Apr 30 00 : 00 : 00 GMT 2018,
+                                                                       currency_id: 5,
+                                                                       currency_code: USD,
+                                                                       currency_symbol: $,
+currency_decimal_places : 2,
+  amount : 1929.11
+)
+```
+

data/docs/CategoryRead.md

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

data/docs/CategorySingle.md

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

data/docs/CategorySpent.md

@@ -0,0 +1,30 @@
+# OpenapiClient::CategorySpent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start** | **Date** |  | [optional] |
+| **_end** | **Date** |  | [optional] |
+| **currency_id** | **Integer** |  | [optional] |
+| **currency_code** | **String** |  | [optional] |
+| **currency_symbol** | **String** |  | [optional] |
+| **currency_decimal_places** | **Integer** | Number of decimals supported by the currency | [optional] |
+| **amount** | **Float** | The amount spent. | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::CategorySpent.new(
+  start: Sun Apr 01 00 : 00 : 00 GMT 2018,
+                                     _end: Mon Apr 30 00 : 00 : 00 GMT 2018,
+                                                                       currency_id: 5,
+                                                                       currency_code: USD,
+                                                                       currency_symbol: $,
+currency_decimal_places : 2,
+  amount : -1929.11
+)
+```
+

data/docs/ChartDataPoint.md

@@ -0,0 +1,18 @@
+# OpenapiClient::ChartDataPoint
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The key is the label of the value, so for example: '2018-01-01' => 13 or 'Groceries' => -123. | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::ChartDataPoint.new(
+  key: value
+)
+```
+

data/docs/ChartDataSet.md

@@ -0,0 +1,32 @@
+# OpenapiClient::ChartDataSet
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | This is the title of the current set. It can refer to an account, a budget or another object (by name). | [optional] |
+| **currency_id** | **Integer** | The currency ID of the currency associated to the data in the entries. | [optional] |
+| **currency_code** | **String** |  | [optional] |
+| **currency_symbol** | **String** |  | [optional] |
+| **currency_decimal_places** | **Integer** | Number of decimals for the currency associated to the data in the entries. | [optional] |
+| **type** | **String** | Indicated the type of chart that is expected to be rendered. You can safely ignore this if you want. | [optional] |
+| **y_axis_id** | **Integer** | Used to indicate the Y axis for this data set. Is usually between 0 and 1 (left and right side of the chart). | [optional] |
+| **entries** | [**Array<ChartDataPoint>**](ChartDataPoint.md) | The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value. | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::ChartDataSet.new(
+  label: Checking account,
+                  currency_id: 5,
+                  currency_code: EUR,
+                  currency_symbol: $,
+currency_decimal_places : 2,
+  type : line,
+    y_axis_id : 0,
+  entries : null
+)
+```
+

data/docs/ChartsApi.md

@@ -0,0 +1,374 @@
+# OpenapiClient::ChartsApi
+
+All URIs are relative to *https://demo.firefly-iii.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_chart_ab_overview**](ChartsApi.md#get_chart_ab_overview) | **GET** /api/v1/chart/ab/overview/{id} | Dashboard chart with an overview of the available budget. |
+| [**get_chart_account_expense**](ChartsApi.md#get_chart_account_expense) | **GET** /api/v1/chart/account/expense | Dashboard chart with expense account balance information. |
+| [**get_chart_account_overview**](ChartsApi.md#get_chart_account_overview) | **GET** /api/v1/chart/account/overview | Dashboard chart with asset account balance information. |
+| [**get_chart_account_revenue**](ChartsApi.md#get_chart_account_revenue) | **GET** /api/v1/chart/account/revenue | Dashboard chart with revenue account balance information. |
+| [**get_chart_category_overview**](ChartsApi.md#get_chart_category_overview) | **GET** /api/v1/chart/category/overview | Dashboard chart with an overview of the users categories. |
+
+
+## get_chart_ab_overview
+
+> <Array<ChartDataSet>> get_chart_ab_overview(id, start, _end)
+
+Dashboard chart with an overview of the available budget.
+
+This endpoint returns the data required to generate a pie chart for the available budget. 
+
+### 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::ChartsApi.new
+id = 1 # Integer | The ID of the available budget.
+start = Date.parse('2013-10-20') # Date | A date formatted YYYY-MM-DD. 
+_end = Date.parse('2013-10-20') # Date | A date formatted YYYY-MM-DD. 
+
+begin
+  # Dashboard chart with an overview of the available budget.
+  result = api_instance.get_chart_ab_overview(id, start, _end)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling ChartsApi->get_chart_ab_overview: #{e}"
+end
+```
+
+#### Using the get_chart_ab_overview_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<ChartDataSet>>, Integer, Hash)> get_chart_ab_overview_with_http_info(id, start, _end)
+
+```ruby
+
+begin
+  # Dashboard chart with an overview of the available budget.
+  data, status_code, headers = api_instance.get_chart_ab_overview_with_http_info(id, start, _end)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<ChartDataSet>>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling ChartsApi->get_chart_ab_overview_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The ID of the available budget. |  |
+| **start** | **Date** | A date formatted YYYY-MM-DD.  |  |
+| **_end** | **Date** | A date formatted YYYY-MM-DD.  |  |
+
+### Return type
+
+[**Array&lt;ChartDataSet&gt;**](ChartDataSet.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_chart_account_expense
+
+> <Array<ChartDataSet>> get_chart_account_expense(start, _end)
+
+Dashboard chart with expense account balance information.
+
+This endpoint returns the data required to generate a chart that shows the user how much they've spent on their expense accounts. 
+
+### 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::ChartsApi.new
+start = Date.parse('2013-10-20') # Date | A date formatted YYYY-MM-DD. 
+_end = Date.parse('2013-10-20') # Date | A date formatted YYYY-MM-DD. 
+
+begin
+  # Dashboard chart with expense account balance information.
+  result = api_instance.get_chart_account_expense(start, _end)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling ChartsApi->get_chart_account_expense: #{e}"
+end
+```
+
+#### Using the get_chart_account_expense_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<ChartDataSet>>, Integer, Hash)> get_chart_account_expense_with_http_info(start, _end)
+
+```ruby
+
+begin
+  # Dashboard chart with expense account balance information.
+  data, status_code, headers = api_instance.get_chart_account_expense_with_http_info(start, _end)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<ChartDataSet>>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling ChartsApi->get_chart_account_expense_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start** | **Date** | A date formatted YYYY-MM-DD.  |  |
+| **_end** | **Date** | A date formatted YYYY-MM-DD.  |  |
+
+### Return type
+
+[**Array&lt;ChartDataSet&gt;**](ChartDataSet.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_chart_account_overview
+
+> <Array<ChartDataSet>> get_chart_account_overview(start, _end)
+
+Dashboard chart with asset account balance information.
+
+This endpoint returns the data required to generate a chart with basic asset account balance information. 
+
+### 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::ChartsApi.new
+start = Date.parse('2013-10-20') # Date | A date formatted YYYY-MM-DD. 
+_end = Date.parse('2013-10-20') # Date | A date formatted YYYY-MM-DD. 
+
+begin
+  # Dashboard chart with asset account balance information.
+  result = api_instance.get_chart_account_overview(start, _end)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling ChartsApi->get_chart_account_overview: #{e}"
+end
+```
+
+#### Using the get_chart_account_overview_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<ChartDataSet>>, Integer, Hash)> get_chart_account_overview_with_http_info(start, _end)
+
+```ruby
+
+begin
+  # Dashboard chart with asset account balance information.
+  data, status_code, headers = api_instance.get_chart_account_overview_with_http_info(start, _end)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<ChartDataSet>>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling ChartsApi->get_chart_account_overview_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start** | **Date** | A date formatted YYYY-MM-DD.  |  |
+| **_end** | **Date** | A date formatted YYYY-MM-DD.  |  |
+
+### Return type
+
+[**Array&lt;ChartDataSet&gt;**](ChartDataSet.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_chart_account_revenue
+
+> <Array<ChartDataSet>> get_chart_account_revenue(start, _end)
+
+Dashboard chart with revenue account balance information.
+
+This endpoint returns the data required to generate a chart that shows the user how much they've earned from their revenue accounts. 
+
+### 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::ChartsApi.new
+start = Date.parse('2013-10-20') # Date | A date formatted YYYY-MM-DD. 
+_end = Date.parse('2013-10-20') # Date | A date formatted YYYY-MM-DD. 
+
+begin
+  # Dashboard chart with revenue account balance information.
+  result = api_instance.get_chart_account_revenue(start, _end)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling ChartsApi->get_chart_account_revenue: #{e}"
+end
+```
+
+#### Using the get_chart_account_revenue_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<ChartDataSet>>, Integer, Hash)> get_chart_account_revenue_with_http_info(start, _end)
+
+```ruby
+
+begin
+  # Dashboard chart with revenue account balance information.
+  data, status_code, headers = api_instance.get_chart_account_revenue_with_http_info(start, _end)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<ChartDataSet>>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling ChartsApi->get_chart_account_revenue_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start** | **Date** | A date formatted YYYY-MM-DD.  |  |
+| **_end** | **Date** | A date formatted YYYY-MM-DD.  |  |
+
+### Return type
+
+[**Array&lt;ChartDataSet&gt;**](ChartDataSet.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_chart_category_overview
+
+> <Array<ChartDataSet>> get_chart_category_overview(start, _end)
+
+Dashboard chart with an overview of the users categories.
+
+This endpoint returns the data required to generate a bar chart for the expenses and incomes on the users categories. 
+
+### 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::ChartsApi.new
+start = Date.parse('2013-10-20') # Date | A date formatted YYYY-MM-DD. 
+_end = Date.parse('2013-10-20') # Date | A date formatted YYYY-MM-DD. 
+
+begin
+  # Dashboard chart with an overview of the users categories.
+  result = api_instance.get_chart_category_overview(start, _end)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling ChartsApi->get_chart_category_overview: #{e}"
+end
+```
+
+#### Using the get_chart_category_overview_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<ChartDataSet>>, Integer, Hash)> get_chart_category_overview_with_http_info(start, _end)
+
+```ruby
+
+begin
+  # Dashboard chart with an overview of the users categories.
+  data, status_code, headers = api_instance.get_chart_category_overview_with_http_info(start, _end)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<ChartDataSet>>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling ChartsApi->get_chart_category_overview_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start** | **Date** | A date formatted YYYY-MM-DD.  |  |
+| **_end** | **Date** | A date formatted YYYY-MM-DD.  |  |
+
+### Return type
+
+[**Array&lt;ChartDataSet&gt;**](ChartDataSet.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+