Module: FireflyIIIClient

Defined in:
lib/firefly_iii_client/version.rb,
lib/firefly_iii_client.rb,
lib/firefly_iii_client/api_error.rb,
lib/firefly_iii_client/api_client.rb,
lib/firefly_iii_client/models/bill.rb,
lib/firefly_iii_client/models/meta.rb,
lib/firefly_iii_client/models/rule.rb,
lib/firefly_iii_client/models/user.rb,
lib/firefly_iii_client/api/tags_api.rb,
lib/firefly_iii_client/api/about_api.rb,
lib/firefly_iii_client/api/bills_api.rb,
lib/firefly_iii_client/api/links_api.rb,
lib/firefly_iii_client/api/rules_api.rb,
lib/firefly_iii_client/api/users_api.rb,
lib/firefly_iii_client/configuration.rb,
lib/firefly_iii_client/models/budget.rb,
lib/firefly_iii_client/api/charts_api.rb,
lib/firefly_iii_client/api/import_api.rb,
lib/firefly_iii_client/models/account.rb,
lib/firefly_iii_client/api/budgets_api.rb,
lib/firefly_iii_client/api/summary_api.rb,
lib/firefly_iii_client/models/category.rb,
lib/firefly_iii_client/models/currency.rb,
lib/firefly_iii_client/models/tag_read.rb,
lib/firefly_iii_client/api/accounts_api.rb,
lib/firefly_iii_client/models/bill_read.rb,
lib/firefly_iii_client/models/link_type.rb,
lib/firefly_iii_client/models/page_link.rb,
lib/firefly_iii_client/models/rule_read.rb,
lib/firefly_iii_client/models/tag_array.rb,
lib/firefly_iii_client/models/tag_cloud.rb,
lib/firefly_iii_client/models/tag_model.rb,
lib/firefly_iii_client/models/user_read.rb,
lib/firefly_iii_client/models/attachment.rb,
lib/firefly_iii_client/models/bill_array.rb,
lib/firefly_iii_client/models/import_job.rb,
lib/firefly_iii_client/models/piggy_bank.rb,
lib/firefly_iii_client/models/preference.rb,
lib/firefly_iii_client/models/recurrence.rb,
lib/firefly_iii_client/models/rule_array.rb,
lib/firefly_iii_client/models/rule_group.rb,
lib/firefly_iii_client/models/tag_single.rb,
lib/firefly_iii_client/models/user_array.rb,
lib/firefly_iii_client/api/categories_api.rb,
lib/firefly_iii_client/api/currencies_api.rb,
lib/firefly_iii_client/models/bill_single.rb,
lib/firefly_iii_client/models/budget_read.rb,
lib/firefly_iii_client/models/object_link.rb,
lib/firefly_iii_client/models/rule_action.rb,
lib/firefly_iii_client/models/rule_single.rb,
lib/firefly_iii_client/models/system_info.rb,
lib/firefly_iii_client/models/transaction.rb,
lib/firefly_iii_client/models/user_single.rb,
lib/firefly_iii_client/api/attachments_api.rb,
lib/firefly_iii_client/api/piggy_banks_api.rb,
lib/firefly_iii_client/api/preferences_api.rb,
lib/firefly_iii_client/api/recurrences_api.rb,
lib/firefly_iii_client/api/rule_groups_api.rb,
lib/firefly_iii_client/models/account_read.rb,
lib/firefly_iii_client/models/budget_array.rb,
lib/firefly_iii_client/models/budget_limit.rb,
lib/firefly_iii_client/models/budget_spent.rb,
lib/firefly_iii_client/models/object_link0.rb,
lib/firefly_iii_client/models/rule_trigger.rb,
lib/firefly_iii_client/api/transactions_api.rb,
lib/firefly_iii_client/models/account_array.rb,
lib/firefly_iii_client/models/budget_single.rb,
lib/firefly_iii_client/models/category_read.rb,
lib/firefly_iii_client/models/currency_read.rb,
lib/firefly_iii_client/models/exchange_rate.rb,
lib/firefly_iii_client/models/tag_cloud_tag.rb,
lib/firefly_iii_client/api/configuration_api.rb,
lib/firefly_iii_client/models/account_single.rb,
lib/firefly_iii_client/models/category_array.rb,
lib/firefly_iii_client/models/category_spent.rb,
lib/firefly_iii_client/models/chart_data_set.rb,
lib/firefly_iii_client/models/currency_array.rb,
lib/firefly_iii_client/models/link_type_read.rb,
lib/firefly_iii_client/models/attachment_read.rb,
lib/firefly_iii_client/models/bill_paid_dates.rb,
lib/firefly_iii_client/models/category_earned.rb,
lib/firefly_iii_client/models/category_single.rb,
lib/firefly_iii_client/models/currency_single.rb,
lib/firefly_iii_client/models/link_type_array.rb,
lib/firefly_iii_client/models/meta_pagination.rb,
lib/firefly_iii_client/models/piggy_bank_read.rb,
lib/firefly_iii_client/models/preference_read.rb,
lib/firefly_iii_client/models/recurrence_read.rb,
lib/firefly_iii_client/models/rule_group_read.rb,
lib/firefly_iii_client/models/attachment_array.rb,
lib/firefly_iii_client/models/available_budget.rb,
lib/firefly_iii_client/models/chart_data_point.rb,
lib/firefly_iii_client/models/import_job_array.rb,
lib/firefly_iii_client/models/link_type_single.rb,
lib/firefly_iii_client/models/piggy_bank_array.rb,
lib/firefly_iii_client/models/piggy_bank_event.rb,
lib/firefly_iii_client/models/preference_array.rb,
lib/firefly_iii_client/models/recurrence_array.rb,
lib/firefly_iii_client/models/rule_group_array.rb,
lib/firefly_iii_client/models/system_info_data.rb,
lib/firefly_iii_client/models/transaction_link.rb,
lib/firefly_iii_client/models/transaction_read.rb,
lib/firefly_iii_client/models/validation_error.rb,
lib/firefly_iii_client/models/attachment_single.rb,
lib/firefly_iii_client/models/budget_limit_read.rb,
lib/firefly_iii_client/models/import_job_single.rb,
lib/firefly_iii_client/models/piggy_bank_single.rb,
lib/firefly_iii_client/models/preference_single.rb,
lib/firefly_iii_client/models/recurrence_single.rb,
lib/firefly_iii_client/models/rule_group_single.rb,
lib/firefly_iii_client/models/transaction_array.rb,
lib/firefly_iii_client/models/transaction_split.rb,
lib/firefly_iii_client/api/available_budgets_api.rb,
lib/firefly_iii_client/models/budget_limit_array.rb,
lib/firefly_iii_client/models/transaction_single.rb,
lib/firefly_iii_client/models/account_type_filter.rb,
lib/firefly_iii_client/models/basic_summary_entry.rb,
lib/firefly_iii_client/models/budget_limit_single.rb,
lib/firefly_iii_client/models/exchange_rate_array.rb,
lib/firefly_iii_client/models/configuration_update.rb,
lib/firefly_iii_client/models/system_configuration.rb,
lib/firefly_iii_client/models/account_type_property.rb,
lib/firefly_iii_client/models/available_budget_read.rb,
lib/firefly_iii_client/models/import_job_attributes.rb,
lib/firefly_iii_client/models/recurrence_repetition.rb,
lib/firefly_iii_client/models/transaction_link_read.rb,
lib/firefly_iii_client/models/available_budget_array.rb,
lib/firefly_iii_client/models/piggy_bank_event_array.rb,
lib/firefly_iii_client/models/recurrence_transaction.rb,
lib/firefly_iii_client/models/transaction_link_array.rb,
lib/firefly_iii_client/models/available_budget_single.rb,
lib/firefly_iii_client/models/transaction_link_single.rb,
lib/firefly_iii_client/models/transaction_type_filter.rb,
lib/firefly_iii_client/models/validation_error_errors.rb,
lib/firefly_iii_client/api/currency_exchange_rates_api.rb,
lib/firefly_iii_client/models/exchange_rate_attributes.rb,
lib/firefly_iii_client/models/system_configuration_data.rb,
lib/firefly_iii_client/models/piggy_bank_event_attributes.rb

Overview

#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: [email protected] Generated by: openapi-generator.tech OpenAPI Generator version: 5.1.0-SNAPSHOT

Defined Under Namespace

Classes: AboutApi, Account, AccountArray, AccountRead, AccountSingle, AccountTypeFilter, AccountTypeProperty, AccountsApi, ApiClient, ApiError, Attachment, AttachmentArray, AttachmentRead, AttachmentSingle, AttachmentsApi, AvailableBudget, AvailableBudgetArray, AvailableBudgetRead, AvailableBudgetSingle, AvailableBudgetsApi, BasicSummaryEntry, Bill, BillArray, BillPaidDates, BillRead, BillSingle, BillsApi, Budget, BudgetArray, BudgetLimit, BudgetLimitArray, BudgetLimitRead, BudgetLimitSingle, BudgetRead, BudgetSingle, BudgetSpent, BudgetsApi, CategoriesApi, Category, CategoryArray, CategoryEarned, CategoryRead, CategorySingle, CategorySpent, ChartDataPoint, ChartDataSet, ChartsApi, Configuration, ConfigurationApi, ConfigurationUpdate, CurrenciesApi, Currency, CurrencyArray, CurrencyExchangeRatesApi, CurrencyRead, CurrencySingle, ExchangeRate, ExchangeRateArray, ExchangeRateAttributes, ImportApi, ImportJob, ImportJobArray, ImportJobAttributes, ImportJobSingle, LinkType, LinkTypeArray, LinkTypeRead, LinkTypeSingle, LinksApi, Meta, MetaPagination, ObjectLink, ObjectLink0, PageLink, PiggyBank, PiggyBankArray, PiggyBankEvent, PiggyBankEventArray, PiggyBankEventAttributes, PiggyBankRead, PiggyBankSingle, PiggyBanksApi, Preference, PreferenceArray, PreferenceRead, PreferenceSingle, PreferencesApi, Recurrence, RecurrenceArray, RecurrenceRead, RecurrenceRepetition, RecurrenceSingle, RecurrenceTransaction, RecurrencesApi, Rule, RuleAction, RuleArray, RuleGroup, RuleGroupArray, RuleGroupRead, RuleGroupSingle, RuleGroupsApi, RuleRead, RuleSingle, RuleTrigger, RulesApi, SummaryApi, SystemConfiguration, SystemConfigurationData, SystemInfo, SystemInfoData, TagArray, TagCloud, TagCloudTag, TagModel, TagRead, TagSingle, TagsApi, Transaction, TransactionArray, TransactionLink, TransactionLinkArray, TransactionLinkRead, TransactionLinkSingle, TransactionRead, TransactionSingle, TransactionSplit, TransactionTypeFilter, TransactionsApi, User, UserArray, UserRead, UserSingle, UsersApi, ValidationError, ValidationErrorErrors

Constant Summary collapse

VERSION = 
'1.0.2'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

FireflyIIIClient.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



164
165
166
167
168
169
170
 
# File 'lib/firefly_iii_client.rb', line 164

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end