firefly-iii-client 1.0.0

data/spec/api/currencies_api_spec.rb

@@ -0,0 +1,246 @@
+=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::CurrenciesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CurrenciesApi' do
+  before do
+    # run before each test
+    @api_instance = FireflyIIIClient::CurrenciesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CurrenciesApi' do
+    it 'should create an instance of CurrenciesApi' do
+      expect(@api_instance).to be_instance_of(FireflyIIIClient::CurrenciesApi)
+    end
+  end
+
+  # unit tests for default_currency
+  # Make currency default currency.
+  # Make this currency the default currency. If the currency is not enabled, it will be enabled as well.
+  # @param code The currency code.
+  # @param [Hash] opts the optional parameters
+  # @return [CurrencySingle]
+  describe 'default_currency 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 delete_currency
+  # Delete a currency.
+  # Delete a currency.
+  # @param code The currency code.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_currency 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 disable_currency
+  # Disable a currency.
+  # Disable a currency.
+  # @param code The currency code.
+  # @param [Hash] opts the optional parameters
+  # @return [CurrencySingle]
+  describe 'disable_currency 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 enable_currency
+  # Enable a single currency.
+  # Enable a single currency.
+  # @param code The currency code.
+  # @param [Hash] opts the optional parameters
+  # @return [CurrencySingle]
+  describe 'enable_currency 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_currency
+  # Get a single currency.
+  # Get a single currency.
+  # @param code The currency code.
+  # @param [Hash] opts the optional parameters
+  # @return [CurrencySingle]
+  describe 'get_currency 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_account_by_currency
+  # List all accounts with this currency.
+  # List all accounts with this currency.
+  # @param code The currency code.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50.
+  # @option opts [String] :date A date formatted YYYY-MM-DD. When added to the request, Firefly III will show the account's balance on that day. 
+  # @option opts [AccountTypeFilter] :type Optional filter on the account type(s) returned
+  # @return [AccountArray]
+  describe 'list_account_by_currency 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_available_budget_by_currency
+  # List all available budgets with this currency.
+  # List all available budgets with this currency.
+  # @param code The currency code.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50
+  # @return [AvailableBudgetArray]
+  describe 'list_available_budget_by_currency 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_bill_by_currency
+  # List all bills with this currency.
+  # List all bills with this currency.
+  # @param code The currency code.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50.
+  # @return [BillArray]
+  describe 'list_bill_by_currency 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_budget_limit_by_currency
+  # List all budget limits with this currency
+  # List all budget limits with this currency
+  # @param code The currency code.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50.
+  # @option opts [Date] :start Start date for the budget limit list.
+  # @option opts [Date] :_end End date for the budget limit list.
+  # @return [BudgetLimitArray]
+  describe 'list_budget_limit_by_currency 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_currency
+  # List all currencies.
+  # List all currencies.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50.
+  # @return [CurrencyArray]
+  describe 'list_currency 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_exchange_rate_by_currency
+  # List all known exchange rates with (from or to) this currency.
+  # List all known exchange rates.
+  # @param code The currency code.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50.
+  # @option opts [Date] :date The date of which you want to know the exchange rate 
+  # @option opts [Date] :start Use this instead of the date parameter to search for a range of currency exchange values. 
+  # @option opts [Date] :_end Use this instead of the date parameter to search for a range of currency exchange values. 
+  # @return [ExchangeRateArray]
+  describe 'list_exchange_rate_by_currency 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_by_currency
+  # List all recurring transactions with this currency.
+  # List all recurring transactions with this currency.
+  # @param code The currency code.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50.
+  # @return [RecurrenceArray]
+  describe 'list_recurrence_by_currency 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_currency
+  # List all rules with this currency.
+  # List all rules with this currency.
+  # @param code The currency code.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination per 50.
+  # @return [RuleArray]
+  describe 'list_rule_by_currency 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_currency
+  # List all transactions with this currency.
+  # List all transactions with this currency.
+  # @param code The currency code.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is per 50.
+  # @option opts [Date] :start_date A date formatted YYYY-MM-DD, to limit the list of transactions. 
+  # @option opts [Date] :end_date A date formatted YYYY-MM-DD, to limit the list of transactions. 
+  # @option opts [TransactionTypeFilter] :type Optional filter on the transaction type(s) returned
+  # @return [TransactionArray]
+  describe 'list_transaction_by_currency 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_currency
+  # Store a new currency
+  # Creates a new currency. The data required can be submitted as a JSON body or as a list of parameters.
+  # @param currency JSON array or key=value pairs with the necessary currency information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [CurrencySingle]
+  describe 'store_currency 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_currency
+  # Update existing currency.
+  # Update existing currency.
+  # @param code The currency code.
+  # @param currency JSON array with updated currency information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [CurrencySingle]
+  describe 'update_currency 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/currency_exchange_rates_api_spec.rb

@@ -0,0 +1,50 @@
+=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::CurrencyExchangeRatesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CurrencyExchangeRatesApi' do
+  before do
+    # run before each test
+    @api_instance = FireflyIIIClient::CurrencyExchangeRatesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CurrencyExchangeRatesApi' do
+    it 'should create an instance of CurrencyExchangeRatesApi' do
+      expect(@api_instance).to be_instance_of(FireflyIIIClient::CurrencyExchangeRatesApi)
+    end
+  end
+
+  # unit tests for get_exchange_rate
+  # Get an exchange rate.
+  # Get an exchange rate. If Firefly III doesn't know the rate it will set the rate to 1.0.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :from The source currency code. If omitted, defaults to EUR.
+  # @option opts [String] :to The destination currency code. If omitted, defaults to USD.
+  # @option opts [Date] :date The date you want to know the exchange rate on.
+  # @option opts [Float] :amount The amount in the source currency. If added, Firefly III will calculate the amount in the destination currency.
+  # @return [ExchangeRate]
+  describe 'get_exchange_rate 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/import_api_spec.rb

@@ -0,0 +1,75 @@
+=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::ImportApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ImportApi' do
+  before do
+    # run before each test
+    @api_instance = FireflyIIIClient::ImportApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ImportApi' do
+    it 'should create an instance of ImportApi' do
+      expect(@api_instance).to be_instance_of(FireflyIIIClient::ImportApi)
+    end
+  end
+
+  # unit tests for get_import
+  # Show info on a single import
+  # Show info on single import.
+  # @param key The job key of an import job.
+  # @param [Hash] opts the optional parameters
+  # @return [ImportJobSingle]
+  describe 'get_import 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_import
+  # List al imports
+  # List all imports
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is per 50 items.
+  # @return [ImportJobArray]
+  describe 'list_import 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_import
+  # List all transactions related to the import job. The correlation is made through the tag.
+  # See summary 
+  # @param key The key of the import job
+  # @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_import 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/links_api_spec.rb

@@ -0,0 +1,173 @@
+=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::LinksApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'LinksApi' do
+  before do
+    # run before each test
+    @api_instance = FireflyIIIClient::LinksApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of LinksApi' do
+    it 'should create an instance of LinksApi' do
+      expect(@api_instance).to be_instance_of(FireflyIIIClient::LinksApi)
+    end
+  end
+
+  # unit tests for delete_link_type
+  # Permanently delete link type.
+  # Will permanently delete a link type. The links between transactions will be removed. The transactions themselves remain. You cannot delete some of the system provided link types, indicated by the editable=false flag when you list it. 
+  # @param id The ID of the link type.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_link_type 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 delete_transaction_link
+  # Permanently delete link between transactions.
+  # Will permanently delete link. Transactions remain. 
+  # @param id The ID of the transaction link.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_transaction_link 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_link_type
+  # Get single a link type.
+  # Returns a single link type by its ID. 
+  # @param id The ID of the link type.
+  # @param [Hash] opts the optional parameters
+  # @return [LinkTypeSingle]
+  describe 'get_link_type 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_link
+  # Get a single link.
+  # Returns a single link by its ID. 
+  # @param id The ID of the transaction link.
+  # @param [Hash] opts the optional parameters
+  # @return [TransactionLinkSingle]
+  describe 'get_transaction_link 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_link_type
+  # List all types of links.
+  # List all the link types the system has. These include the default ones as well as any new ones. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50 items.
+  # @return [LinkTypeArray]
+  describe 'list_link_type 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_link_type
+  # List all transactions under this link type.
+  # List all transactions under this link type, both the inward and outward transactions. 
+  # @param id The ID of the link type.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is per 50 items.
+  # @option opts [Date] :start A date formatted YYYY-MM-DD, to limit the results. 
+  # @option opts [Date] :_end A date formatted YYYY-MM-DD, to limit the results. 
+  # @option opts [TransactionTypeFilter] :type Optional filter on the transaction type(s) returned.
+  # @return [TransactionArray]
+  describe 'list_transaction_by_link_type 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_link
+  # List all transaction links.
+  # List all the transaction links. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is per 50 items.
+  # @return [TransactionLinkArray]
+  describe 'list_transaction_link 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_link_type
+  # Create a new link type
+  # Creates a new link type. The data required can be submitted as a JSON body or as a list of parameters (in key=value pairs, like a webform).
+  # @param link_type JSON array with the necessary link type information or key=value pairs. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [LinkTypeSingle]
+  describe 'store_link_type 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_link
+  # Create a new link between transactions
+  # Store a new link between two transactions. For this end point you need the journal_id from a transaction.
+  # @param transaction_link JSON array with the necessary link type information or key=value pairs. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [TransactionLinkSingle]
+  describe 'store_transaction_link 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_link_type
+  # Update existing link type.
+  # Used to update a single link type. All fields that are not submitted will be cleared (set to NULL). The model will tell you which fields are mandatory. You cannot update some of the system provided link types, indicated by the editable=false flag when you list it. 
+  # @param id The ID of the link type.
+  # @param link_type JSON array or formdata with updated link type information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [LinkTypeSingle]
+  describe 'update_link_type 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_link
+  # Update an existing link between transactions.
+  # Used to update a single existing link. 
+  # @param id The ID of the transaction link.
+  # @param transaction_link JSON array or formdata with updated link type information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [TransactionLinkSingle]
+  describe 'update_transaction_link test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end