firefly-iii-client 1.0.0

data/lib/firefly_iii_client/version.rb

@@ -0,0 +1,15 @@
+=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
+
+module FireflyIIIClient
+  VERSION = '1.0.0'
+end

data/spec/api/about_api_spec.rb

@@ -0,0 +1,57 @@
+=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::AboutApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AboutApi' do
+  before do
+    # run before each test
+    @api_instance = FireflyIIIClient::AboutApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AboutApi' do
+    it 'should create an instance of AboutApi' do
+      expect(@api_instance).to be_instance_of(FireflyIIIClient::AboutApi)
+    end
+  end
+
+  # unit tests for get_about
+  # System information end point.
+  # Returns general system information and versions of the (supporting) software. 
+  # @param [Hash] opts the optional parameters
+  # @return [SystemInfo]
+  describe 'get_about 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_current_user
+  # Currently authenticated user endpoint.
+  # Returns the currently authenticated user. 
+  # @param [Hash] opts the optional parameters
+  # @return [UserSingle]
+  describe 'get_current_user 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/accounts_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::AccountsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AccountsApi' do
+  before do
+    # run before each test
+    @api_instance = FireflyIIIClient::AccountsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AccountsApi' do
+    it 'should create an instance of AccountsApi' do
+      expect(@api_instance).to be_instance_of(FireflyIIIClient::AccountsApi)
+    end
+  end
+
+  # unit tests for delete_account
+  # Permanently delete account.
+  # Will permanently delete an account. Any associated transactions and piggy banks are ALSO deleted. Cannot be recovered from. 
+  # @param id The ID of the account.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_account 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_account
+  # Get single account.
+  # Returns a single account by its ID. 
+  # @param id The ID of the account.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Date] :date A date formatted YYYY-MM-DD. When added to the request, Firefly III will show the account's balance on that day. 
+  # @return [AccountSingle]
+  describe 'get_account 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
+  # List all accounts.
+  # This endpoint returns a list of all the accounts owned by the authenticated user. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is per 50 items.
+  # @option opts [Date] :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 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_by_account
+  # List all piggy banks related to the account.
+  # This endpoint returns a list of all the piggy banks connected to the account. 
+  # @param id The ID of the account.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is per 50 items.
+  # @return [PiggyBankArray]
+  describe 'list_piggy_bank_by_account 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_account
+  # List all transactions related to the account.
+  # This endpoint returns a list of all the transactions connected to the account. 
+  # @param id The ID of the account.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is per 50 items.
+  # @option opts [Integer] :limit Limits the number of results on one page.
+  # @option opts [Date] :start A date formatted YYYY-MM-DD. 
+  # @option opts [Date] :_end A date formatted YYYY-MM-DD. 
+  # @option opts [TransactionTypeFilter] :type Optional filter on the transaction type(s) returned.
+  # @return [TransactionArray]
+  describe 'list_transaction_by_account 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_account
+  # Create new account.
+  # Creates a new account. The data required can be submitted as a JSON body or as a list of parameters (in key=value pairs, like a webform).
+  # @param account JSON array with the necessary account information or key=value pairs. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [AccountSingle]
+  describe 'store_account 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_account
+  # Update existing account.
+  # Used to update a single account. All fields that are not submitted will be cleared (set to NULL). The model will tell you which fields are mandatory. 
+  # @param id The ID of the account.
+  # @param account JSON array or formdata with updated account information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [AccountSingle]
+  describe 'update_account 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/attachments_api_spec.rb

@@ -0,0 +1,121 @@
+=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::AttachmentsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AttachmentsApi' do
+  before do
+    # run before each test
+    @api_instance = FireflyIIIClient::AttachmentsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AttachmentsApi' do
+    it 'should create an instance of AttachmentsApi' do
+      expect(@api_instance).to be_instance_of(FireflyIIIClient::AttachmentsApi)
+    end
+  end
+
+  # unit tests for delete_attachment
+  # Delete an attachment.
+  # With this endpoint you delete an attachment, including any stored file data. 
+  # @param id The ID of the single.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_attachment 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 download_attachment
+  # Download a single attachment.
+  # This endpoint allows you to download the binary content of a transaction. It will be sent to you as a download, using the content type \"application/octet-stream\" and content disposition \"attachment; filename=example.pdf\". 
+  # @param id The ID of the attachment.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'download_attachment 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_attachment
+  # Get a single attachment.
+  # Get a single attachment. This endpoint only returns the available metadata for the attachment. Actual file data is handled in two other endpoints (see below). 
+  # @param id The ID of the attachment.
+  # @param [Hash] opts the optional parameters
+  # @return [AttachmentSingle]
+  describe 'get_attachment 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
+  # List all attachments.
+  # This endpoint lists all attachments. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50.
+  # @return [AttachmentArray]
+  describe 'list_attachment 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_attachment
+  # Store a new attachment.
+  # Creates a new attachment. The data required can be submitted as a JSON body or as a list of parameters. You cannot use this endpoint to upload the actual file data (see below). This endpoint only creates the attachment object. 
+  # @param attachment JSON array or key=value pairs with the necessary attachment information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [AttachmentSingle]
+  describe 'store_attachment 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_attachment
+  # Update existing attachment.
+  # Update the meta data for an existing attachment. This endpoint does not allow you to upload or download data. For that, see below. 
+  # @param id The ID of the attachment.
+  # @param attachment JSON array with updated attachment information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [AttachmentSingle]
+  describe 'update_attachment 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 upload_attachment
+  # Upload an attachment.
+  # Use this endpoint to upload (and possible overwrite) the file contents of an attachment. Simply put the entire file in the body as binary data. 
+  # @param id The ID of the attachment.
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :body 
+  # @return [nil]
+  describe 'upload_attachment 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/available_budgets_api_spec.rb

@@ -0,0 +1,98 @@
+=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::AvailableBudgetsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AvailableBudgetsApi' do
+  before do
+    # run before each test
+    @api_instance = FireflyIIIClient::AvailableBudgetsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AvailableBudgetsApi' do
+    it 'should create an instance of AvailableBudgetsApi' do
+      expect(@api_instance).to be_instance_of(FireflyIIIClient::AvailableBudgetsApi)
+    end
+  end
+
+  # unit tests for delete_available_budget
+  # Delete an available budget.
+  # Delete an available budget. Not much more to say.
+  # @param id The ID of the available budget.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_available_budget 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_available_budget
+  # Get a single available budget.
+  # Get a single available budget, by ID.
+  # @param id The ID of the available budget.
+  # @param [Hash] opts the optional parameters
+  # @return [AvailableBudgetSingle]
+  describe 'get_available_budget 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
+  # List all available budget amounts.
+  # Firefly III allows users to set the amount that is available to be budgeted in so-called \"available budgets\". For example, the user could have 1200,- available to be divided during the coming month. This amount is used on the /budgets page. This endpoint returns all of these amounts and the periods for which they are set. 
+  # @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. 
+  # @option opts [Date] :_end A date formatted YYYY-MM-DD. 
+  # @return [AvailableBudgetArray]
+  describe 'list_available_budget 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_available_budget
+  # Store a new available budget
+  # Creates a new available budget for a specified period. The data required can be submitted as a JSON body or as a list of parameters. 
+  # @param available_budget JSON array or key=value pairs with the necessary available budget information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [AvailableBudgetSingle]
+  describe 'store_available_budget 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_available_budget
+  # Update existing available budget, to change for example the date range of the amount or the amount itself.
+  # Update existing available budget.
+  # @param id The ID of the object.X
+  # @param available_budget JSON array or form value with updated available budget information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [AvailableBudgetSingle]
+  describe 'update_available_budget 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/bills_api_spec.rb

@@ -0,0 +1,140 @@
+=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::BillsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'BillsApi' do
+  before do
+    # run before each test
+    @api_instance = FireflyIIIClient::BillsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of BillsApi' do
+    it 'should create an instance of BillsApi' do
+      expect(@api_instance).to be_instance_of(FireflyIIIClient::BillsApi)
+    end
+  end
+
+  # unit tests for delete_bill
+  # Delete a bill.
+  # Delete a bill. This will not delete any associated rules. Will not remove associated transactions. WILL remove all associated attachments.
+  # @param id The ID of the bill.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_bill 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_bill
+  # Get a single bill.
+  # Get a single bill.
+  # @param id The ID of the bill.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Date] :start A date formatted YYYY-MM-DD. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates. 
+  # @option opts [Date] :_end A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates. 
+  # @return [BillSingle]
+  describe 'get_bill 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_bill
+  # List all attachments uploaded to the bill.
+  # This endpoint will list all attachments linked to the bill.
+  # @param id The ID of the bill.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. The default pagination is 50.
+  # @return [AttachmentArray]
+  describe 'list_attachment_by_bill 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
+  # List all bills.
+  # This endpoint will list all the user's bills.
+  # @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. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates. 
+  # @option opts [Date] :_end A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates. 
+  # @return [BillArray]
+  describe 'list_bill 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_bill
+  # List all rules associated with the bill.
+  # This endpoint will list all rules that have an action to set the bill to this bill.
+  # @param id The ID of the bill.
+  # @param [Hash] opts the optional parameters
+  # @return [RuleArray]
+  describe 'list_rule_by_bill 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_bill
+  # List all transactions associated with the  bill.
+  # This endpoint will list all transactions linked to this bill.
+  # @param id The ID of the bill.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Date] :start A date formatted YYYY-MM-DD. 
+  # @option opts [Date] :_end A date formatted YYYY-MM-DD. 
+  # @option opts [TransactionTypeFilter] :type Optional filter on the transaction type(s) returned
+  # @return [TransactionArray]
+  describe 'list_transaction_by_bill 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_bill
+  # Store a new bill
+  # Creates a new bill. The data required can be submitted as a JSON body or as a list of parameters.
+  # @param bill JSON array or key=value pairs with the necessary bill information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [BillSingle]
+  describe 'store_bill 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_bill
+  # Update existing bill.
+  # Update existing bill.
+  # @param id The ID of the bill.
+  # @param bill JSON array or key=value pairs with updated bill information. See the model for the exact specifications.
+  # @param [Hash] opts the optional parameters
+  # @return [BillSingle]
+  describe 'update_bill test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end