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,36 @@
|
|
1
|
+
# OpenapiClient::BasicSummaryEntry
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **key** | **String** | This is a reference to the type of info shared, not influenced by translations or user preferences. | [optional] |
|
8
|
+
| **title** | **String** | A translated title for the information shared. | [optional] |
|
9
|
+
| **monetary_value** | **Float** | The amount as a float. | [optional] |
|
10
|
+
| **currency_id** | **Integer** | The currency ID of the associated currency. | [optional] |
|
11
|
+
| **currency_code** | **String** | | [optional] |
|
12
|
+
| **currency_symbol** | **String** | | [optional] |
|
13
|
+
| **currency_decimal_places** | **Integer** | Number of decimals for the associated currency. | [optional] |
|
14
|
+
| **value_parsed** | **String** | The amount formatted according to the users locale | [optional] |
|
15
|
+
| **local_icon** | **String** | Reference to a font-awesome icon without the fa- part. | [optional] |
|
16
|
+
| **sub_title** | **String** | A short explanation of the amounts origin. Already formatted according to the locale of the user or translated, if relevant. | [optional] |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'firefly_iii_client'
|
22
|
+
|
23
|
+
instance = FireflyIIIClient::BasicSummaryEntry.new(
|
24
|
+
key: balance - in -EUR,
|
25
|
+
title : Balance ($),
|
26
|
+
monetary_value: 123.45,
|
27
|
+
currency_id: 5,
|
28
|
+
currency_code: EUR,
|
29
|
+
currency_symbol: $,
|
30
|
+
currency_decimal_places : 2,
|
31
|
+
value_parsed : $ 12.45,
|
32
|
+
local_icon : balance - scale,
|
33
|
+
sub_title : $20 + $- 40
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|
data/docs/Bill.md
ADDED
@@ -0,0 +1,50 @@
|
|
1
|
+
# OpenapiClient::Bill
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **created_at** | **Time** | | [optional][readonly] |
|
8
|
+
| **updated_at** | **Time** | | [optional][readonly] |
|
9
|
+
| **currency_id** | **Integer** | Use either currency_id or currency_code | [optional] |
|
10
|
+
| **currency_code** | **String** | Use either currency_id or currency_code | [optional] |
|
11
|
+
| **currency_symbol** | **String** | | [optional][readonly] |
|
12
|
+
| **currency_decimal_places** | **Integer** | | [optional][readonly] |
|
13
|
+
| **name** | **String** | | |
|
14
|
+
| **amount_min** | **Float** | | |
|
15
|
+
| **amount_max** | **Float** | | |
|
16
|
+
| **date** | **Date** | | |
|
17
|
+
| **repeat_freq** | **String** | How often the bill must be paid. | |
|
18
|
+
| **skip** | **Integer** | How often the bill must be skipped. 1 means a bi-monthly bill. | [optional] |
|
19
|
+
| **active** | **Boolean** | If the bill is active. | [optional] |
|
20
|
+
| **notes** | **String** | | [optional] |
|
21
|
+
| **next_expected_match** | **Date** | When the bill is expected to be due. | [optional][readonly] |
|
22
|
+
| **pay_dates** | **Array<Date>** | Array of future dates when the bill is expected to be paid. Autogenerated. | [optional][readonly] |
|
23
|
+
| **paid_dates** | [**Array<BillPaidDates>**](BillPaidDates.md) | Array of past transactions when the bill was paid. | [optional][readonly] |
|
24
|
+
|
25
|
+
## Example
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'firefly_iii_client'
|
29
|
+
|
30
|
+
instance = FireflyIIIClient::Bill.new(
|
31
|
+
created_at: 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
|
32
|
+
updated_at : 2018 - 09 - 17 T12 : 46 : 47 + 01 : 00,
|
33
|
+
currency_id : 5,
|
34
|
+
currency_code : EUR,
|
35
|
+
currency_symbol : $,
|
36
|
+
currency_decimal_places : 2,
|
37
|
+
name : Rent,
|
38
|
+
amount_min : 600,
|
39
|
+
amount_max : 601,
|
40
|
+
date : Mon Sep 17 00 : 00 : 00 GMT 2018,
|
41
|
+
repeat_freq: monthly,
|
42
|
+
skip: 0,
|
43
|
+
active: true,
|
44
|
+
notes: Some example notes,
|
45
|
+
next_expected_match: Mon Sep 17 00 : 00 : 00 GMT 2018,
|
46
|
+
pay_dates: null,
|
47
|
+
paid_dates: null
|
48
|
+
)
|
49
|
+
```
|
50
|
+
|
data/docs/BillArray.md
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# OpenapiClient::BillArray
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<BillRead>**](BillRead.md) | | [optional] |
|
8
|
+
| **meta** | [**Meta**](Meta.md) | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'firefly_iii_client'
|
14
|
+
|
15
|
+
instance = FireflyIIIClient::BillArray.new(
|
16
|
+
data: null,
|
17
|
+
meta: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# OpenapiClient::BillPaidDates
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **transaction_group_id** | **Integer** | Transaction group ID of the paid bill. | [optional][readonly] |
|
8
|
+
| **transaction_journal_id** | **Integer** | Transaction journal ID of the paid bill. | [optional][readonly] |
|
9
|
+
| **date** | **Date** | Date the bill was paid. | [optional][readonly] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'firefly_iii_client'
|
15
|
+
|
16
|
+
instance = FireflyIIIClient::BillPaidDates.new(
|
17
|
+
transaction_group_id: null,
|
18
|
+
transaction_journal_id: null,
|
19
|
+
date: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/BillRead.md
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# OpenapiClient::BillRead
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | **String** | Immutable value | [optional] |
|
8
|
+
| **id** | **Integer** | | [optional] |
|
9
|
+
| **attributes** | [**Bill**](Bill.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'firefly_iii_client'
|
15
|
+
|
16
|
+
instance = FireflyIIIClient::BillRead.new(
|
17
|
+
type: bills,
|
18
|
+
id: 2,
|
19
|
+
attributes: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/BillSingle.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# OpenapiClient::BillSingle
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**BillRead**](BillRead.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'firefly_iii_client'
|
13
|
+
|
14
|
+
instance = FireflyIIIClient::BillSingle.new(
|
15
|
+
data: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/BillsApi.md
ADDED
@@ -0,0 +1,600 @@
|
|
1
|
+
# OpenapiClient::BillsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://demo.firefly-iii.org*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**delete_bill**](BillsApi.md#delete_bill) | **DELETE** /api/v1/bills/{id} | Delete a bill. |
|
8
|
+
| [**get_bill**](BillsApi.md#get_bill) | **GET** /api/v1/bills/{id} | Get a single bill. |
|
9
|
+
| [**list_attachment_by_bill**](BillsApi.md#list_attachment_by_bill) | **GET** /api/v1/bills/{id}/attachments | List all attachments uploaded to the bill. |
|
10
|
+
| [**list_bill**](BillsApi.md#list_bill) | **GET** /api/v1/bills | List all bills. |
|
11
|
+
| [**list_rule_by_bill**](BillsApi.md#list_rule_by_bill) | **GET** /api/v1/bills/{id}/rules | List all rules associated with the bill. |
|
12
|
+
| [**list_transaction_by_bill**](BillsApi.md#list_transaction_by_bill) | **GET** /api/v1/bills/{id}/transactions | List all transactions associated with the bill. |
|
13
|
+
| [**store_bill**](BillsApi.md#store_bill) | **POST** /api/v1/bills | Store a new bill |
|
14
|
+
| [**update_bill**](BillsApi.md#update_bill) | **PUT** /api/v1/bills/{id} | Update existing bill. |
|
15
|
+
|
16
|
+
|
17
|
+
## delete_bill
|
18
|
+
|
19
|
+
> delete_bill(id)
|
20
|
+
|
21
|
+
Delete a bill.
|
22
|
+
|
23
|
+
Delete a bill. This will not delete any associated rules. Will not remove associated transactions. WILL remove all associated attachments.
|
24
|
+
|
25
|
+
### Examples
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'time'
|
29
|
+
require 'firefly_iii_client'
|
30
|
+
# setup authorization
|
31
|
+
FireflyIIIClient.configure do |config|
|
32
|
+
# Configure OAuth2 access token for authorization: firefly_iii_auth
|
33
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
34
|
+
end
|
35
|
+
|
36
|
+
api_instance = FireflyIIIClient::BillsApi.new
|
37
|
+
id = 1 # Integer | The ID of the bill.
|
38
|
+
|
39
|
+
begin
|
40
|
+
# Delete a bill.
|
41
|
+
api_instance.delete_bill(id)
|
42
|
+
rescue FireflyIIIClient::ApiError => e
|
43
|
+
puts "Error when calling BillsApi->delete_bill: #{e}"
|
44
|
+
end
|
45
|
+
```
|
46
|
+
|
47
|
+
#### Using the delete_bill_with_http_info variant
|
48
|
+
|
49
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
50
|
+
|
51
|
+
> <Array(nil, Integer, Hash)> delete_bill_with_http_info(id)
|
52
|
+
|
53
|
+
```ruby
|
54
|
+
|
55
|
+
begin
|
56
|
+
# Delete a bill.
|
57
|
+
data, status_code, headers = api_instance.delete_bill_with_http_info(id)
|
58
|
+
p status_code # => 2xx
|
59
|
+
p headers # => { ... }
|
60
|
+
p data # => nil
|
61
|
+
rescue FireflyIIIClient::ApiError => e
|
62
|
+
puts "Error when calling BillsApi->delete_bill_with_http_info: #{e}"
|
63
|
+
end
|
64
|
+
```
|
65
|
+
|
66
|
+
### Parameters
|
67
|
+
|
68
|
+
| Name | Type | Description | Notes |
|
69
|
+
| ---- | ---- | ----------- | ----- |
|
70
|
+
| **id** | **Integer** | The ID of the bill. | |
|
71
|
+
|
72
|
+
### Return type
|
73
|
+
|
74
|
+
nil (empty response body)
|
75
|
+
|
76
|
+
### Authorization
|
77
|
+
|
78
|
+
[firefly_iii_auth](../README.md#firefly_iii_auth)
|
79
|
+
|
80
|
+
### HTTP request headers
|
81
|
+
|
82
|
+
- **Content-Type**: Not defined
|
83
|
+
- **Accept**: Not defined
|
84
|
+
|
85
|
+
|
86
|
+
## get_bill
|
87
|
+
|
88
|
+
> <BillSingle> get_bill(id, opts)
|
89
|
+
|
90
|
+
Get a single bill.
|
91
|
+
|
92
|
+
Get a single bill.
|
93
|
+
|
94
|
+
### Examples
|
95
|
+
|
96
|
+
```ruby
|
97
|
+
require 'time'
|
98
|
+
require 'firefly_iii_client'
|
99
|
+
# setup authorization
|
100
|
+
FireflyIIIClient.configure do |config|
|
101
|
+
# Configure OAuth2 access token for authorization: firefly_iii_auth
|
102
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
103
|
+
end
|
104
|
+
|
105
|
+
api_instance = FireflyIIIClient::BillsApi.new
|
106
|
+
id = 1 # Integer | The ID of the bill.
|
107
|
+
opts = {
|
108
|
+
start: Date.parse('Mon Sep 17 00:00:00 GMT 2018'), # Date | A date formatted YYYY-MM-DD. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates.
|
109
|
+
_end: Date.parse('Mon Dec 31 00:00:00 GMT 2018') # Date | A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates.
|
110
|
+
}
|
111
|
+
|
112
|
+
begin
|
113
|
+
# Get a single bill.
|
114
|
+
result = api_instance.get_bill(id, opts)
|
115
|
+
p result
|
116
|
+
rescue FireflyIIIClient::ApiError => e
|
117
|
+
puts "Error when calling BillsApi->get_bill: #{e}"
|
118
|
+
end
|
119
|
+
```
|
120
|
+
|
121
|
+
#### Using the get_bill_with_http_info variant
|
122
|
+
|
123
|
+
This returns an Array which contains the response data, status code and headers.
|
124
|
+
|
125
|
+
> <Array(<BillSingle>, Integer, Hash)> get_bill_with_http_info(id, opts)
|
126
|
+
|
127
|
+
```ruby
|
128
|
+
|
129
|
+
begin
|
130
|
+
# Get a single bill.
|
131
|
+
data, status_code, headers = api_instance.get_bill_with_http_info(id, opts)
|
132
|
+
p status_code # => 2xx
|
133
|
+
p headers # => { ... }
|
134
|
+
p data # => <BillSingle>
|
135
|
+
rescue FireflyIIIClient::ApiError => e
|
136
|
+
puts "Error when calling BillsApi->get_bill_with_http_info: #{e}"
|
137
|
+
end
|
138
|
+
```
|
139
|
+
|
140
|
+
### Parameters
|
141
|
+
|
142
|
+
| Name | Type | Description | Notes |
|
143
|
+
| ---- | ---- | ----------- | ----- |
|
144
|
+
| **id** | **Integer** | The ID of the bill. | |
|
145
|
+
| **start** | **Date** | A date formatted YYYY-MM-DD. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates. | [optional] |
|
146
|
+
| **_end** | **Date** | A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates. | [optional] |
|
147
|
+
|
148
|
+
### Return type
|
149
|
+
|
150
|
+
[**BillSingle**](BillSingle.md)
|
151
|
+
|
152
|
+
### Authorization
|
153
|
+
|
154
|
+
[firefly_iii_auth](../README.md#firefly_iii_auth)
|
155
|
+
|
156
|
+
### HTTP request headers
|
157
|
+
|
158
|
+
- **Content-Type**: Not defined
|
159
|
+
- **Accept**: application/json
|
160
|
+
|
161
|
+
|
162
|
+
## list_attachment_by_bill
|
163
|
+
|
164
|
+
> <AttachmentArray> list_attachment_by_bill(id, opts)
|
165
|
+
|
166
|
+
List all attachments uploaded to the bill.
|
167
|
+
|
168
|
+
This endpoint will list all attachments linked to the bill.
|
169
|
+
|
170
|
+
### Examples
|
171
|
+
|
172
|
+
```ruby
|
173
|
+
require 'time'
|
174
|
+
require 'firefly_iii_client'
|
175
|
+
# setup authorization
|
176
|
+
FireflyIIIClient.configure do |config|
|
177
|
+
# Configure OAuth2 access token for authorization: firefly_iii_auth
|
178
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
179
|
+
end
|
180
|
+
|
181
|
+
api_instance = FireflyIIIClient::BillsApi.new
|
182
|
+
id = 1 # Integer | The ID of the bill.
|
183
|
+
opts = {
|
184
|
+
page: 1 # Integer | Page number. The default pagination is 50.
|
185
|
+
}
|
186
|
+
|
187
|
+
begin
|
188
|
+
# List all attachments uploaded to the bill.
|
189
|
+
result = api_instance.list_attachment_by_bill(id, opts)
|
190
|
+
p result
|
191
|
+
rescue FireflyIIIClient::ApiError => e
|
192
|
+
puts "Error when calling BillsApi->list_attachment_by_bill: #{e}"
|
193
|
+
end
|
194
|
+
```
|
195
|
+
|
196
|
+
#### Using the list_attachment_by_bill_with_http_info variant
|
197
|
+
|
198
|
+
This returns an Array which contains the response data, status code and headers.
|
199
|
+
|
200
|
+
> <Array(<AttachmentArray>, Integer, Hash)> list_attachment_by_bill_with_http_info(id, opts)
|
201
|
+
|
202
|
+
```ruby
|
203
|
+
|
204
|
+
begin
|
205
|
+
# List all attachments uploaded to the bill.
|
206
|
+
data, status_code, headers = api_instance.list_attachment_by_bill_with_http_info(id, opts)
|
207
|
+
p status_code # => 2xx
|
208
|
+
p headers # => { ... }
|
209
|
+
p data # => <AttachmentArray>
|
210
|
+
rescue FireflyIIIClient::ApiError => e
|
211
|
+
puts "Error when calling BillsApi->list_attachment_by_bill_with_http_info: #{e}"
|
212
|
+
end
|
213
|
+
```
|
214
|
+
|
215
|
+
### Parameters
|
216
|
+
|
217
|
+
| Name | Type | Description | Notes |
|
218
|
+
| ---- | ---- | ----------- | ----- |
|
219
|
+
| **id** | **Integer** | The ID of the bill. | |
|
220
|
+
| **page** | **Integer** | Page number. The default pagination is 50. | [optional] |
|
221
|
+
|
222
|
+
### Return type
|
223
|
+
|
224
|
+
[**AttachmentArray**](AttachmentArray.md)
|
225
|
+
|
226
|
+
### Authorization
|
227
|
+
|
228
|
+
[firefly_iii_auth](../README.md#firefly_iii_auth)
|
229
|
+
|
230
|
+
### HTTP request headers
|
231
|
+
|
232
|
+
- **Content-Type**: Not defined
|
233
|
+
- **Accept**: application/json
|
234
|
+
|
235
|
+
|
236
|
+
## list_bill
|
237
|
+
|
238
|
+
> <BillArray> list_bill(opts)
|
239
|
+
|
240
|
+
List all bills.
|
241
|
+
|
242
|
+
This endpoint will list all the user's bills.
|
243
|
+
|
244
|
+
### Examples
|
245
|
+
|
246
|
+
```ruby
|
247
|
+
require 'time'
|
248
|
+
require 'firefly_iii_client'
|
249
|
+
# setup authorization
|
250
|
+
FireflyIIIClient.configure do |config|
|
251
|
+
# Configure OAuth2 access token for authorization: firefly_iii_auth
|
252
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
253
|
+
end
|
254
|
+
|
255
|
+
api_instance = FireflyIIIClient::BillsApi.new
|
256
|
+
opts = {
|
257
|
+
page: 1, # Integer | Page number. The default pagination is 50.
|
258
|
+
start: Date.parse('Mon Sep 17 00:00:00 GMT 2018'), # Date | A date formatted YYYY-MM-DD. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates.
|
259
|
+
_end: Date.parse('Mon Dec 31 00:00:00 GMT 2018') # Date | A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates.
|
260
|
+
}
|
261
|
+
|
262
|
+
begin
|
263
|
+
# List all bills.
|
264
|
+
result = api_instance.list_bill(opts)
|
265
|
+
p result
|
266
|
+
rescue FireflyIIIClient::ApiError => e
|
267
|
+
puts "Error when calling BillsApi->list_bill: #{e}"
|
268
|
+
end
|
269
|
+
```
|
270
|
+
|
271
|
+
#### Using the list_bill_with_http_info variant
|
272
|
+
|
273
|
+
This returns an Array which contains the response data, status code and headers.
|
274
|
+
|
275
|
+
> <Array(<BillArray>, Integer, Hash)> list_bill_with_http_info(opts)
|
276
|
+
|
277
|
+
```ruby
|
278
|
+
|
279
|
+
begin
|
280
|
+
# List all bills.
|
281
|
+
data, status_code, headers = api_instance.list_bill_with_http_info(opts)
|
282
|
+
p status_code # => 2xx
|
283
|
+
p headers # => { ... }
|
284
|
+
p data # => <BillArray>
|
285
|
+
rescue FireflyIIIClient::ApiError => e
|
286
|
+
puts "Error when calling BillsApi->list_bill_with_http_info: #{e}"
|
287
|
+
end
|
288
|
+
```
|
289
|
+
|
290
|
+
### Parameters
|
291
|
+
|
292
|
+
| Name | Type | Description | Notes |
|
293
|
+
| ---- | ---- | ----------- | ----- |
|
294
|
+
| **page** | **Integer** | Page number. The default pagination is 50. | [optional] |
|
295
|
+
| **start** | **Date** | A date formatted YYYY-MM-DD. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates. | [optional] |
|
296
|
+
| **_end** | **Date** | A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates. | [optional] |
|
297
|
+
|
298
|
+
### Return type
|
299
|
+
|
300
|
+
[**BillArray**](BillArray.md)
|
301
|
+
|
302
|
+
### Authorization
|
303
|
+
|
304
|
+
[firefly_iii_auth](../README.md#firefly_iii_auth)
|
305
|
+
|
306
|
+
### HTTP request headers
|
307
|
+
|
308
|
+
- **Content-Type**: Not defined
|
309
|
+
- **Accept**: application/json
|
310
|
+
|
311
|
+
|
312
|
+
## list_rule_by_bill
|
313
|
+
|
314
|
+
> <RuleArray> list_rule_by_bill(id)
|
315
|
+
|
316
|
+
List all rules associated with the bill.
|
317
|
+
|
318
|
+
This endpoint will list all rules that have an action to set the bill to this bill.
|
319
|
+
|
320
|
+
### Examples
|
321
|
+
|
322
|
+
```ruby
|
323
|
+
require 'time'
|
324
|
+
require 'firefly_iii_client'
|
325
|
+
# setup authorization
|
326
|
+
FireflyIIIClient.configure do |config|
|
327
|
+
# Configure OAuth2 access token for authorization: firefly_iii_auth
|
328
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
329
|
+
end
|
330
|
+
|
331
|
+
api_instance = FireflyIIIClient::BillsApi.new
|
332
|
+
id = 1 # Integer | The ID of the bill.
|
333
|
+
|
334
|
+
begin
|
335
|
+
# List all rules associated with the bill.
|
336
|
+
result = api_instance.list_rule_by_bill(id)
|
337
|
+
p result
|
338
|
+
rescue FireflyIIIClient::ApiError => e
|
339
|
+
puts "Error when calling BillsApi->list_rule_by_bill: #{e}"
|
340
|
+
end
|
341
|
+
```
|
342
|
+
|
343
|
+
#### Using the list_rule_by_bill_with_http_info variant
|
344
|
+
|
345
|
+
This returns an Array which contains the response data, status code and headers.
|
346
|
+
|
347
|
+
> <Array(<RuleArray>, Integer, Hash)> list_rule_by_bill_with_http_info(id)
|
348
|
+
|
349
|
+
```ruby
|
350
|
+
|
351
|
+
begin
|
352
|
+
# List all rules associated with the bill.
|
353
|
+
data, status_code, headers = api_instance.list_rule_by_bill_with_http_info(id)
|
354
|
+
p status_code # => 2xx
|
355
|
+
p headers # => { ... }
|
356
|
+
p data # => <RuleArray>
|
357
|
+
rescue FireflyIIIClient::ApiError => e
|
358
|
+
puts "Error when calling BillsApi->list_rule_by_bill_with_http_info: #{e}"
|
359
|
+
end
|
360
|
+
```
|
361
|
+
|
362
|
+
### Parameters
|
363
|
+
|
364
|
+
| Name | Type | Description | Notes |
|
365
|
+
| ---- | ---- | ----------- | ----- |
|
366
|
+
| **id** | **Integer** | The ID of the bill. | |
|
367
|
+
|
368
|
+
### Return type
|
369
|
+
|
370
|
+
[**RuleArray**](RuleArray.md)
|
371
|
+
|
372
|
+
### Authorization
|
373
|
+
|
374
|
+
[firefly_iii_auth](../README.md#firefly_iii_auth)
|
375
|
+
|
376
|
+
### HTTP request headers
|
377
|
+
|
378
|
+
- **Content-Type**: Not defined
|
379
|
+
- **Accept**: application/json
|
380
|
+
|
381
|
+
|
382
|
+
## list_transaction_by_bill
|
383
|
+
|
384
|
+
> <TransactionArray> list_transaction_by_bill(id, opts)
|
385
|
+
|
386
|
+
List all transactions associated with the bill.
|
387
|
+
|
388
|
+
This endpoint will list all transactions linked to this bill.
|
389
|
+
|
390
|
+
### Examples
|
391
|
+
|
392
|
+
```ruby
|
393
|
+
require 'time'
|
394
|
+
require 'firefly_iii_client'
|
395
|
+
# setup authorization
|
396
|
+
FireflyIIIClient.configure do |config|
|
397
|
+
# Configure OAuth2 access token for authorization: firefly_iii_auth
|
398
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
399
|
+
end
|
400
|
+
|
401
|
+
api_instance = FireflyIIIClient::BillsApi.new
|
402
|
+
id = 1 # Integer | The ID of the bill.
|
403
|
+
opts = {
|
404
|
+
start: Date.parse('Mon Sep 17 00:00:00 GMT 2018'), # Date | A date formatted YYYY-MM-DD.
|
405
|
+
_end: Date.parse('Mon Dec 31 00:00:00 GMT 2018'), # Date | A date formatted YYYY-MM-DD.
|
406
|
+
type: FireflyIIIClient::TransactionTypeFilter::ALL # TransactionTypeFilter | Optional filter on the transaction type(s) returned
|
407
|
+
}
|
408
|
+
|
409
|
+
begin
|
410
|
+
# List all transactions associated with the bill.
|
411
|
+
result = api_instance.list_transaction_by_bill(id, opts)
|
412
|
+
p result
|
413
|
+
rescue FireflyIIIClient::ApiError => e
|
414
|
+
puts "Error when calling BillsApi->list_transaction_by_bill: #{e}"
|
415
|
+
end
|
416
|
+
```
|
417
|
+
|
418
|
+
#### Using the list_transaction_by_bill_with_http_info variant
|
419
|
+
|
420
|
+
This returns an Array which contains the response data, status code and headers.
|
421
|
+
|
422
|
+
> <Array(<TransactionArray>, Integer, Hash)> list_transaction_by_bill_with_http_info(id, opts)
|
423
|
+
|
424
|
+
```ruby
|
425
|
+
|
426
|
+
begin
|
427
|
+
# List all transactions associated with the bill.
|
428
|
+
data, status_code, headers = api_instance.list_transaction_by_bill_with_http_info(id, opts)
|
429
|
+
p status_code # => 2xx
|
430
|
+
p headers # => { ... }
|
431
|
+
p data # => <TransactionArray>
|
432
|
+
rescue FireflyIIIClient::ApiError => e
|
433
|
+
puts "Error when calling BillsApi->list_transaction_by_bill_with_http_info: #{e}"
|
434
|
+
end
|
435
|
+
```
|
436
|
+
|
437
|
+
### Parameters
|
438
|
+
|
439
|
+
| Name | Type | Description | Notes |
|
440
|
+
| ---- | ---- | ----------- | ----- |
|
441
|
+
| **id** | **Integer** | The ID of the bill. | |
|
442
|
+
| **start** | **Date** | A date formatted YYYY-MM-DD. | [optional] |
|
443
|
+
| **_end** | **Date** | A date formatted YYYY-MM-DD. | [optional] |
|
444
|
+
| **type** | [**TransactionTypeFilter**](.md) | Optional filter on the transaction type(s) returned | [optional] |
|
445
|
+
|
446
|
+
### Return type
|
447
|
+
|
448
|
+
[**TransactionArray**](TransactionArray.md)
|
449
|
+
|
450
|
+
### Authorization
|
451
|
+
|
452
|
+
[firefly_iii_auth](../README.md#firefly_iii_auth)
|
453
|
+
|
454
|
+
### HTTP request headers
|
455
|
+
|
456
|
+
- **Content-Type**: Not defined
|
457
|
+
- **Accept**: application/json
|
458
|
+
|
459
|
+
|
460
|
+
## store_bill
|
461
|
+
|
462
|
+
> <BillSingle> store_bill(bill)
|
463
|
+
|
464
|
+
Store a new bill
|
465
|
+
|
466
|
+
Creates a new bill. The data required can be submitted as a JSON body or as a list of parameters.
|
467
|
+
|
468
|
+
### Examples
|
469
|
+
|
470
|
+
```ruby
|
471
|
+
require 'time'
|
472
|
+
require 'firefly_iii_client'
|
473
|
+
# setup authorization
|
474
|
+
FireflyIIIClient.configure do |config|
|
475
|
+
# Configure OAuth2 access token for authorization: firefly_iii_auth
|
476
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
477
|
+
end
|
478
|
+
|
479
|
+
api_instance = FireflyIIIClient::BillsApi.new
|
480
|
+
bill = FireflyIIIClient::Bill.new({ name: 'Rent', amount_min: 600, amount_max: 601, date: Date.parse('Mon Sep 17 00:00:00 GMT 2018'), repeat_freq: 'weekly' }) # Bill | JSON array or key=value pairs with the necessary bill information. See the model for the exact specifications.
|
481
|
+
|
482
|
+
begin
|
483
|
+
# Store a new bill
|
484
|
+
result = api_instance.store_bill(bill)
|
485
|
+
p result
|
486
|
+
rescue FireflyIIIClient::ApiError => e
|
487
|
+
puts "Error when calling BillsApi->store_bill: #{e}"
|
488
|
+
end
|
489
|
+
```
|
490
|
+
|
491
|
+
#### Using the store_bill_with_http_info variant
|
492
|
+
|
493
|
+
This returns an Array which contains the response data, status code and headers.
|
494
|
+
|
495
|
+
> <Array(<BillSingle>, Integer, Hash)> store_bill_with_http_info(bill)
|
496
|
+
|
497
|
+
```ruby
|
498
|
+
|
499
|
+
begin
|
500
|
+
# Store a new bill
|
501
|
+
data, status_code, headers = api_instance.store_bill_with_http_info(bill)
|
502
|
+
p status_code # => 2xx
|
503
|
+
p headers # => { ... }
|
504
|
+
p data # => <BillSingle>
|
505
|
+
rescue FireflyIIIClient::ApiError => e
|
506
|
+
puts "Error when calling BillsApi->store_bill_with_http_info: #{e}"
|
507
|
+
end
|
508
|
+
```
|
509
|
+
|
510
|
+
### Parameters
|
511
|
+
|
512
|
+
| Name | Type | Description | Notes |
|
513
|
+
| ---- | ---- | ----------- | ----- |
|
514
|
+
| **bill** | [**Bill**](Bill.md) | JSON array or key=value pairs with the necessary bill information. See the model for the exact specifications. | |
|
515
|
+
|
516
|
+
### Return type
|
517
|
+
|
518
|
+
[**BillSingle**](BillSingle.md)
|
519
|
+
|
520
|
+
### Authorization
|
521
|
+
|
522
|
+
[firefly_iii_auth](../README.md#firefly_iii_auth)
|
523
|
+
|
524
|
+
### HTTP request headers
|
525
|
+
|
526
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded
|
527
|
+
- **Accept**: application/json
|
528
|
+
|
529
|
+
|
530
|
+
## update_bill
|
531
|
+
|
532
|
+
> <BillSingle> update_bill(id, bill)
|
533
|
+
|
534
|
+
Update existing bill.
|
535
|
+
|
536
|
+
Update existing bill.
|
537
|
+
|
538
|
+
### Examples
|
539
|
+
|
540
|
+
```ruby
|
541
|
+
require 'time'
|
542
|
+
require 'firefly_iii_client'
|
543
|
+
# setup authorization
|
544
|
+
FireflyIIIClient.configure do |config|
|
545
|
+
# Configure OAuth2 access token for authorization: firefly_iii_auth
|
546
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
547
|
+
end
|
548
|
+
|
549
|
+
api_instance = FireflyIIIClient::BillsApi.new
|
550
|
+
id = 1 # Integer | The ID of the bill.
|
551
|
+
bill = FireflyIIIClient::Bill.new({ name: 'Rent', amount_min: 600, amount_max: 601, date: Date.parse('Mon Sep 17 00:00:00 GMT 2018'), repeat_freq: 'weekly' }) # Bill | JSON array or key=value pairs with updated bill information. See the model for the exact specifications.
|
552
|
+
|
553
|
+
begin
|
554
|
+
# Update existing bill.
|
555
|
+
result = api_instance.update_bill(id, bill)
|
556
|
+
p result
|
557
|
+
rescue FireflyIIIClient::ApiError => e
|
558
|
+
puts "Error when calling BillsApi->update_bill: #{e}"
|
559
|
+
end
|
560
|
+
```
|
561
|
+
|
562
|
+
#### Using the update_bill_with_http_info variant
|
563
|
+
|
564
|
+
This returns an Array which contains the response data, status code and headers.
|
565
|
+
|
566
|
+
> <Array(<BillSingle>, Integer, Hash)> update_bill_with_http_info(id, bill)
|
567
|
+
|
568
|
+
```ruby
|
569
|
+
|
570
|
+
begin
|
571
|
+
# Update existing bill.
|
572
|
+
data, status_code, headers = api_instance.update_bill_with_http_info(id, bill)
|
573
|
+
p status_code # => 2xx
|
574
|
+
p headers # => { ... }
|
575
|
+
p data # => <BillSingle>
|
576
|
+
rescue FireflyIIIClient::ApiError => e
|
577
|
+
puts "Error when calling BillsApi->update_bill_with_http_info: #{e}"
|
578
|
+
end
|
579
|
+
```
|
580
|
+
|
581
|
+
### Parameters
|
582
|
+
|
583
|
+
| Name | Type | Description | Notes |
|
584
|
+
| ---- | ---- | ----------- | ----- |
|
585
|
+
| **id** | **Integer** | The ID of the bill. | |
|
586
|
+
| **bill** | [**Bill**](Bill.md) | JSON array or key=value pairs with updated bill information. See the model for the exact specifications. | |
|
587
|
+
|
588
|
+
### Return type
|
589
|
+
|
590
|
+
[**BillSingle**](BillSingle.md)
|
591
|
+
|
592
|
+
### Authorization
|
593
|
+
|
594
|
+
[firefly_iii_auth](../README.md#firefly_iii_auth)
|
595
|
+
|
596
|
+
### HTTP request headers
|
597
|
+
|
598
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded
|
599
|
+
- **Accept**: application/json
|
600
|
+
|