firefly-iii-client 1.0.0

data/docs/ValidationError.md

@@ -0,0 +1,20 @@
+# OpenapiClient::ValidationError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+| **errors** | [**ValidationErrorErrors**](ValidationErrorErrors.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::ValidationError.new(
+  message: The given data was invalid.,
+                              errors: null
+)
+```
+

data/docs/ValidationErrorErrors.md

@@ -0,0 +1,20 @@
+# OpenapiClient::ValidationErrorErrors
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field1** | **Array<String>** |  | [optional] |
+| **field2** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'firefly_iii_client'
+
+instance = FireflyIIIClient::ValidationErrorErrors.new(
+  field1: null,
+  field2: null
+)
+```
+

data/firefly-iii-client.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=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
+
+$:.push File.expand_path("../lib", __FILE__)
+require "firefly_iii_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "firefly-iii-client"
+  s.version     = FireflyIIIClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kerri Salciccioli"]
+  s.email       = ["kerri@salciccio.li"]
+#  s.homepage    = "https://openapi-generator.tech"
+  s.summary     = "Firefly III API Ruby Gem"
+  s.description = "Client for Firefly III API - Generated using https://github.com/OpenAPITools/openapi-generator "
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 2.4"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  puts s.files
+#s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/git_push.sh

@@ -0,0 +1,58 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/firefly_iii_client.rb

@@ -0,0 +1,172 @@
+=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
+
+# Common files
+require 'firefly_iii_client/api_client'
+require 'firefly_iii_client/api_error'
+require 'firefly_iii_client/version'
+require 'firefly_iii_client/configuration'
+
+# Models
+require 'firefly_iii_client/models/account'
+require 'firefly_iii_client/models/account_array'
+require 'firefly_iii_client/models/account_read'
+require 'firefly_iii_client/models/account_single'
+require 'firefly_iii_client/models/account_type_filter'
+require 'firefly_iii_client/models/account_type_property'
+require 'firefly_iii_client/models/attachment'
+require 'firefly_iii_client/models/attachment_array'
+require 'firefly_iii_client/models/attachment_read'
+require 'firefly_iii_client/models/attachment_single'
+require 'firefly_iii_client/models/available_budget'
+require 'firefly_iii_client/models/available_budget_array'
+require 'firefly_iii_client/models/available_budget_read'
+require 'firefly_iii_client/models/available_budget_single'
+require 'firefly_iii_client/models/basic_summary_entry'
+require 'firefly_iii_client/models/bill'
+require 'firefly_iii_client/models/bill_array'
+require 'firefly_iii_client/models/bill_paid_dates'
+require 'firefly_iii_client/models/bill_read'
+require 'firefly_iii_client/models/bill_single'
+require 'firefly_iii_client/models/budget'
+require 'firefly_iii_client/models/budget_array'
+require 'firefly_iii_client/models/budget_limit'
+require 'firefly_iii_client/models/budget_limit_array'
+require 'firefly_iii_client/models/budget_limit_read'
+require 'firefly_iii_client/models/budget_limit_single'
+require 'firefly_iii_client/models/budget_read'
+require 'firefly_iii_client/models/budget_single'
+require 'firefly_iii_client/models/budget_spent'
+require 'firefly_iii_client/models/category'
+require 'firefly_iii_client/models/category_array'
+require 'firefly_iii_client/models/category_earned'
+require 'firefly_iii_client/models/category_read'
+require 'firefly_iii_client/models/category_single'
+require 'firefly_iii_client/models/category_spent'
+require 'firefly_iii_client/models/chart_data_point'
+require 'firefly_iii_client/models/chart_data_set'
+require 'firefly_iii_client/models/configuration_update'
+require 'firefly_iii_client/models/currency'
+require 'firefly_iii_client/models/currency_array'
+require 'firefly_iii_client/models/currency_read'
+require 'firefly_iii_client/models/currency_single'
+require 'firefly_iii_client/models/exchange_rate'
+require 'firefly_iii_client/models/exchange_rate_array'
+require 'firefly_iii_client/models/exchange_rate_attributes'
+require 'firefly_iii_client/models/import_job'
+require 'firefly_iii_client/models/import_job_array'
+require 'firefly_iii_client/models/import_job_attributes'
+require 'firefly_iii_client/models/import_job_single'
+require 'firefly_iii_client/models/link_type'
+require 'firefly_iii_client/models/link_type_array'
+require 'firefly_iii_client/models/link_type_read'
+require 'firefly_iii_client/models/link_type_single'
+require 'firefly_iii_client/models/meta'
+require 'firefly_iii_client/models/meta_pagination'
+require 'firefly_iii_client/models/object_link'
+require 'firefly_iii_client/models/object_link0'
+require 'firefly_iii_client/models/page_link'
+require 'firefly_iii_client/models/piggy_bank'
+require 'firefly_iii_client/models/piggy_bank_array'
+require 'firefly_iii_client/models/piggy_bank_event'
+require 'firefly_iii_client/models/piggy_bank_event_array'
+require 'firefly_iii_client/models/piggy_bank_event_attributes'
+require 'firefly_iii_client/models/piggy_bank_read'
+require 'firefly_iii_client/models/piggy_bank_single'
+require 'firefly_iii_client/models/preference'
+require 'firefly_iii_client/models/preference_array'
+require 'firefly_iii_client/models/preference_read'
+require 'firefly_iii_client/models/preference_single'
+require 'firefly_iii_client/models/recurrence'
+require 'firefly_iii_client/models/recurrence_array'
+require 'firefly_iii_client/models/recurrence_read'
+require 'firefly_iii_client/models/recurrence_repetition'
+require 'firefly_iii_client/models/recurrence_single'
+require 'firefly_iii_client/models/recurrence_transaction'
+require 'firefly_iii_client/models/rule'
+require 'firefly_iii_client/models/rule_action'
+require 'firefly_iii_client/models/rule_array'
+require 'firefly_iii_client/models/rule_group'
+require 'firefly_iii_client/models/rule_group_array'
+require 'firefly_iii_client/models/rule_group_read'
+require 'firefly_iii_client/models/rule_group_single'
+require 'firefly_iii_client/models/rule_read'
+require 'firefly_iii_client/models/rule_single'
+require 'firefly_iii_client/models/rule_trigger'
+require 'firefly_iii_client/models/system_configuration'
+require 'firefly_iii_client/models/system_configuration_data'
+require 'firefly_iii_client/models/system_info'
+require 'firefly_iii_client/models/system_info_data'
+require 'firefly_iii_client/models/tag_array'
+require 'firefly_iii_client/models/tag_cloud'
+require 'firefly_iii_client/models/tag_cloud_tag'
+require 'firefly_iii_client/models/tag_model'
+require 'firefly_iii_client/models/tag_read'
+require 'firefly_iii_client/models/tag_single'
+require 'firefly_iii_client/models/transaction'
+require 'firefly_iii_client/models/transaction_array'
+require 'firefly_iii_client/models/transaction_link'
+require 'firefly_iii_client/models/transaction_link_array'
+require 'firefly_iii_client/models/transaction_link_read'
+require 'firefly_iii_client/models/transaction_link_single'
+require 'firefly_iii_client/models/transaction_read'
+require 'firefly_iii_client/models/transaction_single'
+require 'firefly_iii_client/models/transaction_split'
+require 'firefly_iii_client/models/transaction_type_filter'
+require 'firefly_iii_client/models/user'
+require 'firefly_iii_client/models/user_array'
+require 'firefly_iii_client/models/user_read'
+require 'firefly_iii_client/models/user_single'
+require 'firefly_iii_client/models/validation_error'
+require 'firefly_iii_client/models/validation_error_errors'
+
+# APIs
+require 'firefly_iii_client/api/about_api'
+require 'firefly_iii_client/api/accounts_api'
+require 'firefly_iii_client/api/attachments_api'
+require 'firefly_iii_client/api/available_budgets_api'
+require 'firefly_iii_client/api/bills_api'
+require 'firefly_iii_client/api/budgets_api'
+require 'firefly_iii_client/api/categories_api'
+require 'firefly_iii_client/api/charts_api'
+require 'firefly_iii_client/api/configuration_api'
+require 'firefly_iii_client/api/currencies_api'
+require 'firefly_iii_client/api/currency_exchange_rates_api'
+require 'firefly_iii_client/api/import_api'
+require 'firefly_iii_client/api/links_api'
+require 'firefly_iii_client/api/piggy_banks_api'
+require 'firefly_iii_client/api/preferences_api'
+require 'firefly_iii_client/api/recurrences_api'
+require 'firefly_iii_client/api/rule_groups_api'
+require 'firefly_iii_client/api/rules_api'
+require 'firefly_iii_client/api/summary_api'
+require 'firefly_iii_client/api/tags_api'
+require 'firefly_iii_client/api/transactions_api'
+require 'firefly_iii_client/api/users_api'
+
+module FireflyIIIClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   OpenapiClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/firefly_iii_client/api/about_api.rb

@@ -0,0 +1,136 @@
+=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 'cgi'
+
+module FireflyIIIClient
+  class AboutApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # System information end point.
+    # Returns general system information and versions of the (supporting) software. 
+    # @param [Hash] opts the optional parameters
+    # @return [SystemInfo]
+    def get_about(opts = {})
+      data, _status_code, _headers = get_about_with_http_info(opts)
+      data
+    end
+
+    # System information end point.
+    # Returns general system information and versions of the (supporting) software. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SystemInfo, Integer, Hash)>] SystemInfo data, response status code and response headers
+    def get_about_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AboutApi.get_about ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/about'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SystemInfo'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
+
+      new_options = opts.merge(
+        :operation => :"AboutApi.get_about",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AboutApi#get_about\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Currently authenticated user endpoint.
+    # Returns the currently authenticated user. 
+    # @param [Hash] opts the optional parameters
+    # @return [UserSingle]
+    def get_current_user(opts = {})
+      data, _status_code, _headers = get_current_user_with_http_info(opts)
+      data
+    end
+
+    # Currently authenticated user endpoint.
+    # Returns the currently authenticated user. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UserSingle, Integer, Hash)>] UserSingle data, response status code and response headers
+    def get_current_user_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AboutApi.get_current_user ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/about/user'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UserSingle'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
+
+      new_options = opts.merge(
+        :operation => :"AboutApi.get_current_user",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AboutApi#get_current_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end