firefly-iii-client 1.0.0

data/docs/SummaryApi.md

@@ -0,0 +1,84 @@
+# OpenapiClient::SummaryApi
+
+All URIs are relative to *https://demo.firefly-iii.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_basic_summary**](SummaryApi.md#get_basic_summary) | **GET** /api/v1/summary/basic | Returns basic sums of the users data. |
+
+
+## get_basic_summary
+
+> <Array<BasicSummaryEntry>> get_basic_summary(start, _end, opts)
+
+Returns basic sums of the users data.
+
+Returns basic sums of the users data, like the net worth, spent and earned amounts. It is multi-currency, and is in Firefly III to populate the dashboard. 
+
+### 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::SummaryApi.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. 
+opts = {
+  currency_code: 'currency_code_example' # String | A currency code like EUR or USD, to filter the result. 
+}
+
+begin
+  # Returns basic sums of the users data.
+  result = api_instance.get_basic_summary(start, _end, opts)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling SummaryApi->get_basic_summary: #{e}"
+end
+```
+
+#### Using the get_basic_summary_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<BasicSummaryEntry>>, Integer, Hash)> get_basic_summary_with_http_info(start, _end, opts)
+
+```ruby
+
+begin
+  # Returns basic sums of the users data.
+  data, status_code, headers = api_instance.get_basic_summary_with_http_info(start, _end, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<BasicSummaryEntry>>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling SummaryApi->get_basic_summary_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.  |  |
+| **currency_code** | **String** | A currency code like EUR or USD, to filter the result.  | [optional] |
+
+### Return type
+
+[**Array&lt;BasicSummaryEntry&gt;**](BasicSummaryEntry.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/SystemConfiguration.md

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

data/docs/SystemConfigurationData.md

@@ -0,0 +1,24 @@
+# OpenapiClient::SystemConfigurationData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is_demo_site** | **Boolean** |  | [optional] |
+| **permission_update_check** | **Integer** | If the user has given permission to check for updates. - null = never asked. - -1 = never asked. - 0 = no permission. - 1 = permission  | [optional] |
+| **last_update_check** | **Time** |  | [optional] |
+| **single_user_mode** | **Boolean** | Whether other users can register. | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::SystemConfigurationData.new(
+  is_demo_site: true,
+  permission_update_check: -1,
+  last_update_check: 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  single_user_mode : true
+)
+```
+

data/docs/SystemInfo.md

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

data/docs/SystemInfoData.md

@@ -0,0 +1,26 @@
+# OpenapiClient::SystemInfoData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **String** |  |  |
+| **api_version** | **String** |  |  |
+| **php_version** | **String** |  |  |
+| **os** | **String** |  |  |
+| **driver** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::SystemInfoData.new(
+  version: 4.8.0,
+               api_version: 0.10. 0,
+  php_version : 7.2,
+  os : Linux vagrant - ubuntu - trusty - 64,
+             driver: mysql
+)
+```
+

data/docs/TagArray.md

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

data/docs/TagCloud.md

@@ -0,0 +1,18 @@
+# OpenapiClient::TagCloud
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tags** | [**Array<TagCloudTag>**](TagCloudTag.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::TagCloud.new(
+  tags: null
+)
+```
+

data/docs/TagCloudTag.md

@@ -0,0 +1,24 @@
+# OpenapiClient::TagCloudTag
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tag** | **String** | The tag | [optional] |
+| **id** | **Integer** | ID of the tag | [optional] |
+| **size** | **Float** | The total amount of money related to this tag. There is no currency information available, and this is a basic sum of all amounts added together. | [optional] |
+| **relative** | **Float** | A number between 0 and 1. 1 is given to the largest tag in the tag cloud, and 0 to the smallest. The rest are given a number between 0 and 1, related to their size in comparison to the largest tag. | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::TagCloudTag.new(
+  tag: expensive,
+  id: 2,
+  size: 24.56,
+  relative: 0.345
+)
+```
+

data/docs/TagModel.md

@@ -0,0 +1,34 @@
+# OpenapiClient::TagModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  | [optional][readonly] |
+| **updated_at** | **Time** |  | [optional][readonly] |
+| **tag** | **String** | The tag |  |
+| **date** | **Date** | The date to which the tag is applicable. | [optional] |
+| **description** | **String** |  | [optional] |
+| **latitude** | **Float** | Latitude of the tag's location, if applicable. Can be used to draw a map. | [optional] |
+| **longitude** | **Float** | Latitude of the tag's location, if applicable. Can be used to draw a map. | [optional] |
+| **zoom_level** | **Integer** | Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::TagModel.new(
+  created_at: 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  updated_at : 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  tag : expensive,
+    date : Mon Sep 17 00 : 00 : 00 GMT 2018,
+                                       description: Tag
+for expensive stuff
+  ,
+    latitude : 51.983333,
+    longitude : 5.916667,
+    zoom_level : 6
+  )
+```
+

data/docs/TagRead.md

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

data/docs/TagSingle.md

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

data/docs/TagsApi.md

@@ -0,0 +1,523 @@
+# OpenapiClient::TagsApi
+
+All URIs are relative to *https://demo.firefly-iii.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_tag**](TagsApi.md#delete_tag) | **DELETE** /api/v1/tags/{tag} | Delete an tag. |
+| [**get_tag**](TagsApi.md#get_tag) | **GET** /api/v1/tags/{tag} | Get a single tag. |
+| [**get_tag_cloud**](TagsApi.md#get_tag_cloud) | **GET** /api/v1/tag-cloud | Returns a basic tag cloud. |
+| [**list_tag**](TagsApi.md#list_tag) | **GET** /api/v1/tags | List all tags. |
+| [**list_transaction_by_tag**](TagsApi.md#list_transaction_by_tag) | **GET** /api/v1/tags/{tag}/transactions | List all transactions with this tag. |
+| [**store_tag**](TagsApi.md#store_tag) | **POST** /api/v1/tags | Store a new tag |
+| [**update_tag**](TagsApi.md#update_tag) | **PUT** /api/v1/tags/{tag} | Update existing tag. |
+
+
+## delete_tag
+
+> delete_tag(tag)
+
+Delete an tag.
+
+Delete an tag.
+
+### 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::TagsApi.new
+tag = 'groceries' # String | Either the tag itself or the tag ID.
+
+begin
+  # Delete an tag.
+  api_instance.delete_tag(tag)
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TagsApi->delete_tag: #{e}"
+end
+```
+
+#### Using the delete_tag_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_tag_with_http_info(tag)
+
+```ruby
+
+begin
+  # Delete an tag.
+  data, status_code, headers = api_instance.delete_tag_with_http_info(tag)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TagsApi->delete_tag_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tag** | **String** | Either the tag itself or the tag ID. |  |
+
+### 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_tag
+
+> <TagSingle> get_tag(tag, opts)
+
+Get a single tag.
+
+Get a single tag.
+
+### 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::TagsApi.new
+tag = 'groceries' # String | Either the tag itself or the tag ID.
+opts = {
+  page: 56 # Integer | Page number
+}
+
+begin
+  # Get a single tag.
+  result = api_instance.get_tag(tag, opts)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TagsApi->get_tag: #{e}"
+end
+```
+
+#### Using the get_tag_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TagSingle>, Integer, Hash)> get_tag_with_http_info(tag, opts)
+
+```ruby
+
+begin
+  # Get a single tag.
+  data, status_code, headers = api_instance.get_tag_with_http_info(tag, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TagSingle>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TagsApi->get_tag_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tag** | **String** | Either the tag itself or the tag ID. |  |
+| **page** | **Integer** | Page number | [optional] |
+
+### Return type
+
+[**TagSingle**](TagSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_tag_cloud
+
+> <TagCloud> get_tag_cloud(start, _end)
+
+Returns a basic tag cloud.
+
+Returns a list of tags, which can be used to draw a basic tag cloud.
+
+### 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::TagsApi.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
+  # Returns a basic tag cloud.
+  result = api_instance.get_tag_cloud(start, _end)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TagsApi->get_tag_cloud: #{e}"
+end
+```
+
+#### Using the get_tag_cloud_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TagCloud>, Integer, Hash)> get_tag_cloud_with_http_info(start, _end)
+
+```ruby
+
+begin
+  # Returns a basic tag cloud.
+  data, status_code, headers = api_instance.get_tag_cloud_with_http_info(start, _end)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TagCloud>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TagsApi->get_tag_cloud_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
+
+[**TagCloud**](TagCloud.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_tag
+
+> <TagArray> list_tag(opts)
+
+List all tags.
+
+List all of the user's tags.
+
+### 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::TagsApi.new
+opts = {
+  page: 56 # Integer | Page number
+}
+
+begin
+  # List all tags.
+  result = api_instance.list_tag(opts)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TagsApi->list_tag: #{e}"
+end
+```
+
+#### Using the list_tag_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TagArray>, Integer, Hash)> list_tag_with_http_info(opts)
+
+```ruby
+
+begin
+  # List all tags.
+  data, status_code, headers = api_instance.list_tag_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TagArray>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TagsApi->list_tag_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page number | [optional] |
+
+### Return type
+
+[**TagArray**](TagArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_transaction_by_tag
+
+> <TransactionArray> list_transaction_by_tag(tag, opts)
+
+List all transactions with this tag.
+
+List all transactions with this tag.
+
+### 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::TagsApi.new
+tag = 'groceries' # String | Either the tag itself or the tag ID.
+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 with this tag.
+  result = api_instance.list_transaction_by_tag(tag, opts)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TagsApi->list_transaction_by_tag: #{e}"
+end
+```
+
+#### Using the list_transaction_by_tag_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionArray>, Integer, Hash)> list_transaction_by_tag_with_http_info(tag, opts)
+
+```ruby
+
+begin
+  # List all transactions with this tag.
+  data, status_code, headers = api_instance.list_transaction_by_tag_with_http_info(tag, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionArray>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TagsApi->list_transaction_by_tag_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tag** | **String** | Either the tag itself or the tag ID. |  |
+| **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_tag
+
+> <TagSingle> store_tag(tag_model)
+
+Store a new tag
+
+Creates a new tag. 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::TagsApi.new
+tag_model = FireflyIIIClient::TagModel.new({ tag: 'expensive' }) # TagModel | JSON array or key=value pairs with the necessary tag information. See the model for the exact specifications.
+
+begin
+  # Store a new tag
+  result = api_instance.store_tag(tag_model)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TagsApi->store_tag: #{e}"
+end
+```
+
+#### Using the store_tag_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TagSingle>, Integer, Hash)> store_tag_with_http_info(tag_model)
+
+```ruby
+
+begin
+  # Store a new tag
+  data, status_code, headers = api_instance.store_tag_with_http_info(tag_model)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TagSingle>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TagsApi->store_tag_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tag_model** | [**TagModel**](TagModel.md) | JSON array or key&#x3D;value pairs with the necessary tag information. See the model for the exact specifications. |  |
+
+### Return type
+
+[**TagSingle**](TagSingle.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_tag
+
+> <TagSingle> update_tag(tag, tag_model)
+
+Update existing tag.
+
+Update existing tag.
+
+### 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::TagsApi.new
+tag = 'groceries' # String | Either the tag itself or the tag ID.
+tag_model = FireflyIIIClient::TagModel.new({ tag: 'expensive' }) # TagModel | JSON array with updated tag information. See the model for the exact specifications.
+
+begin
+  # Update existing tag.
+  result = api_instance.update_tag(tag, tag_model)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TagsApi->update_tag: #{e}"
+end
+```
+
+#### Using the update_tag_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TagSingle>, Integer, Hash)> update_tag_with_http_info(tag, tag_model)
+
+```ruby
+
+begin
+  # Update existing tag.
+  data, status_code, headers = api_instance.update_tag_with_http_info(tag, tag_model)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TagSingle>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling TagsApi->update_tag_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tag** | **String** | Either the tag itself or the tag ID. |  |
+| **tag_model** | [**TagModel**](TagModel.md) | JSON array with updated tag information. See the model for the exact specifications. |  |
+
+### Return type
+
+[**TagSingle**](TagSingle.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
+