firefly-iii-client 1.0.0

data/docs/Preference.md

@@ -0,0 +1,24 @@
+# OpenapiClient::Preference
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  | [optional][readonly] |
+| **updated_at** | **Time** |  | [optional][readonly] |
+| **name** | **String** |  | [optional][readonly] |
+| **data** | **String** | This field can also be an array |  |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::Preference.new(
+  created_at: 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  updated_at : 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  name : currencyPreference,
+    data : EUR
+)
+```
+

data/docs/PreferenceArray.md

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

data/docs/PreferenceRead.md

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

data/docs/PreferenceSingle.md

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

data/docs/PreferencesApi.md

@@ -0,0 +1,224 @@
+# OpenapiClient::PreferencesApi
+
+All URIs are relative to *https://demo.firefly-iii.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_preference**](PreferencesApi.md#get_preference) | **GET** /api/v1/preferences/{name} | Return a single preference. |
+| [**list_preference**](PreferencesApi.md#list_preference) | **GET** /api/v1/preferences | List all users preferences. |
+| [**update_preference**](PreferencesApi.md#update_preference) | **PUT** /api/v1/preferences/{name} | Update preference |
+
+
+## get_preference
+
+> <PreferenceSingle> get_preference(name)
+
+Return a single preference.
+
+Return a single preference.
+
+### 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::PreferencesApi.new
+name = 'currencyPreference' # String | The name of the preference.
+
+begin
+  # Return a single preference.
+  result = api_instance.get_preference(name)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling PreferencesApi->get_preference: #{e}"
+end
+```
+
+#### Using the get_preference_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PreferenceSingle>, Integer, Hash)> get_preference_with_http_info(name)
+
+```ruby
+
+begin
+  # Return a single preference.
+  data, status_code, headers = api_instance.get_preference_with_http_info(name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PreferenceSingle>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling PreferencesApi->get_preference_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the preference. |  |
+
+### Return type
+
+[**PreferenceSingle**](PreferenceSingle.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_preference
+
+> <PreferenceArray> list_preference(opts)
+
+List all users preferences.
+
+List all preferences of the user.
+
+### 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::PreferencesApi.new
+opts = {
+  page: 1 # Integer | Page number. The default pagination is 50.
+}
+
+begin
+  # List all users preferences.
+  result = api_instance.list_preference(opts)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling PreferencesApi->list_preference: #{e}"
+end
+```
+
+#### Using the list_preference_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PreferenceArray>, Integer, Hash)> list_preference_with_http_info(opts)
+
+```ruby
+
+begin
+  # List all users preferences.
+  data, status_code, headers = api_instance.list_preference_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PreferenceArray>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling PreferencesApi->list_preference_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page number. The default pagination is 50. | [optional] |
+
+### Return type
+
+[**PreferenceArray**](PreferenceArray.md)
+
+### Authorization
+
+[firefly_iii_auth](../README.md#firefly_iii_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_preference
+
+> <PreferenceSingle> update_preference(name, preference)
+
+Update preference
+
+Update a user's preference.
+
+### 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::PreferencesApi.new
+name = 'currencyPreference' # String | The name of the preference. Will always overwrite. Will be created if it does not exist.
+preference = FireflyIIIClient::Preference.new({ data: 'EUR' }) # Preference | JSON array or key=value pairs with the necessary preference information. See the model for the exact specifications.
+
+begin
+  # Update preference
+  result = api_instance.update_preference(name, preference)
+  p result
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling PreferencesApi->update_preference: #{e}"
+end
+```
+
+#### Using the update_preference_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PreferenceSingle>, Integer, Hash)> update_preference_with_http_info(name, preference)
+
+```ruby
+
+begin
+  # Update preference
+  data, status_code, headers = api_instance.update_preference_with_http_info(name, preference)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PreferenceSingle>
+rescue FireflyIIIClient::ApiError => e
+  puts "Error when calling PreferencesApi->update_preference_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the preference. Will always overwrite. Will be created if it does not exist. |  |
+| **preference** | [**Preference**](Preference.md) | JSON array or key&#x3D;value pairs with the necessary preference information. See the model for the exact specifications. |  |
+
+### Return type
+
+[**PreferenceSingle**](PreferenceSingle.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
+

data/docs/Recurrence.md

@@ -0,0 +1,45 @@
+# OpenapiClient::Recurrence
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  | [optional][readonly] |
+| **updated_at** | **Time** |  | [optional][readonly] |
+| **type** | **String** |  |  |
+| **title** | **String** |  |  |
+| **description** | **String** | Not to be confused with the description of the actual transaction(s) being created. | [optional] |
+| **first_date** | **Date** | First time the recurring transaction will fire. Must be after today. |  |
+| **latest_date** | **Date** | First time the recurring transaction will fire. Must be after today. | [optional] |
+| **repeat_until** | **Date** | Date until the recurring transaction can fire. Use either this field or repetitions. | [optional] |
+| **nr_of_repetitions** | **Integer** | Max number of created transactions. Use either this field or repeat_until. | [optional] |
+| **apply_rules** | **Boolean** | Whether or not to fire the rules after the creation of a transaction. | [optional] |
+| **active** | **Boolean** | If the recurrence is even active. | [optional] |
+| **notes** | **String** |  | [optional] |
+| **repetitions** | [**Array<RecurrenceRepetition>**](RecurrenceRepetition.md) |  | [optional] |
+| **transactions** | [**Array<RecurrenceTransaction>**](RecurrenceTransaction.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::Recurrence.new(
+  created_at: 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  updated_at : 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  type : withdrawal,
+    title : Rent,
+    description : Recurring transaction for the monthly rent,
+                                                        first_date: Sun
+                                          Sep 17 00 : 00 : 00 GMT 2017,
+                                                                  latest_date: Mon Sep 17 00 : 00 : 00 GMT 2018,
+                                                                                                           repeat_until: Mon Sep 17 00 : 00 : 00 GMT 2018,
+                                                                                                                                                     nr_of_repetitions: 5,
+                                                                                                                                                     apply_rules: true,
+                                                                                                                                                     active: true,
+                                                                                                                                                     notes: Some notes,
+                                            repetitions : null,
+                                            transactions : null
+                                          )
+```
+

data/docs/RecurrenceArray.md

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

data/docs/RecurrenceRead.md

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

data/docs/RecurrenceRepetition.md

@@ -0,0 +1,34 @@
+# OpenapiClient::RecurrenceRepetition
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional][readonly] |
+| **created_at** | **Time** |  | [optional][readonly] |
+| **updated_at** | **Time** |  | [optional][readonly] |
+| **type** | **String** | The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. |  |
+| **moment** | **String** | Information that defined the type of repetition. - For 'daily', this is empty. - For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday). - For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month - For 'monthly' it is the day of the month (1 - 31) - For yearly, it is a full date, ie '2018-09-17'. The year you use does not matter.  |  |
+| **skip** | **Integer** | How many occurrences to skip. 0 means skip nothing. 1 means every other. | [optional] |
+| **weekend** | **Integer** | How to respond when the recurring transaction falls in the weekend. Possible values: 1. Do nothing, just create it 2. Create no transaction. 3. Skip to the previous Friday. 4. Skip to the next Monday.  | [optional] |
+| **description** | **String** | Auto-generated repetition description. | [optional][readonly] |
+| **occurrences** | **Array<Date>** | Array of future dates when the repetition will apply to. Auto generated. | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::RecurrenceRepetition.new(
+  id: 2,
+  created_at: 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  updated_at : 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
+  type : weekly,
+    moment : 3,
+  skip : 0,
+  weekend : 1,
+  description : Every week on Friday,
+                              occurrences: null
+)
+```
+