firefly-iii-client 1.0.0

data/spec/api/piggy_banks_api_spec.rb

@@ -0,0 +1,109 @@
+=begin
+#Firefly III API
+
+#This is the official documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. This version of the API is live from version v4.7.9 and onwards. You may use the \"Authorize\" button to try the API below. 
+
+The version of the OpenAPI document: 0.10.4-modified
+Contact: thegrumpydictator@gmail.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenapiClient::PiggyBanksApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PiggyBanksApi' do
+  before do
+    # run before each test
+    @api_instance = FireflyIIIClient::PiggyBanksApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PiggyBanksApi' do
+    it 'should create an instance of PiggyBanksApi' do
+      expect(@api_instance).to be_instance_of(FireflyIIIClient::PiggyBanksApi)
+    end
+  end
+
+  # unit tests for delete_piggy_bank
+  # Delete a piggy bank.
+  # Delete a piggy bank.
+  # @param id The ID of the piggy bank.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_piggy_bank test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_piggy_bank
+  # Get a single piggy bank.
+  # Get a single piggy bank.
+  # @param id The ID of the piggy bank.
+  # @param [Hash] opts the optional parameters
+  # @return [PiggyBankSingle]
+  describe 'get_piggy_bank test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_event_by_piggy_bank
+  # List all events linked to a piggy bank.
+  # List all events linked to a piggy bank (adding and removing money).
+  # @param id The ID of the piggy bank
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50.
+  # @return [PiggyBankEventArray]
+  describe 'list_event_by_piggy_bank test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_piggy_bank
+  # List all piggy banks.
+  # List all piggy banks.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50.
+  # @return [PiggyBankArray]
+  describe 'list_piggy_bank test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for store_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.
+  # @param piggy_bank JSON array or key=value pairs with the necessary piggy bank information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [PiggyBankSingle]
+  describe 'store_piggy_bank test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_piggy_bank
+  # Update existing piggy bank.
+  # Update existing piggy bank.
+  # @param id The ID of the piggy bank
+  # @param piggy_bank JSON array with updated piggy bank information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [PiggyBankSingle]
+  describe 'update_piggy_bank test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/preferences_api_spec.rb

@@ -0,0 +1,72 @@
+=begin
+#Firefly III API
+
+#This is the official documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. This version of the API is live from version v4.7.9 and onwards. You may use the \"Authorize\" button to try the API below. 
+
+The version of the OpenAPI document: 0.10.4-modified
+Contact: thegrumpydictator@gmail.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenapiClient::PreferencesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PreferencesApi' do
+  before do
+    # run before each test
+    @api_instance = FireflyIIIClient::PreferencesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PreferencesApi' do
+    it 'should create an instance of PreferencesApi' do
+      expect(@api_instance).to be_instance_of(FireflyIIIClient::PreferencesApi)
+    end
+  end
+
+  # unit tests for get_preference
+  # Return a single preference.
+  # Return a single preference.
+  # @param name The name of the preference.
+  # @param [Hash] opts the optional parameters
+  # @return [PreferenceSingle]
+  describe 'get_preference test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_preference
+  # List all users preferences.
+  # List all preferences of the user.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50.
+  # @return [PreferenceArray]
+  describe 'list_preference test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_preference
+  # Update preference
+  # Update a user's preference.
+  # @param name The name of the preference. Will always overwrite. Will be created if it does not exist.
+  # @param preference JSON array or key=value pairs with the necessary preference information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [PreferenceSingle]
+  describe 'update_preference test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/recurrences_api_spec.rb

@@ -0,0 +1,123 @@
+=begin
+#Firefly III API
+
+#This is the official documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. This version of the API is live from version v4.7.9 and onwards. You may use the \"Authorize\" button to try the API below. 
+
+The version of the OpenAPI document: 0.10.4-modified
+Contact: thegrumpydictator@gmail.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenapiClient::RecurrencesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'RecurrencesApi' do
+  before do
+    # run before each test
+    @api_instance = FireflyIIIClient::RecurrencesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RecurrencesApi' do
+    it 'should create an instance of RecurrencesApi' do
+      expect(@api_instance).to be_instance_of(FireflyIIIClient::RecurrencesApi)
+    end
+  end
+
+  # unit tests for delete_recurrence
+  # Delete a recurring transaction.
+  # Delete a recurring transaction. Transactions created will not be deleted.
+  # @param id The ID of the recurring transaction.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_recurrence test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_recurrence
+  # Get a single recurring transaction.
+  # Get a single recurring transaction.
+  # @param id The ID of the recurring transaction.
+  # @param [Hash] opts the optional parameters
+  # @return [RecurrenceSingle]
+  describe 'get_recurrence test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_recurrence
+  # List all recurring transactions.
+  # List all recurring transactions.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50.
+  # @return [RecurrenceArray]
+  describe 'list_recurrence test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_transaction_by_recurrence
+  # List all transactions created by a recurring transaction.
+  # List all transactions created by a recurring transaction, optionally limited to the date ranges specified.
+  # @param id The ID of the recurring transaction.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50.
+  # @option opts [Date] :start A date formatted YYYY-MM-DD. Both the start and end date must be present. 
+  # @option opts [Date] :_end A date formatted YYYY-MM-DD. Both the start and end date must be present. 
+  # @option opts [TransactionTypeFilter] :type Optional filter on the transaction type(s) returned
+  # @return [TransactionArray]
+  describe 'list_transaction_by_recurrence test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for store_recurrence
+  # Store a new recurring transaction
+  # Creates a new recurring transaction. The data required can be submitted as a JSON body or as a list of parameters.
+  # @param recurrence JSON array or key=value pairs with the necessary recurring transaction information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [RecurrenceSingle]
+  describe 'store_recurrence test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for trigger_recurrence
+  # Trigger the creation of recurring transactions (like a cron job).
+  # Triggers the recurring transactions, like a cron job would. If the schedule does not call for a new transaction to be created, nothing will happen. 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'trigger_recurrence test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_recurrence
+  # Update existing recurring transaction.
+  # Update existing recurring transaction.
+  # @param id The ID of the recurring transaction.
+  # @param recurrence JSON array with updated recurring transaction information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [RecurrenceSingle]
+  describe 'update_recurrence test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/rule_groups_api_spec.rb

@@ -0,0 +1,142 @@
+=begin
+#Firefly III API
+
+#This is the official documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. This version of the API is live from version v4.7.9 and onwards. You may use the \"Authorize\" button to try the API below. 
+
+The version of the OpenAPI document: 0.10.4-modified
+Contact: thegrumpydictator@gmail.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenapiClient::RuleGroupsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'RuleGroupsApi' do
+  before do
+    # run before each test
+    @api_instance = FireflyIIIClient::RuleGroupsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RuleGroupsApi' do
+    it 'should create an instance of RuleGroupsApi' do
+      expect(@api_instance).to be_instance_of(FireflyIIIClient::RuleGroupsApi)
+    end
+  end
+
+  # unit tests for delete_rule_group
+  # Delete a rule group.
+  # Delete a rule group.
+  # @param id The ID of the rule group.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_rule_group test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for fire_rule_group
+  # Fire the rule group on your transactions.
+  # Fire the rule group on your transactions. Changes will be made by the rules in the rule group! Limit the result if you want to.
+  # @param id The ID of the rule group.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Date] :start A date formatted YYYY-MM-DD, to limit the transactions the actions will be applied to. Both the start date and the end date must be present. 
+  # @option opts [Date] :_end A date formatted YYYY-MM-DD, to limit the transactions the actions will be applied to. Both the start date and the end date must be present. 
+  # @option opts [String] :accounts Limit the testing of the rule group to these asset accounts. Only asset accounts will be accepted. Other types will be silently dropped. 
+  # @return [nil]
+  describe 'fire_rule_group test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_rule_group
+  # Get a single rule group.
+  # Get a single rule group. This does not include the rules. For that, see below.
+  # @param id The ID of the rule group.
+  # @param [Hash] opts the optional parameters
+  # @return [RuleGroupSingle]
+  describe 'get_rule_group test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_rule_by_group
+  # List rules in this rule group.
+  # List rules in this rule group.
+  # @param id The ID of the rule group.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50.
+  # @return [RuleArray]
+  describe 'list_rule_by_group test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_rule_group
+  # List all rule groups.
+  # List all rule groups.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50
+  # @return [RuleGroupArray]
+  describe 'list_rule_group test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for store_rule_group
+  # Store a new rule group.
+  # Creates a new rule group. The data required can be submitted as a JSON body or as a list of parameters.
+  # @param rule_group JSON array or key=value pairs with the necessary rule group information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [RuleGroupSingle]
+  describe 'store_rule_group test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for test_rule_group
+  # Test which transactions would be hit by the rule group. No changes will be made.
+  # Test which transactions would be hit by the rule group. No changes will be made. Limit the result if you want to.
+  # @param id The ID of the rule group.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50 items.
+  # @option opts [Date] :start A date formatted YYYY-MM-DD, to limit the transactions the test will be applied to. Both the start date and the end date must be present. 
+  # @option opts [Date] :_end A date formatted YYYY-MM-DD, to limit the transactions the test will be applied to. Both the start date and the end date must be present. 
+  # @option opts [Integer] :search_limit Maximum number of transactions Firefly III will try. Don't set this too high, or it will take Firefly III very long to run the test. I suggest a max of 200. 
+  # @option opts [Integer] :triggered_limit Maximum number of transactions the rule group can actually trigger on, before Firefly III stops. I would suggest setting this to 10 or 15. Don't go above the user's page size, because browsing to page 2 or 3 of a test result would fire the test again, making any navigation efforts very slow. 
+  # @option opts [String] :accounts Limit the testing of the rule group to these asset accounts. Only asset accounts will be accepted. Other types will be silently dropped. 
+  # @return [TransactionArray]
+  describe 'test_rule_group test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_rule_group
+  # Update existing rule group.
+  # Update existing rule group.
+  # @param id The ID of the rule group.
+  # @param rule_group JSON array with updated rule group information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [RuleGroupSingle]
+  describe 'update_rule_group test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end