firefly-iii-client 1.0.0

data/spec/api/rules_api_spec.rb

@@ -0,0 +1,129 @@
+=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::RulesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'RulesApi' do
+  before do
+    # run before each test
+    @api_instance = FireflyIIIClient::RulesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RulesApi' do
+    it 'should create an instance of RulesApi' do
+      expect(@api_instance).to be_instance_of(FireflyIIIClient::RulesApi)
+    end
+  end
+
+  # unit tests for delete_rule
+  # Delete an rule.
+  # Delete an rule.
+  # @param id The ID of the rule.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_rule 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
+  # Fire the rule on your transactions.
+  # Fire the rule group on your transactions. Changes will be made by the rules in the group! Limit the result if you want to.
+  # @param id The ID of the rule.
+  # @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 to these asset accounts. Only asset accounts will be accepted. Other types will be silently dropped. 
+  # @return [nil]
+  describe 'fire_rule 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
+  # Get a single rule.
+  # Get a single rule.
+  # @param id The ID of the object.X
+  # @param [Hash] opts the optional parameters
+  # @return [RuleSingle]
+  describe 'get_rule 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
+  # List all rules.
+  # List all rules.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50.
+  # @return [RuleArray]
+  describe 'list_rule 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
+  # Store a new rule
+  # Creates a new rule. The data required can be submitted as a JSON body or as a list of parameters.
+  # @param rule JSON array or key=value pairs with the necessary rule information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [RuleSingle]
+  describe 'store_rule 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
+  # Test which transactions would be hit by the rule. No changes will be made.
+  # Test which transactions would be hit by the rule. No changes will be made. Limit the result if you want to.
+  # @param id The ID of the rule.
+  # @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 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 to these asset accounts. Only asset accounts will be accepted. Other types will be silently dropped. 
+  # @return [TransactionArray]
+  describe 'test_rule 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
+  # Update existing rule.
+  # Update existing rule.
+  # @param id The ID of the object.X
+  # @param rule JSON array with updated rule information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [RuleSingle]
+  describe 'update_rule 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/summary_api_spec.rb

@@ -0,0 +1,49 @@
+=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::SummaryApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SummaryApi' do
+  before do
+    # run before each test
+    @api_instance = FireflyIIIClient::SummaryApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SummaryApi' do
+    it 'should create an instance of SummaryApi' do
+      expect(@api_instance).to be_instance_of(FireflyIIIClient::SummaryApi)
+    end
+  end
+
+  # unit tests for get_basic_summary
+  # 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. 
+  # @param start A date formatted YYYY-MM-DD. 
+  # @param _end A date formatted YYYY-MM-DD. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :currency_code A currency code like EUR or USD, to filter the result. 
+  # @return [Array<BasicSummaryEntry>]
+  describe 'get_basic_summary 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/tags_api_spec.rb

@@ -0,0 +1,126 @@
+=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::TagsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'TagsApi' do
+  before do
+    # run before each test
+    @api_instance = FireflyIIIClient::TagsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TagsApi' do
+    it 'should create an instance of TagsApi' do
+      expect(@api_instance).to be_instance_of(FireflyIIIClient::TagsApi)
+    end
+  end
+
+  # unit tests for delete_tag
+  # Delete an tag.
+  # Delete an tag.
+  # @param tag Either the tag itself or the tag ID.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_tag 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_tag
+  # Get a single tag.
+  # Get a single tag.
+  # @param tag Either the tag itself or the tag ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number
+  # @return [TagSingle]
+  describe 'get_tag 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_tag_cloud
+  # Returns a basic tag cloud.
+  # Returns a list of tags, which can be used to draw a basic tag cloud.
+  # @param start A date formatted YYYY-MM-DD. 
+  # @param _end A date formatted YYYY-MM-DD. 
+  # @param [Hash] opts the optional parameters
+  # @return [TagCloud]
+  describe 'get_tag_cloud 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_tag
+  # List all tags.
+  # List all of the user's tags.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number
+  # @return [TagArray]
+  describe 'list_tag 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_tag
+  # List all transactions with this tag.
+  # List all transactions with this tag.
+  # @param tag Either the tag itself or the tag ID.
+  # @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. This is the start date of the selected range (inclusive). 
+  # @option opts [Date] :_end A date formatted YYYY-MM-DD. This is the end date of the selected range (inclusive). 
+  # @option opts [TransactionTypeFilter] :type Optional filter on the transaction type(s) returned.
+  # @return [TransactionArray]
+  describe 'list_transaction_by_tag 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_tag
+  # Store a new tag
+  # Creates a new tag. The data required can be submitted as a JSON body or as a list of parameters.
+  # @param tag_model JSON array or key=value pairs with the necessary tag information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [TagSingle]
+  describe 'store_tag 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_tag
+  # Update existing tag.
+  # Update existing tag.
+  # @param tag Either the tag itself or the tag ID.
+  # @param tag_model JSON array with updated tag information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [TagSingle]
+  describe 'update_tag 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/transactions_api_spec.rb

@@ -0,0 +1,137 @@
+=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::TransactionsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'TransactionsApi' do
+  before do
+    # run before each test
+    @api_instance = FireflyIIIClient::TransactionsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TransactionsApi' do
+    it 'should create an instance of TransactionsApi' do
+      expect(@api_instance).to be_instance_of(FireflyIIIClient::TransactionsApi)
+    end
+  end
+
+  # unit tests for delete_transaction
+  # Delete a transaction.
+  # Delete a transaction.
+  # @param id The ID of the transaction.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_transaction 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_transaction
+  # Get a single transaction.
+  # Get a single transaction.
+  # @param id The ID of the transaction.
+  # @param [Hash] opts the optional parameters
+  # @return [TransactionSingle]
+  describe 'get_transaction 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_transaction_by_journal
+  # Get a single transaction, based on one of the underlying transaction journals.
+  # Get a single transaction by underlying journal.
+  # @param id The ID of the transaction journal.
+  # @param [Hash] opts the optional parameters
+  # @return [TransactionSingle]
+  describe 'get_transaction_by_journal 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_attachment_by_transaction
+  # Lists all attachments.
+  # Lists all attachments.
+  # @param id The ID of the transaction.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50.
+  # @return [AttachmentArray]
+  describe 'list_attachment_by_transaction 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_transaction
+  # Lists all piggy bank events.
+  # Lists all piggy bank events.
+  # @param id The ID of the transaction.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50.
+  # @return [PiggyBankEventArray]
+  describe 'list_event_by_transaction 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
+  # List all the user's transactions. 
+  # List all the user's transactions.
+  # @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. This is the start date of the selected range (inclusive). 
+  # @option opts [Date] :_end A date formatted YYYY-MM-DD. This is the end date of the selected range (inclusive). 
+  # @option opts [TransactionTypeFilter] :type Optional filter on the transaction type(s) returned.
+  # @return [TransactionArray]
+  describe 'list_transaction 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_transaction
+  # Store a new transaction
+  # Creates a new transaction. The data required can be submitted as a JSON body or as a list of parameters.
+  # @param transaction JSON array or key=value pairs with the necessary transaction information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [TransactionSingle]
+  describe 'store_transaction 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_transaction
+  # Update existing transaction.
+  # Update an existing transaction.
+  # @param id The ID of the transaction.
+  # @param transaction JSON array with updated transaction information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [TransactionSingle]
+  describe 'update_transaction 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/users_api_spec.rb

@@ -0,0 +1,96 @@
+=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::UsersApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'UsersApi' do
+  before do
+    # run before each test
+    @api_instance = FireflyIIIClient::UsersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UsersApi' do
+    it 'should create an instance of UsersApi' do
+      expect(@api_instance).to be_instance_of(FireflyIIIClient::UsersApi)
+    end
+  end
+
+  # unit tests for delete_user
+  # Delete a user.
+  # Delete a user. You cannot delete the current user.
+  # @param id The user ID.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_user 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_user
+  # Get a single user.
+  # Gets all info of a single user.
+  # @param id The user ID.
+  # @param [Hash] opts the optional parameters
+  # @return [UserSingle]
+  describe 'get_user 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_user
+  # List all users.
+  # List all the users in this instance of Firefly III.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page The page number, if necessary. The default pagination is 50, so 50 users per page.
+  # @return [UserArray]
+  describe 'list_user 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_user
+  # Store a new user
+  # Creates a new user. The data required can be submitted as a JSON body or as a list of parameters. The user will be given a random password, which they can reset using the \"forgot password\" function. 
+  # @param user JSON array or key=value pairs with the necessary user information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [UserSingle]
+  describe 'store_user 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_user
+  # Update an existing user's information.
+  # Update existing user.
+  # @param id The user ID.
+  # @param user JSON array with updated user information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [UserSingle]
+  describe 'update_user test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end