firefly-iii-client 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +349 -0
- data/Rakefile +10 -0
- data/docs/AboutApi.md +143 -0
- data/docs/Account.md +70 -0
- data/docs/AccountArray.md +20 -0
- data/docs/AccountRead.md +22 -0
- data/docs/AccountSingle.md +18 -0
- data/docs/AccountTypeFilter.md +15 -0
- data/docs/AccountTypeProperty.md +15 -0
- data/docs/AccountsApi.md +531 -0
- data/docs/Attachment.md +44 -0
- data/docs/AttachmentArray.md +20 -0
- data/docs/AttachmentRead.md +24 -0
- data/docs/AttachmentSingle.md +18 -0
- data/docs/AttachmentsApi.md +510 -0
- data/docs/AvailableBudget.md +38 -0
- data/docs/AvailableBudgetArray.md +20 -0
- data/docs/AvailableBudgetRead.md +22 -0
- data/docs/AvailableBudgetSingle.md +18 -0
- data/docs/AvailableBudgetsApi.md +369 -0
- data/docs/BasicSummaryEntry.md +36 -0
- data/docs/Bill.md +50 -0
- data/docs/BillArray.md +20 -0
- data/docs/BillPaidDates.md +22 -0
- data/docs/BillRead.md +22 -0
- data/docs/BillSingle.md +18 -0
- data/docs/BillsApi.md +600 -0
- data/docs/Budget.md +28 -0
- data/docs/BudgetArray.md +20 -0
- data/docs/BudgetLimit.md +38 -0
- data/docs/BudgetLimitArray.md +20 -0
- data/docs/BudgetLimitRead.md +22 -0
- data/docs/BudgetLimitSingle.md +18 -0
- data/docs/BudgetRead.md +22 -0
- data/docs/BudgetSingle.md +18 -0
- data/docs/BudgetSpent.md +26 -0
- data/docs/BudgetsApi.md +897 -0
- data/docs/CategoriesApi.md +446 -0
- data/docs/Category.md +26 -0
- data/docs/CategoryArray.md +20 -0
- data/docs/CategoryEarned.md +30 -0
- data/docs/CategoryRead.md +22 -0
- data/docs/CategorySingle.md +18 -0
- data/docs/CategorySpent.md +30 -0
- data/docs/ChartDataPoint.md +18 -0
- data/docs/ChartDataSet.md +32 -0
- data/docs/ChartsApi.md +374 -0
- data/docs/ConfigurationApi.md +148 -0
- data/docs/ConfigurationUpdate.md +18 -0
- data/docs/CurrenciesApi.md +1198 -0
- data/docs/Currency.md +32 -0
- data/docs/CurrencyArray.md +22 -0
- data/docs/CurrencyExchangeRatesApi.md +86 -0
- data/docs/CurrencyRead.md +22 -0
- data/docs/CurrencySingle.md +18 -0
- data/docs/ExchangeRate.md +22 -0
- data/docs/ExchangeRateArray.md +22 -0
- data/docs/ExchangeRateAttributes.md +44 -0
- data/docs/ImportApi.md +232 -0
- data/docs/ImportJob.md +22 -0
- data/docs/ImportJobArray.md +22 -0
- data/docs/ImportJobAttributes.md +42 -0
- data/docs/ImportJobSingle.md +18 -0
- data/docs/LinkType.md +26 -0
- data/docs/LinkTypeArray.md +22 -0
- data/docs/LinkTypeRead.md +24 -0
- data/docs/LinkTypeSingle.md +18 -0
- data/docs/LinksApi.md +804 -0
- data/docs/Meta.md +18 -0
- data/docs/MetaPagination.md +26 -0
- data/docs/ObjectLink.md +20 -0
- data/docs/ObjectLink0.md +20 -0
- data/docs/PageLink.md +22 -0
- data/docs/PiggyBank.md +54 -0
- data/docs/PiggyBankArray.md +22 -0
- data/docs/PiggyBankEvent.md +24 -0
- data/docs/PiggyBankEventArray.md +22 -0
- data/docs/PiggyBankEventAttributes.md +34 -0
- data/docs/PiggyBankRead.md +24 -0
- data/docs/PiggyBankSingle.md +18 -0
- data/docs/PiggyBanksApi.md +440 -0
- data/docs/Preference.md +24 -0
- data/docs/PreferenceArray.md +22 -0
- data/docs/PreferenceRead.md +22 -0
- data/docs/PreferenceSingle.md +18 -0
- data/docs/PreferencesApi.md +224 -0
- data/docs/Recurrence.md +45 -0
- data/docs/RecurrenceArray.md +22 -0
- data/docs/RecurrenceRead.md +24 -0
- data/docs/RecurrenceRepetition.md +34 -0
- data/docs/RecurrenceSingle.md +18 -0
- data/docs/RecurrenceTransaction.md +68 -0
- data/docs/RecurrencesApi.md +513 -0
- data/docs/Rule.md +42 -0
- data/docs/RuleAction.md +32 -0
- data/docs/RuleArray.md +22 -0
- data/docs/RuleGroup.md +28 -0
- data/docs/RuleGroupArray.md +22 -0
- data/docs/RuleGroupRead.md +24 -0
- data/docs/RuleGroupSingle.md +18 -0
- data/docs/RuleGroupsApi.md +603 -0
- data/docs/RuleRead.md +24 -0
- data/docs/RuleSingle.md +18 -0
- data/docs/RuleTrigger.md +32 -0
- data/docs/RulesApi.md +528 -0
- data/docs/SummaryApi.md +84 -0
- data/docs/SystemConfiguration.md +18 -0
- data/docs/SystemConfigurationData.md +24 -0
- data/docs/SystemInfo.md +18 -0
- data/docs/SystemInfoData.md +26 -0
- data/docs/TagArray.md +22 -0
- data/docs/TagCloud.md +18 -0
- data/docs/TagCloudTag.md +24 -0
- data/docs/TagModel.md +34 -0
- data/docs/TagRead.md +24 -0
- data/docs/TagSingle.md +18 -0
- data/docs/TagsApi.md +523 -0
- data/docs/Transaction.md +26 -0
- data/docs/TransactionArray.md +22 -0
- data/docs/TransactionLink.md +30 -0
- data/docs/TransactionLinkArray.md +22 -0
- data/docs/TransactionLinkRead.md +24 -0
- data/docs/TransactionLinkSingle.md +18 -0
- data/docs/TransactionRead.md +24 -0
- data/docs/TransactionSingle.md +18 -0
- data/docs/TransactionSplit.md +128 -0
- data/docs/TransactionTypeFilter.md +15 -0
- data/docs/TransactionsApi.md +592 -0
- data/docs/User.md +28 -0
- data/docs/UserArray.md +22 -0
- data/docs/UserRead.md +24 -0
- data/docs/UserSingle.md +18 -0
- data/docs/UsersApi.md +365 -0
- data/docs/ValidationError.md +20 -0
- data/docs/ValidationErrorErrors.md +20 -0
- data/firefly-iii-client.gemspec +39 -0
- data/git_push.sh +58 -0
- data/lib/firefly_iii_client.rb +172 -0
- data/lib/firefly_iii_client/api/about_api.rb +136 -0
- data/lib/firefly_iii_client/api/accounts_api.rb +495 -0
- data/lib/firefly_iii_client/api/attachments_api.rb +470 -0
- data/lib/firefly_iii_client/api/available_budgets_api.rb +348 -0
- data/lib/firefly_iii_client/api/bills_api.rb +555 -0
- data/lib/firefly_iii_client/api/budgets_api.rb +866 -0
- data/lib/firefly_iii_client/api/categories_api.rb +417 -0
- data/lib/firefly_iii_client/api/charts_api.rb +383 -0
- data/lib/firefly_iii_client/api/configuration_api.rb +156 -0
- data/lib/firefly_iii_client/api/currencies_api.rb +1089 -0
- data/lib/firefly_iii_client/api/currency_exchange_rates_api.rb +91 -0
- data/lib/firefly_iii_client/api/import_api.rb +220 -0
- data/lib/firefly_iii_client/api/links_api.rb +737 -0
- data/lib/firefly_iii_client/api/piggy_banks_api.rb +408 -0
- data/lib/firefly_iii_client/api/preferences_api.rb +216 -0
- data/lib/firefly_iii_client/api/recurrences_api.rb +472 -0
- data/lib/firefly_iii_client/api/rule_groups_api.rb +559 -0
- data/lib/firefly_iii_client/api/rules_api.rb +493 -0
- data/lib/firefly_iii_client/api/summary_api.rb +96 -0
- data/lib/firefly_iii_client/api/tags_api.rb +491 -0
- data/lib/firefly_iii_client/api/transactions_api.rb +546 -0
- data/lib/firefly_iii_client/api/users_api.rb +342 -0
- data/lib/firefly_iii_client/api_client.rb +390 -0
- data/lib/firefly_iii_client/api_error.rb +57 -0
- data/lib/firefly_iii_client/configuration.rb +277 -0
- data/lib/firefly_iii_client/models/account.rb +564 -0
- data/lib/firefly_iii_client/models/account_array.rb +229 -0
- data/lib/firefly_iii_client/models/account_read.rb +237 -0
- data/lib/firefly_iii_client/models/account_single.rb +218 -0
- data/lib/firefly_iii_client/models/account_type_filter.rb +56 -0
- data/lib/firefly_iii_client/models/account_type_property.rb +47 -0
- data/lib/firefly_iii_client/models/attachment.rb +401 -0
- data/lib/firefly_iii_client/models/attachment_array.rb +229 -0
- data/lib/firefly_iii_client/models/attachment_read.rb +246 -0
- data/lib/firefly_iii_client/models/attachment_single.rb +218 -0
- data/lib/firefly_iii_client/models/available_budget.rb +331 -0
- data/lib/firefly_iii_client/models/available_budget_array.rb +229 -0
- data/lib/firefly_iii_client/models/available_budget_read.rb +237 -0
- data/lib/firefly_iii_client/models/available_budget_single.rb +218 -0
- data/lib/firefly_iii_client/models/basic_summary_entry.rb +307 -0
- data/lib/firefly_iii_client/models/bill.rb +433 -0
- data/lib/firefly_iii_client/models/bill_array.rb +229 -0
- data/lib/firefly_iii_client/models/bill_paid_dates.rb +239 -0
- data/lib/firefly_iii_client/models/bill_read.rb +237 -0
- data/lib/firefly_iii_client/models/bill_single.rb +218 -0
- data/lib/firefly_iii_client/models/budget.rb +271 -0
- data/lib/firefly_iii_client/models/budget_array.rb +229 -0
- data/lib/firefly_iii_client/models/budget_limit.rb +335 -0
- data/lib/firefly_iii_client/models/budget_limit_array.rb +229 -0
- data/lib/firefly_iii_client/models/budget_limit_read.rb +237 -0
- data/lib/firefly_iii_client/models/budget_limit_single.rb +218 -0
- data/lib/firefly_iii_client/models/budget_read.rb +237 -0
- data/lib/firefly_iii_client/models/budget_single.rb +218 -0
- data/lib/firefly_iii_client/models/budget_spent.rb +256 -0
- data/lib/firefly_iii_client/models/category.rb +263 -0
- data/lib/firefly_iii_client/models/category_array.rb +229 -0
- data/lib/firefly_iii_client/models/category_earned.rb +274 -0
- data/lib/firefly_iii_client/models/category_read.rb +237 -0
- data/lib/firefly_iii_client/models/category_single.rb +218 -0
- data/lib/firefly_iii_client/models/category_spent.rb +274 -0
- data/lib/firefly_iii_client/models/chart_data_point.rb +219 -0
- data/lib/firefly_iii_client/models/chart_data_set.rb +289 -0
- data/lib/firefly_iii_client/models/configuration_update.rb +224 -0
- data/lib/firefly_iii_client/models/currency.rb +299 -0
- data/lib/firefly_iii_client/models/currency_array.rb +238 -0
- data/lib/firefly_iii_client/models/currency_read.rb +237 -0
- data/lib/firefly_iii_client/models/currency_single.rb +218 -0
- data/lib/firefly_iii_client/models/exchange_rate.rb +237 -0
- data/lib/firefly_iii_client/models/exchange_rate_array.rb +238 -0
- data/lib/firefly_iii_client/models/exchange_rate_attributes.rb +336 -0
- data/lib/firefly_iii_client/models/import_job.rb +237 -0
- data/lib/firefly_iii_client/models/import_job_array.rb +238 -0
- data/lib/firefly_iii_client/models/import_job_attributes.rb +337 -0
- data/lib/firefly_iii_client/models/import_job_single.rb +218 -0
- data/lib/firefly_iii_client/models/link_type.rb +260 -0
- data/lib/firefly_iii_client/models/link_type_array.rb +238 -0
- data/lib/firefly_iii_client/models/link_type_read.rb +246 -0
- data/lib/firefly_iii_client/models/link_type_single.rb +218 -0
- data/lib/firefly_iii_client/models/meta.rb +218 -0
- data/lib/firefly_iii_client/models/meta_pagination.rb +254 -0
- data/lib/firefly_iii_client/models/object_link.rb +227 -0
- data/lib/firefly_iii_client/models/object_link0.rb +227 -0
- data/lib/firefly_iii_client/models/page_link.rb +236 -0
- data/lib/firefly_iii_client/models/piggy_bank.rb +400 -0
- data/lib/firefly_iii_client/models/piggy_bank_array.rb +238 -0
- data/lib/firefly_iii_client/models/piggy_bank_event.rb +246 -0
- data/lib/firefly_iii_client/models/piggy_bank_event_array.rb +238 -0
- data/lib/firefly_iii_client/models/piggy_bank_event_attributes.rb +291 -0
- data/lib/firefly_iii_client/models/piggy_bank_read.rb +246 -0
- data/lib/firefly_iii_client/models/piggy_bank_single.rb +218 -0
- data/lib/firefly_iii_client/models/preference.rb +251 -0
- data/lib/firefly_iii_client/models/preference_array.rb +238 -0
- data/lib/firefly_iii_client/models/preference_read.rb +237 -0
- data/lib/firefly_iii_client/models/preference_single.rb +218 -0
- data/lib/firefly_iii_client/models/recurrence.rb +395 -0
- data/lib/firefly_iii_client/models/recurrence_array.rb +238 -0
- data/lib/firefly_iii_client/models/recurrence_read.rb +246 -0
- data/lib/firefly_iii_client/models/recurrence_repetition.rb +342 -0
- data/lib/firefly_iii_client/models/recurrence_single.rb +218 -0
- data/lib/firefly_iii_client/models/recurrence_transaction.rb +483 -0
- data/lib/firefly_iii_client/models/rule.rb +395 -0
- data/lib/firefly_iii_client/models/rule_action.rb +326 -0
- data/lib/firefly_iii_client/models/rule_array.rb +238 -0
- data/lib/firefly_iii_client/models/rule_group.rb +268 -0
- data/lib/firefly_iii_client/models/rule_group_array.rb +238 -0
- data/lib/firefly_iii_client/models/rule_group_read.rb +246 -0
- data/lib/firefly_iii_client/models/rule_group_single.rb +218 -0
- data/lib/firefly_iii_client/models/rule_read.rb +246 -0
- data/lib/firefly_iii_client/models/rule_single.rb +218 -0
- data/lib/firefly_iii_client/models/rule_trigger.rb +330 -0
- data/lib/firefly_iii_client/models/system_configuration.rb +218 -0
- data/lib/firefly_iii_client/models/system_configuration_data.rb +248 -0
- data/lib/firefly_iii_client/models/system_info.rb +223 -0
- data/lib/firefly_iii_client/models/system_info_data.rb +279 -0
- data/lib/firefly_iii_client/models/tag_array.rb +238 -0
- data/lib/firefly_iii_client/models/tag_cloud.rb +220 -0
- data/lib/firefly_iii_client/models/tag_cloud_tag.rb +249 -0
- data/lib/firefly_iii_client/models/tag_model.rb +295 -0
- data/lib/firefly_iii_client/models/tag_read.rb +246 -0
- data/lib/firefly_iii_client/models/tag_single.rb +218 -0
- data/lib/firefly_iii_client/models/transaction.rb +263 -0
- data/lib/firefly_iii_client/models/transaction_array.rb +238 -0
- data/lib/firefly_iii_client/models/transaction_link.rb +292 -0
- data/lib/firefly_iii_client/models/transaction_link_array.rb +238 -0
- data/lib/firefly_iii_client/models/transaction_link_read.rb +246 -0
- data/lib/firefly_iii_client/models/transaction_link_single.rb +218 -0
- data/lib/firefly_iii_client/models/transaction_read.rb +246 -0
- data/lib/firefly_iii_client/models/transaction_single.rb +218 -0
- data/lib/firefly_iii_client/models/transaction_split.rb +850 -0
- data/lib/firefly_iii_client/models/transaction_type_filter.rb +49 -0
- data/lib/firefly_iii_client/models/user.rb +320 -0
- data/lib/firefly_iii_client/models/user_array.rb +238 -0
- data/lib/firefly_iii_client/models/user_read.rb +246 -0
- data/lib/firefly_iii_client/models/user_single.rb +218 -0
- data/lib/firefly_iii_client/models/validation_error.rb +227 -0
- data/lib/firefly_iii_client/models/validation_error_errors.rb +231 -0
- data/lib/firefly_iii_client/version.rb +15 -0
- data/spec/api/about_api_spec.rb +57 -0
- data/spec/api/accounts_api_spec.rb +129 -0
- data/spec/api/attachments_api_spec.rb +121 -0
- data/spec/api/available_budgets_api_spec.rb +98 -0
- data/spec/api/bills_api_spec.rb +140 -0
- data/spec/api/budgets_api_spec.rb +194 -0
- data/spec/api/categories_api_spec.rb +112 -0
- data/spec/api/charts_api_spec.rb +101 -0
- data/spec/api/configuration_api_spec.rb +59 -0
- data/spec/api/currencies_api_spec.rb +246 -0
- data/spec/api/currency_exchange_rates_api_spec.rb +50 -0
- data/spec/api/import_api_spec.rb +75 -0
- data/spec/api/links_api_spec.rb +173 -0
- data/spec/api/piggy_banks_api_spec.rb +109 -0
- data/spec/api/preferences_api_spec.rb +72 -0
- data/spec/api/recurrences_api_spec.rb +123 -0
- data/spec/api/rule_groups_api_spec.rb +142 -0
- data/spec/api/rules_api_spec.rb +129 -0
- data/spec/api/summary_api_spec.rb +49 -0
- data/spec/api/tags_api_spec.rb +126 -0
- data/spec/api/transactions_api_spec.rb +137 -0
- data/spec/api/users_api_spec.rb +96 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/account_array_spec.rb +40 -0
- data/spec/models/account_read_spec.rb +46 -0
- data/spec/models/account_single_spec.rb +34 -0
- data/spec/models/account_spec.rb +210 -0
- data/spec/models/account_type_filter_spec.rb +28 -0
- data/spec/models/account_type_property_spec.rb +28 -0
- data/spec/models/attachment_array_spec.rb +40 -0
- data/spec/models/attachment_read_spec.rb +52 -0
- data/spec/models/attachment_single_spec.rb +34 -0
- data/spec/models/attachment_spec.rb +120 -0
- data/spec/models/available_budget_array_spec.rb +40 -0
- data/spec/models/available_budget_read_spec.rb +46 -0
- data/spec/models/available_budget_single_spec.rb +34 -0
- data/spec/models/available_budget_spec.rb +94 -0
- data/spec/models/basic_summary_entry_spec.rb +88 -0
- data/spec/models/bill_array_spec.rb +40 -0
- data/spec/models/bill_paid_dates_spec.rb +46 -0
- data/spec/models/bill_read_spec.rb +46 -0
- data/spec/models/bill_single_spec.rb +34 -0
- data/spec/models/bill_spec.rb +134 -0
- data/spec/models/budget_array_spec.rb +40 -0
- data/spec/models/budget_limit_array_spec.rb +40 -0
- data/spec/models/budget_limit_read_spec.rb +46 -0
- data/spec/models/budget_limit_single_spec.rb +34 -0
- data/spec/models/budget_limit_spec.rb +94 -0
- data/spec/models/budget_read_spec.rb +46 -0
- data/spec/models/budget_single_spec.rb +34 -0
- data/spec/models/budget_spec.rb +64 -0
- data/spec/models/budget_spent_spec.rb +58 -0
- data/spec/models/category_array_spec.rb +40 -0
- data/spec/models/category_earned_spec.rb +70 -0
- data/spec/models/category_read_spec.rb +46 -0
- data/spec/models/category_single_spec.rb +34 -0
- data/spec/models/category_spec.rb +58 -0
- data/spec/models/category_spent_spec.rb +70 -0
- data/spec/models/chart_data_point_spec.rb +34 -0
- data/spec/models/chart_data_set_spec.rb +76 -0
- data/spec/models/configuration_update_spec.rb +34 -0
- data/spec/models/currency_array_spec.rb +46 -0
- data/spec/models/currency_read_spec.rb +46 -0
- data/spec/models/currency_single_spec.rb +34 -0
- data/spec/models/currency_spec.rb +76 -0
- data/spec/models/exchange_rate_array_spec.rb +46 -0
- data/spec/models/exchange_rate_attributes_spec.rb +112 -0
- data/spec/models/exchange_rate_spec.rb +46 -0
- data/spec/models/import_job_array_spec.rb +46 -0
- data/spec/models/import_job_attributes_spec.rb +106 -0
- data/spec/models/import_job_single_spec.rb +34 -0
- data/spec/models/import_job_spec.rb +46 -0
- data/spec/models/link_type_array_spec.rb +46 -0
- data/spec/models/link_type_read_spec.rb +52 -0
- data/spec/models/link_type_single_spec.rb +34 -0
- data/spec/models/link_type_spec.rb +52 -0
- data/spec/models/meta_pagination_spec.rb +58 -0
- data/spec/models/meta_spec.rb +34 -0
- data/spec/models/object_link0_spec.rb +40 -0
- data/spec/models/object_link_spec.rb +40 -0
- data/spec/models/page_link_spec.rb +46 -0
- data/spec/models/piggy_bank_array_spec.rb +46 -0
- data/spec/models/piggy_bank_event_array_spec.rb +46 -0
- data/spec/models/piggy_bank_event_attributes_spec.rb +82 -0
- data/spec/models/piggy_bank_event_spec.rb +52 -0
- data/spec/models/piggy_bank_read_spec.rb +52 -0
- data/spec/models/piggy_bank_single_spec.rb +34 -0
- data/spec/models/piggy_bank_spec.rb +142 -0
- data/spec/models/preference_array_spec.rb +46 -0
- data/spec/models/preference_read_spec.rb +46 -0
- data/spec/models/preference_single_spec.rb +34 -0
- data/spec/models/preference_spec.rb +52 -0
- data/spec/models/recurrence_array_spec.rb +46 -0
- data/spec/models/recurrence_read_spec.rb +52 -0
- data/spec/models/recurrence_repetition_spec.rb +86 -0
- data/spec/models/recurrence_single_spec.rb +34 -0
- data/spec/models/recurrence_spec.rb +116 -0
- data/spec/models/recurrence_transaction_spec.rb +184 -0
- data/spec/models/rule_action_spec.rb +80 -0
- data/spec/models/rule_array_spec.rb +46 -0
- data/spec/models/rule_group_array_spec.rb +46 -0
- data/spec/models/rule_group_read_spec.rb +52 -0
- data/spec/models/rule_group_single_spec.rb +34 -0
- data/spec/models/rule_group_spec.rb +64 -0
- data/spec/models/rule_read_spec.rb +52 -0
- data/spec/models/rule_single_spec.rb +34 -0
- data/spec/models/rule_spec.rb +110 -0
- data/spec/models/rule_trigger_spec.rb +80 -0
- data/spec/models/system_configuration_data_spec.rb +52 -0
- data/spec/models/system_configuration_spec.rb +34 -0
- data/spec/models/system_info_data_spec.rb +58 -0
- data/spec/models/system_info_spec.rb +34 -0
- data/spec/models/tag_array_spec.rb +46 -0
- data/spec/models/tag_cloud_spec.rb +34 -0
- data/spec/models/tag_cloud_tag_spec.rb +52 -0
- data/spec/models/tag_model_spec.rb +76 -0
- data/spec/models/tag_read_spec.rb +52 -0
- data/spec/models/tag_single_spec.rb +34 -0
- data/spec/models/transaction_array_spec.rb +46 -0
- data/spec/models/transaction_link_array_spec.rb +46 -0
- data/spec/models/transaction_link_read_spec.rb +52 -0
- data/spec/models/transaction_link_single_spec.rb +34 -0
- data/spec/models/transaction_link_spec.rb +70 -0
- data/spec/models/transaction_read_spec.rb +52 -0
- data/spec/models/transaction_single_spec.rb +34 -0
- data/spec/models/transaction_spec.rb +58 -0
- data/spec/models/transaction_split_spec.rb +368 -0
- data/spec/models/transaction_type_filter_spec.rb +28 -0
- data/spec/models/user_array_spec.rb +46 -0
- data/spec/models/user_read_spec.rb +52 -0
- data/spec/models/user_single_spec.rb +34 -0
- data/spec/models/user_spec.rb +72 -0
- data/spec/models/validation_error_errors_spec.rb +40 -0
- data/spec/models/validation_error_spec.rb +40 -0
- data/spec/spec_helper.rb +111 -0
- metadata +495 -0
@@ -0,0 +1,417 @@
|
|
1
|
+
=begin
|
2
|
+
#Firefly III API
|
3
|
+
|
4
|
+
#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.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 0.10.4-modified
|
7
|
+
Contact: thegrumpydictator@gmail.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.1.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module FireflyIIIClient
|
16
|
+
class CategoriesApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Delete a category.
|
23
|
+
# Delete a category. Transactions will not be removed.
|
24
|
+
# @param id [Integer] The ID of the category.
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [nil]
|
27
|
+
def delete_category(id, opts = {})
|
28
|
+
delete_category_with_http_info(id, opts)
|
29
|
+
nil
|
30
|
+
end
|
31
|
+
|
32
|
+
# Delete a category.
|
33
|
+
# Delete a category. Transactions will not be removed.
|
34
|
+
# @param id [Integer] The ID of the category.
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
37
|
+
def delete_category_with_http_info(id, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: CategoriesApi.delete_category ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'id' is set
|
42
|
+
if @api_client.config.client_side_validation && id.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CategoriesApi.delete_category"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/api/v1/categories/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = opts[:query_params] || {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = opts[:header_params] || {}
|
53
|
+
|
54
|
+
# form parameters
|
55
|
+
form_params = opts[:form_params] || {}
|
56
|
+
|
57
|
+
# http body (model)
|
58
|
+
post_body = opts[:debug_body]
|
59
|
+
|
60
|
+
# return_type
|
61
|
+
return_type = opts[:debug_return_type]
|
62
|
+
|
63
|
+
# auth_names
|
64
|
+
auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
|
65
|
+
|
66
|
+
new_options = opts.merge(
|
67
|
+
:operation => :"CategoriesApi.delete_category",
|
68
|
+
:header_params => header_params,
|
69
|
+
:query_params => query_params,
|
70
|
+
:form_params => form_params,
|
71
|
+
:body => post_body,
|
72
|
+
:auth_names => auth_names,
|
73
|
+
:return_type => return_type
|
74
|
+
)
|
75
|
+
|
76
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
77
|
+
if @api_client.config.debugging
|
78
|
+
@api_client.config.logger.debug "API called: CategoriesApi#delete_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
79
|
+
end
|
80
|
+
return data, status_code, headers
|
81
|
+
end
|
82
|
+
|
83
|
+
# Get a single category.
|
84
|
+
# Get a single category.
|
85
|
+
# @param id [Integer] The ID of the category.
|
86
|
+
# @param [Hash] opts the optional parameters
|
87
|
+
# @return [CategorySingle]
|
88
|
+
def get_category(id, opts = {})
|
89
|
+
data, _status_code, _headers = get_category_with_http_info(id, opts)
|
90
|
+
data
|
91
|
+
end
|
92
|
+
|
93
|
+
# Get a single category.
|
94
|
+
# Get a single category.
|
95
|
+
# @param id [Integer] The ID of the category.
|
96
|
+
# @param [Hash] opts the optional parameters
|
97
|
+
# @return [Array<(CategorySingle, Integer, Hash)>] CategorySingle data, response status code and response headers
|
98
|
+
def get_category_with_http_info(id, opts = {})
|
99
|
+
if @api_client.config.debugging
|
100
|
+
@api_client.config.logger.debug 'Calling API: CategoriesApi.get_category ...'
|
101
|
+
end
|
102
|
+
# verify the required parameter 'id' is set
|
103
|
+
if @api_client.config.client_side_validation && id.nil?
|
104
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CategoriesApi.get_category"
|
105
|
+
end
|
106
|
+
# resource path
|
107
|
+
local_var_path = '/api/v1/categories/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
108
|
+
|
109
|
+
# query parameters
|
110
|
+
query_params = opts[:query_params] || {}
|
111
|
+
|
112
|
+
# header parameters
|
113
|
+
header_params = opts[:header_params] || {}
|
114
|
+
# HTTP header 'Accept' (if needed)
|
115
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
116
|
+
|
117
|
+
# form parameters
|
118
|
+
form_params = opts[:form_params] || {}
|
119
|
+
|
120
|
+
# http body (model)
|
121
|
+
post_body = opts[:debug_body]
|
122
|
+
|
123
|
+
# return_type
|
124
|
+
return_type = opts[:debug_return_type] || 'CategorySingle'
|
125
|
+
|
126
|
+
# auth_names
|
127
|
+
auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
|
128
|
+
|
129
|
+
new_options = opts.merge(
|
130
|
+
:operation => :"CategoriesApi.get_category",
|
131
|
+
:header_params => header_params,
|
132
|
+
:query_params => query_params,
|
133
|
+
:form_params => form_params,
|
134
|
+
:body => post_body,
|
135
|
+
:auth_names => auth_names,
|
136
|
+
:return_type => return_type
|
137
|
+
)
|
138
|
+
|
139
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
140
|
+
if @api_client.config.debugging
|
141
|
+
@api_client.config.logger.debug "API called: CategoriesApi#get_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
142
|
+
end
|
143
|
+
return data, status_code, headers
|
144
|
+
end
|
145
|
+
|
146
|
+
# List all categories.
|
147
|
+
# List all categories.
|
148
|
+
# @param [Hash] opts the optional parameters
|
149
|
+
# @option opts [Integer] :page Page number. The default pagination is 50.
|
150
|
+
# @return [CategoryArray]
|
151
|
+
def list_category(opts = {})
|
152
|
+
data, _status_code, _headers = list_category_with_http_info(opts)
|
153
|
+
data
|
154
|
+
end
|
155
|
+
|
156
|
+
# List all categories.
|
157
|
+
# List all categories.
|
158
|
+
# @param [Hash] opts the optional parameters
|
159
|
+
# @option opts [Integer] :page Page number. The default pagination is 50.
|
160
|
+
# @return [Array<(CategoryArray, Integer, Hash)>] CategoryArray data, response status code and response headers
|
161
|
+
def list_category_with_http_info(opts = {})
|
162
|
+
if @api_client.config.debugging
|
163
|
+
@api_client.config.logger.debug 'Calling API: CategoriesApi.list_category ...'
|
164
|
+
end
|
165
|
+
# resource path
|
166
|
+
local_var_path = '/api/v1/categories'
|
167
|
+
|
168
|
+
# query parameters
|
169
|
+
query_params = opts[:query_params] || {}
|
170
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
171
|
+
|
172
|
+
# header parameters
|
173
|
+
header_params = opts[:header_params] || {}
|
174
|
+
# HTTP header 'Accept' (if needed)
|
175
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
176
|
+
|
177
|
+
# form parameters
|
178
|
+
form_params = opts[:form_params] || {}
|
179
|
+
|
180
|
+
# http body (model)
|
181
|
+
post_body = opts[:debug_body]
|
182
|
+
|
183
|
+
# return_type
|
184
|
+
return_type = opts[:debug_return_type] || 'CategoryArray'
|
185
|
+
|
186
|
+
# auth_names
|
187
|
+
auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
|
188
|
+
|
189
|
+
new_options = opts.merge(
|
190
|
+
:operation => :"CategoriesApi.list_category",
|
191
|
+
:header_params => header_params,
|
192
|
+
:query_params => query_params,
|
193
|
+
:form_params => form_params,
|
194
|
+
:body => post_body,
|
195
|
+
:auth_names => auth_names,
|
196
|
+
:return_type => return_type
|
197
|
+
)
|
198
|
+
|
199
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
200
|
+
if @api_client.config.debugging
|
201
|
+
@api_client.config.logger.debug "API called: CategoriesApi#list_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
202
|
+
end
|
203
|
+
return data, status_code, headers
|
204
|
+
end
|
205
|
+
|
206
|
+
# List all transactions in a category.
|
207
|
+
# List all transactions in a category, optionally limited to the date ranges specified.
|
208
|
+
# @param id [Integer] The ID of the category.
|
209
|
+
# @param [Hash] opts the optional parameters
|
210
|
+
# @option opts [Integer] :page Page number. The default pagination is per 50.
|
211
|
+
# @option opts [Date] :start A date formatted YYYY-MM-DD, to limit the result list.
|
212
|
+
# @option opts [Date] :_end A date formatted YYYY-MM-DD, to limit the result list.
|
213
|
+
# @option opts [TransactionTypeFilter] :type Optional filter on the transaction type(s) returned
|
214
|
+
# @return [TransactionArray]
|
215
|
+
def list_transaction_by_category(id, opts = {})
|
216
|
+
data, _status_code, _headers = list_transaction_by_category_with_http_info(id, opts)
|
217
|
+
data
|
218
|
+
end
|
219
|
+
|
220
|
+
# List all transactions in a category.
|
221
|
+
# List all transactions in a category, optionally limited to the date ranges specified.
|
222
|
+
# @param id [Integer] The ID of the category.
|
223
|
+
# @param [Hash] opts the optional parameters
|
224
|
+
# @option opts [Integer] :page Page number. The default pagination is per 50.
|
225
|
+
# @option opts [Date] :start A date formatted YYYY-MM-DD, to limit the result list.
|
226
|
+
# @option opts [Date] :_end A date formatted YYYY-MM-DD, to limit the result list.
|
227
|
+
# @option opts [TransactionTypeFilter] :type Optional filter on the transaction type(s) returned
|
228
|
+
# @return [Array<(TransactionArray, Integer, Hash)>] TransactionArray data, response status code and response headers
|
229
|
+
def list_transaction_by_category_with_http_info(id, opts = {})
|
230
|
+
if @api_client.config.debugging
|
231
|
+
@api_client.config.logger.debug 'Calling API: CategoriesApi.list_transaction_by_category ...'
|
232
|
+
end
|
233
|
+
# verify the required parameter 'id' is set
|
234
|
+
if @api_client.config.client_side_validation && id.nil?
|
235
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CategoriesApi.list_transaction_by_category"
|
236
|
+
end
|
237
|
+
# resource path
|
238
|
+
local_var_path = '/api/v1/categories/{id}/transactions'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
239
|
+
|
240
|
+
# query parameters
|
241
|
+
query_params = opts[:query_params] || {}
|
242
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
243
|
+
query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
|
244
|
+
query_params[:'end'] = opts[:'_end'] if !opts[:'_end'].nil?
|
245
|
+
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
246
|
+
|
247
|
+
# header parameters
|
248
|
+
header_params = opts[:header_params] || {}
|
249
|
+
# HTTP header 'Accept' (if needed)
|
250
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
251
|
+
|
252
|
+
# form parameters
|
253
|
+
form_params = opts[:form_params] || {}
|
254
|
+
|
255
|
+
# http body (model)
|
256
|
+
post_body = opts[:debug_body]
|
257
|
+
|
258
|
+
# return_type
|
259
|
+
return_type = opts[:debug_return_type] || 'TransactionArray'
|
260
|
+
|
261
|
+
# auth_names
|
262
|
+
auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
|
263
|
+
|
264
|
+
new_options = opts.merge(
|
265
|
+
:operation => :"CategoriesApi.list_transaction_by_category",
|
266
|
+
:header_params => header_params,
|
267
|
+
:query_params => query_params,
|
268
|
+
:form_params => form_params,
|
269
|
+
:body => post_body,
|
270
|
+
:auth_names => auth_names,
|
271
|
+
:return_type => return_type
|
272
|
+
)
|
273
|
+
|
274
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
275
|
+
if @api_client.config.debugging
|
276
|
+
@api_client.config.logger.debug "API called: CategoriesApi#list_transaction_by_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
277
|
+
end
|
278
|
+
return data, status_code, headers
|
279
|
+
end
|
280
|
+
|
281
|
+
# Store a new category
|
282
|
+
# Creates a new category. The data required can be submitted as a JSON body or as a list of parameters.
|
283
|
+
# @param category [Category] JSON array or key=value pairs with the necessary category information. See the model for the exact specifications.
|
284
|
+
# @param [Hash] opts the optional parameters
|
285
|
+
# @return [CategorySingle]
|
286
|
+
def store_category(category, opts = {})
|
287
|
+
data, _status_code, _headers = store_category_with_http_info(category, opts)
|
288
|
+
data
|
289
|
+
end
|
290
|
+
|
291
|
+
# Store a new category
|
292
|
+
# Creates a new category. The data required can be submitted as a JSON body or as a list of parameters.
|
293
|
+
# @param category [Category] JSON array or key=value pairs with the necessary category information. See the model for the exact specifications.
|
294
|
+
# @param [Hash] opts the optional parameters
|
295
|
+
# @return [Array<(CategorySingle, Integer, Hash)>] CategorySingle data, response status code and response headers
|
296
|
+
def store_category_with_http_info(category, opts = {})
|
297
|
+
if @api_client.config.debugging
|
298
|
+
@api_client.config.logger.debug 'Calling API: CategoriesApi.store_category ...'
|
299
|
+
end
|
300
|
+
# verify the required parameter 'category' is set
|
301
|
+
if @api_client.config.client_side_validation && category.nil?
|
302
|
+
fail ArgumentError, "Missing the required parameter 'category' when calling CategoriesApi.store_category"
|
303
|
+
end
|
304
|
+
# resource path
|
305
|
+
local_var_path = '/api/v1/categories'
|
306
|
+
|
307
|
+
# query parameters
|
308
|
+
query_params = opts[:query_params] || {}
|
309
|
+
|
310
|
+
# header parameters
|
311
|
+
header_params = opts[:header_params] || {}
|
312
|
+
# HTTP header 'Accept' (if needed)
|
313
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
314
|
+
# HTTP header 'Content-Type'
|
315
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
|
316
|
+
|
317
|
+
# form parameters
|
318
|
+
form_params = opts[:form_params] || {}
|
319
|
+
|
320
|
+
# http body (model)
|
321
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(category)
|
322
|
+
|
323
|
+
# return_type
|
324
|
+
return_type = opts[:debug_return_type] || 'CategorySingle'
|
325
|
+
|
326
|
+
# auth_names
|
327
|
+
auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
|
328
|
+
|
329
|
+
new_options = opts.merge(
|
330
|
+
:operation => :"CategoriesApi.store_category",
|
331
|
+
:header_params => header_params,
|
332
|
+
:query_params => query_params,
|
333
|
+
:form_params => form_params,
|
334
|
+
:body => post_body,
|
335
|
+
:auth_names => auth_names,
|
336
|
+
:return_type => return_type
|
337
|
+
)
|
338
|
+
|
339
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
340
|
+
if @api_client.config.debugging
|
341
|
+
@api_client.config.logger.debug "API called: CategoriesApi#store_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
342
|
+
end
|
343
|
+
return data, status_code, headers
|
344
|
+
end
|
345
|
+
|
346
|
+
# Update existing category.
|
347
|
+
# Update existing category.
|
348
|
+
# @param id [Integer] The ID of the category.
|
349
|
+
# @param category [Category] JSON array with updated category information. See the model for the exact specifications.
|
350
|
+
# @param [Hash] opts the optional parameters
|
351
|
+
# @return [CategorySingle]
|
352
|
+
def update_category(id, category, opts = {})
|
353
|
+
data, _status_code, _headers = update_category_with_http_info(id, category, opts)
|
354
|
+
data
|
355
|
+
end
|
356
|
+
|
357
|
+
# Update existing category.
|
358
|
+
# Update existing category.
|
359
|
+
# @param id [Integer] The ID of the category.
|
360
|
+
# @param category [Category] JSON array with updated category information. See the model for the exact specifications.
|
361
|
+
# @param [Hash] opts the optional parameters
|
362
|
+
# @return [Array<(CategorySingle, Integer, Hash)>] CategorySingle data, response status code and response headers
|
363
|
+
def update_category_with_http_info(id, category, opts = {})
|
364
|
+
if @api_client.config.debugging
|
365
|
+
@api_client.config.logger.debug 'Calling API: CategoriesApi.update_category ...'
|
366
|
+
end
|
367
|
+
# verify the required parameter 'id' is set
|
368
|
+
if @api_client.config.client_side_validation && id.nil?
|
369
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CategoriesApi.update_category"
|
370
|
+
end
|
371
|
+
# verify the required parameter 'category' is set
|
372
|
+
if @api_client.config.client_side_validation && category.nil?
|
373
|
+
fail ArgumentError, "Missing the required parameter 'category' when calling CategoriesApi.update_category"
|
374
|
+
end
|
375
|
+
# resource path
|
376
|
+
local_var_path = '/api/v1/categories/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
377
|
+
|
378
|
+
# query parameters
|
379
|
+
query_params = opts[:query_params] || {}
|
380
|
+
|
381
|
+
# header parameters
|
382
|
+
header_params = opts[:header_params] || {}
|
383
|
+
# HTTP header 'Accept' (if needed)
|
384
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
385
|
+
# HTTP header 'Content-Type'
|
386
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
|
387
|
+
|
388
|
+
# form parameters
|
389
|
+
form_params = opts[:form_params] || {}
|
390
|
+
|
391
|
+
# http body (model)
|
392
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(category)
|
393
|
+
|
394
|
+
# return_type
|
395
|
+
return_type = opts[:debug_return_type] || 'CategorySingle'
|
396
|
+
|
397
|
+
# auth_names
|
398
|
+
auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
|
399
|
+
|
400
|
+
new_options = opts.merge(
|
401
|
+
:operation => :"CategoriesApi.update_category",
|
402
|
+
:header_params => header_params,
|
403
|
+
:query_params => query_params,
|
404
|
+
:form_params => form_params,
|
405
|
+
:body => post_body,
|
406
|
+
:auth_names => auth_names,
|
407
|
+
:return_type => return_type
|
408
|
+
)
|
409
|
+
|
410
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
411
|
+
if @api_client.config.debugging
|
412
|
+
@api_client.config.logger.debug "API called: CategoriesApi#update_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
413
|
+
end
|
414
|
+
return data, status_code, headers
|
415
|
+
end
|
416
|
+
end
|
417
|
+
end
|
@@ -0,0 +1,383 @@
|
|
1
|
+
=begin
|
2
|
+
#Firefly III API
|
3
|
+
|
4
|
+
#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.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 0.10.4-modified
|
7
|
+
Contact: thegrumpydictator@gmail.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.1.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module FireflyIIIClient
|
16
|
+
class ChartsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Dashboard chart with an overview of the available budget.
|
23
|
+
# This endpoint returns the data required to generate a pie chart for the available budget.
|
24
|
+
# @param id [Integer] The ID of the available budget.
|
25
|
+
# @param start [Date] A date formatted YYYY-MM-DD.
|
26
|
+
# @param _end [Date] A date formatted YYYY-MM-DD.
|
27
|
+
# @param [Hash] opts the optional parameters
|
28
|
+
# @return [Array<ChartDataSet>]
|
29
|
+
def get_chart_ab_overview(id, start, _end, opts = {})
|
30
|
+
data, _status_code, _headers = get_chart_ab_overview_with_http_info(id, start, _end, opts)
|
31
|
+
data
|
32
|
+
end
|
33
|
+
|
34
|
+
# Dashboard chart with an overview of the available budget.
|
35
|
+
# This endpoint returns the data required to generate a pie chart for the available budget.
|
36
|
+
# @param id [Integer] The ID of the available budget.
|
37
|
+
# @param start [Date] A date formatted YYYY-MM-DD.
|
38
|
+
# @param _end [Date] A date formatted YYYY-MM-DD.
|
39
|
+
# @param [Hash] opts the optional parameters
|
40
|
+
# @return [Array<(Array<ChartDataSet>, Integer, Hash)>] Array<ChartDataSet> data, response status code and response headers
|
41
|
+
def get_chart_ab_overview_with_http_info(id, start, _end, opts = {})
|
42
|
+
if @api_client.config.debugging
|
43
|
+
@api_client.config.logger.debug 'Calling API: ChartsApi.get_chart_ab_overview ...'
|
44
|
+
end
|
45
|
+
# verify the required parameter 'id' is set
|
46
|
+
if @api_client.config.client_side_validation && id.nil?
|
47
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ChartsApi.get_chart_ab_overview"
|
48
|
+
end
|
49
|
+
# verify the required parameter 'start' is set
|
50
|
+
if @api_client.config.client_side_validation && start.nil?
|
51
|
+
fail ArgumentError, "Missing the required parameter 'start' when calling ChartsApi.get_chart_ab_overview"
|
52
|
+
end
|
53
|
+
# verify the required parameter '_end' is set
|
54
|
+
if @api_client.config.client_side_validation && _end.nil?
|
55
|
+
fail ArgumentError, "Missing the required parameter '_end' when calling ChartsApi.get_chart_ab_overview"
|
56
|
+
end
|
57
|
+
# resource path
|
58
|
+
local_var_path = '/api/v1/chart/ab/overview/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
59
|
+
|
60
|
+
# query parameters
|
61
|
+
query_params = opts[:query_params] || {}
|
62
|
+
query_params[:'start'] = start
|
63
|
+
query_params[:'end'] = _end
|
64
|
+
|
65
|
+
# header parameters
|
66
|
+
header_params = opts[:header_params] || {}
|
67
|
+
# HTTP header 'Accept' (if needed)
|
68
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
69
|
+
|
70
|
+
# form parameters
|
71
|
+
form_params = opts[:form_params] || {}
|
72
|
+
|
73
|
+
# http body (model)
|
74
|
+
post_body = opts[:debug_body]
|
75
|
+
|
76
|
+
# return_type
|
77
|
+
return_type = opts[:debug_return_type] || 'Array<ChartDataSet>'
|
78
|
+
|
79
|
+
# auth_names
|
80
|
+
auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
|
81
|
+
|
82
|
+
new_options = opts.merge(
|
83
|
+
:operation => :"ChartsApi.get_chart_ab_overview",
|
84
|
+
:header_params => header_params,
|
85
|
+
:query_params => query_params,
|
86
|
+
:form_params => form_params,
|
87
|
+
:body => post_body,
|
88
|
+
:auth_names => auth_names,
|
89
|
+
:return_type => return_type
|
90
|
+
)
|
91
|
+
|
92
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
93
|
+
if @api_client.config.debugging
|
94
|
+
@api_client.config.logger.debug "API called: ChartsApi#get_chart_ab_overview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
95
|
+
end
|
96
|
+
return data, status_code, headers
|
97
|
+
end
|
98
|
+
|
99
|
+
# Dashboard chart with expense account balance information.
|
100
|
+
# This endpoint returns the data required to generate a chart that shows the user how much they've spent on their expense accounts.
|
101
|
+
# @param start [Date] A date formatted YYYY-MM-DD.
|
102
|
+
# @param _end [Date] A date formatted YYYY-MM-DD.
|
103
|
+
# @param [Hash] opts the optional parameters
|
104
|
+
# @return [Array<ChartDataSet>]
|
105
|
+
def get_chart_account_expense(start, _end, opts = {})
|
106
|
+
data, _status_code, _headers = get_chart_account_expense_with_http_info(start, _end, opts)
|
107
|
+
data
|
108
|
+
end
|
109
|
+
|
110
|
+
# Dashboard chart with expense account balance information.
|
111
|
+
# This endpoint returns the data required to generate a chart that shows the user how much they've spent on their expense accounts.
|
112
|
+
# @param start [Date] A date formatted YYYY-MM-DD.
|
113
|
+
# @param _end [Date] A date formatted YYYY-MM-DD.
|
114
|
+
# @param [Hash] opts the optional parameters
|
115
|
+
# @return [Array<(Array<ChartDataSet>, Integer, Hash)>] Array<ChartDataSet> data, response status code and response headers
|
116
|
+
def get_chart_account_expense_with_http_info(start, _end, opts = {})
|
117
|
+
if @api_client.config.debugging
|
118
|
+
@api_client.config.logger.debug 'Calling API: ChartsApi.get_chart_account_expense ...'
|
119
|
+
end
|
120
|
+
# verify the required parameter 'start' is set
|
121
|
+
if @api_client.config.client_side_validation && start.nil?
|
122
|
+
fail ArgumentError, "Missing the required parameter 'start' when calling ChartsApi.get_chart_account_expense"
|
123
|
+
end
|
124
|
+
# verify the required parameter '_end' is set
|
125
|
+
if @api_client.config.client_side_validation && _end.nil?
|
126
|
+
fail ArgumentError, "Missing the required parameter '_end' when calling ChartsApi.get_chart_account_expense"
|
127
|
+
end
|
128
|
+
# resource path
|
129
|
+
local_var_path = '/api/v1/chart/account/expense'
|
130
|
+
|
131
|
+
# query parameters
|
132
|
+
query_params = opts[:query_params] || {}
|
133
|
+
query_params[:'start'] = start
|
134
|
+
query_params[:'end'] = _end
|
135
|
+
|
136
|
+
# header parameters
|
137
|
+
header_params = opts[:header_params] || {}
|
138
|
+
# HTTP header 'Accept' (if needed)
|
139
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
140
|
+
|
141
|
+
# form parameters
|
142
|
+
form_params = opts[:form_params] || {}
|
143
|
+
|
144
|
+
# http body (model)
|
145
|
+
post_body = opts[:debug_body]
|
146
|
+
|
147
|
+
# return_type
|
148
|
+
return_type = opts[:debug_return_type] || 'Array<ChartDataSet>'
|
149
|
+
|
150
|
+
# auth_names
|
151
|
+
auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
|
152
|
+
|
153
|
+
new_options = opts.merge(
|
154
|
+
:operation => :"ChartsApi.get_chart_account_expense",
|
155
|
+
:header_params => header_params,
|
156
|
+
:query_params => query_params,
|
157
|
+
:form_params => form_params,
|
158
|
+
:body => post_body,
|
159
|
+
:auth_names => auth_names,
|
160
|
+
:return_type => return_type
|
161
|
+
)
|
162
|
+
|
163
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
164
|
+
if @api_client.config.debugging
|
165
|
+
@api_client.config.logger.debug "API called: ChartsApi#get_chart_account_expense\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
166
|
+
end
|
167
|
+
return data, status_code, headers
|
168
|
+
end
|
169
|
+
|
170
|
+
# Dashboard chart with asset account balance information.
|
171
|
+
# This endpoint returns the data required to generate a chart with basic asset account balance information.
|
172
|
+
# @param start [Date] A date formatted YYYY-MM-DD.
|
173
|
+
# @param _end [Date] A date formatted YYYY-MM-DD.
|
174
|
+
# @param [Hash] opts the optional parameters
|
175
|
+
# @return [Array<ChartDataSet>]
|
176
|
+
def get_chart_account_overview(start, _end, opts = {})
|
177
|
+
data, _status_code, _headers = get_chart_account_overview_with_http_info(start, _end, opts)
|
178
|
+
data
|
179
|
+
end
|
180
|
+
|
181
|
+
# Dashboard chart with asset account balance information.
|
182
|
+
# This endpoint returns the data required to generate a chart with basic asset account balance information.
|
183
|
+
# @param start [Date] A date formatted YYYY-MM-DD.
|
184
|
+
# @param _end [Date] A date formatted YYYY-MM-DD.
|
185
|
+
# @param [Hash] opts the optional parameters
|
186
|
+
# @return [Array<(Array<ChartDataSet>, Integer, Hash)>] Array<ChartDataSet> data, response status code and response headers
|
187
|
+
def get_chart_account_overview_with_http_info(start, _end, opts = {})
|
188
|
+
if @api_client.config.debugging
|
189
|
+
@api_client.config.logger.debug 'Calling API: ChartsApi.get_chart_account_overview ...'
|
190
|
+
end
|
191
|
+
# verify the required parameter 'start' is set
|
192
|
+
if @api_client.config.client_side_validation && start.nil?
|
193
|
+
fail ArgumentError, "Missing the required parameter 'start' when calling ChartsApi.get_chart_account_overview"
|
194
|
+
end
|
195
|
+
# verify the required parameter '_end' is set
|
196
|
+
if @api_client.config.client_side_validation && _end.nil?
|
197
|
+
fail ArgumentError, "Missing the required parameter '_end' when calling ChartsApi.get_chart_account_overview"
|
198
|
+
end
|
199
|
+
# resource path
|
200
|
+
local_var_path = '/api/v1/chart/account/overview'
|
201
|
+
|
202
|
+
# query parameters
|
203
|
+
query_params = opts[:query_params] || {}
|
204
|
+
query_params[:'start'] = start
|
205
|
+
query_params[:'end'] = _end
|
206
|
+
|
207
|
+
# header parameters
|
208
|
+
header_params = opts[:header_params] || {}
|
209
|
+
# HTTP header 'Accept' (if needed)
|
210
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
211
|
+
|
212
|
+
# form parameters
|
213
|
+
form_params = opts[:form_params] || {}
|
214
|
+
|
215
|
+
# http body (model)
|
216
|
+
post_body = opts[:debug_body]
|
217
|
+
|
218
|
+
# return_type
|
219
|
+
return_type = opts[:debug_return_type] || 'Array<ChartDataSet>'
|
220
|
+
|
221
|
+
# auth_names
|
222
|
+
auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
|
223
|
+
|
224
|
+
new_options = opts.merge(
|
225
|
+
:operation => :"ChartsApi.get_chart_account_overview",
|
226
|
+
:header_params => header_params,
|
227
|
+
:query_params => query_params,
|
228
|
+
:form_params => form_params,
|
229
|
+
:body => post_body,
|
230
|
+
:auth_names => auth_names,
|
231
|
+
:return_type => return_type
|
232
|
+
)
|
233
|
+
|
234
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
235
|
+
if @api_client.config.debugging
|
236
|
+
@api_client.config.logger.debug "API called: ChartsApi#get_chart_account_overview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
237
|
+
end
|
238
|
+
return data, status_code, headers
|
239
|
+
end
|
240
|
+
|
241
|
+
# Dashboard chart with revenue account balance information.
|
242
|
+
# This endpoint returns the data required to generate a chart that shows the user how much they've earned from their revenue accounts.
|
243
|
+
# @param start [Date] A date formatted YYYY-MM-DD.
|
244
|
+
# @param _end [Date] A date formatted YYYY-MM-DD.
|
245
|
+
# @param [Hash] opts the optional parameters
|
246
|
+
# @return [Array<ChartDataSet>]
|
247
|
+
def get_chart_account_revenue(start, _end, opts = {})
|
248
|
+
data, _status_code, _headers = get_chart_account_revenue_with_http_info(start, _end, opts)
|
249
|
+
data
|
250
|
+
end
|
251
|
+
|
252
|
+
# Dashboard chart with revenue account balance information.
|
253
|
+
# This endpoint returns the data required to generate a chart that shows the user how much they've earned from their revenue accounts.
|
254
|
+
# @param start [Date] A date formatted YYYY-MM-DD.
|
255
|
+
# @param _end [Date] A date formatted YYYY-MM-DD.
|
256
|
+
# @param [Hash] opts the optional parameters
|
257
|
+
# @return [Array<(Array<ChartDataSet>, Integer, Hash)>] Array<ChartDataSet> data, response status code and response headers
|
258
|
+
def get_chart_account_revenue_with_http_info(start, _end, opts = {})
|
259
|
+
if @api_client.config.debugging
|
260
|
+
@api_client.config.logger.debug 'Calling API: ChartsApi.get_chart_account_revenue ...'
|
261
|
+
end
|
262
|
+
# verify the required parameter 'start' is set
|
263
|
+
if @api_client.config.client_side_validation && start.nil?
|
264
|
+
fail ArgumentError, "Missing the required parameter 'start' when calling ChartsApi.get_chart_account_revenue"
|
265
|
+
end
|
266
|
+
# verify the required parameter '_end' is set
|
267
|
+
if @api_client.config.client_side_validation && _end.nil?
|
268
|
+
fail ArgumentError, "Missing the required parameter '_end' when calling ChartsApi.get_chart_account_revenue"
|
269
|
+
end
|
270
|
+
# resource path
|
271
|
+
local_var_path = '/api/v1/chart/account/revenue'
|
272
|
+
|
273
|
+
# query parameters
|
274
|
+
query_params = opts[:query_params] || {}
|
275
|
+
query_params[:'start'] = start
|
276
|
+
query_params[:'end'] = _end
|
277
|
+
|
278
|
+
# header parameters
|
279
|
+
header_params = opts[:header_params] || {}
|
280
|
+
# HTTP header 'Accept' (if needed)
|
281
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
282
|
+
|
283
|
+
# form parameters
|
284
|
+
form_params = opts[:form_params] || {}
|
285
|
+
|
286
|
+
# http body (model)
|
287
|
+
post_body = opts[:debug_body]
|
288
|
+
|
289
|
+
# return_type
|
290
|
+
return_type = opts[:debug_return_type] || 'Array<ChartDataSet>'
|
291
|
+
|
292
|
+
# auth_names
|
293
|
+
auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
|
294
|
+
|
295
|
+
new_options = opts.merge(
|
296
|
+
:operation => :"ChartsApi.get_chart_account_revenue",
|
297
|
+
:header_params => header_params,
|
298
|
+
:query_params => query_params,
|
299
|
+
:form_params => form_params,
|
300
|
+
:body => post_body,
|
301
|
+
:auth_names => auth_names,
|
302
|
+
:return_type => return_type
|
303
|
+
)
|
304
|
+
|
305
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
306
|
+
if @api_client.config.debugging
|
307
|
+
@api_client.config.logger.debug "API called: ChartsApi#get_chart_account_revenue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
308
|
+
end
|
309
|
+
return data, status_code, headers
|
310
|
+
end
|
311
|
+
|
312
|
+
# Dashboard chart with an overview of the users categories.
|
313
|
+
# This endpoint returns the data required to generate a bar chart for the expenses and incomes on the users categories.
|
314
|
+
# @param start [Date] A date formatted YYYY-MM-DD.
|
315
|
+
# @param _end [Date] A date formatted YYYY-MM-DD.
|
316
|
+
# @param [Hash] opts the optional parameters
|
317
|
+
# @return [Array<ChartDataSet>]
|
318
|
+
def get_chart_category_overview(start, _end, opts = {})
|
319
|
+
data, _status_code, _headers = get_chart_category_overview_with_http_info(start, _end, opts)
|
320
|
+
data
|
321
|
+
end
|
322
|
+
|
323
|
+
# Dashboard chart with an overview of the users categories.
|
324
|
+
# This endpoint returns the data required to generate a bar chart for the expenses and incomes on the users categories.
|
325
|
+
# @param start [Date] A date formatted YYYY-MM-DD.
|
326
|
+
# @param _end [Date] A date formatted YYYY-MM-DD.
|
327
|
+
# @param [Hash] opts the optional parameters
|
328
|
+
# @return [Array<(Array<ChartDataSet>, Integer, Hash)>] Array<ChartDataSet> data, response status code and response headers
|
329
|
+
def get_chart_category_overview_with_http_info(start, _end, opts = {})
|
330
|
+
if @api_client.config.debugging
|
331
|
+
@api_client.config.logger.debug 'Calling API: ChartsApi.get_chart_category_overview ...'
|
332
|
+
end
|
333
|
+
# verify the required parameter 'start' is set
|
334
|
+
if @api_client.config.client_side_validation && start.nil?
|
335
|
+
fail ArgumentError, "Missing the required parameter 'start' when calling ChartsApi.get_chart_category_overview"
|
336
|
+
end
|
337
|
+
# verify the required parameter '_end' is set
|
338
|
+
if @api_client.config.client_side_validation && _end.nil?
|
339
|
+
fail ArgumentError, "Missing the required parameter '_end' when calling ChartsApi.get_chart_category_overview"
|
340
|
+
end
|
341
|
+
# resource path
|
342
|
+
local_var_path = '/api/v1/chart/category/overview'
|
343
|
+
|
344
|
+
# query parameters
|
345
|
+
query_params = opts[:query_params] || {}
|
346
|
+
query_params[:'start'] = start
|
347
|
+
query_params[:'end'] = _end
|
348
|
+
|
349
|
+
# header parameters
|
350
|
+
header_params = opts[:header_params] || {}
|
351
|
+
# HTTP header 'Accept' (if needed)
|
352
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
353
|
+
|
354
|
+
# form parameters
|
355
|
+
form_params = opts[:form_params] || {}
|
356
|
+
|
357
|
+
# http body (model)
|
358
|
+
post_body = opts[:debug_body]
|
359
|
+
|
360
|
+
# return_type
|
361
|
+
return_type = opts[:debug_return_type] || 'Array<ChartDataSet>'
|
362
|
+
|
363
|
+
# auth_names
|
364
|
+
auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
|
365
|
+
|
366
|
+
new_options = opts.merge(
|
367
|
+
:operation => :"ChartsApi.get_chart_category_overview",
|
368
|
+
:header_params => header_params,
|
369
|
+
:query_params => query_params,
|
370
|
+
:form_params => form_params,
|
371
|
+
:body => post_body,
|
372
|
+
:auth_names => auth_names,
|
373
|
+
:return_type => return_type
|
374
|
+
)
|
375
|
+
|
376
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
377
|
+
if @api_client.config.debugging
|
378
|
+
@api_client.config.logger.debug "API called: ChartsApi#get_chart_category_overview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
379
|
+
end
|
380
|
+
return data, status_code, headers
|
381
|
+
end
|
382
|
+
end
|
383
|
+
end
|