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,408 @@
|
|
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 PiggyBanksApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Delete a piggy bank.
|
23
|
+
# Delete a piggy bank.
|
24
|
+
# @param id [Integer] The ID of the piggy bank.
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [nil]
|
27
|
+
def delete_piggy_bank(id, opts = {})
|
28
|
+
delete_piggy_bank_with_http_info(id, opts)
|
29
|
+
nil
|
30
|
+
end
|
31
|
+
|
32
|
+
# Delete a piggy bank.
|
33
|
+
# Delete a piggy bank.
|
34
|
+
# @param id [Integer] The ID of the piggy bank.
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
37
|
+
def delete_piggy_bank_with_http_info(id, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: PiggyBanksApi.delete_piggy_bank ...'
|
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 PiggyBanksApi.delete_piggy_bank"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/api/v1/piggy_banks/{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 => :"PiggyBanksApi.delete_piggy_bank",
|
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: PiggyBanksApi#delete_piggy_bank\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
79
|
+
end
|
80
|
+
return data, status_code, headers
|
81
|
+
end
|
82
|
+
|
83
|
+
# Get a single piggy bank.
|
84
|
+
# Get a single piggy bank.
|
85
|
+
# @param id [Integer] The ID of the piggy bank.
|
86
|
+
# @param [Hash] opts the optional parameters
|
87
|
+
# @return [PiggyBankSingle]
|
88
|
+
def get_piggy_bank(id, opts = {})
|
89
|
+
data, _status_code, _headers = get_piggy_bank_with_http_info(id, opts)
|
90
|
+
data
|
91
|
+
end
|
92
|
+
|
93
|
+
# Get a single piggy bank.
|
94
|
+
# Get a single piggy bank.
|
95
|
+
# @param id [Integer] The ID of the piggy bank.
|
96
|
+
# @param [Hash] opts the optional parameters
|
97
|
+
# @return [Array<(PiggyBankSingle, Integer, Hash)>] PiggyBankSingle data, response status code and response headers
|
98
|
+
def get_piggy_bank_with_http_info(id, opts = {})
|
99
|
+
if @api_client.config.debugging
|
100
|
+
@api_client.config.logger.debug 'Calling API: PiggyBanksApi.get_piggy_bank ...'
|
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 PiggyBanksApi.get_piggy_bank"
|
105
|
+
end
|
106
|
+
# resource path
|
107
|
+
local_var_path = '/api/v1/piggy_banks/{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] || 'PiggyBankSingle'
|
125
|
+
|
126
|
+
# auth_names
|
127
|
+
auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
|
128
|
+
|
129
|
+
new_options = opts.merge(
|
130
|
+
:operation => :"PiggyBanksApi.get_piggy_bank",
|
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: PiggyBanksApi#get_piggy_bank\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
142
|
+
end
|
143
|
+
return data, status_code, headers
|
144
|
+
end
|
145
|
+
|
146
|
+
# List all events linked to a piggy bank.
|
147
|
+
# List all events linked to a piggy bank (adding and removing money).
|
148
|
+
# @param id [Integer] The ID of the piggy bank
|
149
|
+
# @param [Hash] opts the optional parameters
|
150
|
+
# @option opts [Integer] :page Page number. The default pagination is 50.
|
151
|
+
# @return [PiggyBankEventArray]
|
152
|
+
def list_event_by_piggy_bank(id, opts = {})
|
153
|
+
data, _status_code, _headers = list_event_by_piggy_bank_with_http_info(id, opts)
|
154
|
+
data
|
155
|
+
end
|
156
|
+
|
157
|
+
# List all events linked to a piggy bank.
|
158
|
+
# List all events linked to a piggy bank (adding and removing money).
|
159
|
+
# @param id [Integer] The ID of the piggy bank
|
160
|
+
# @param [Hash] opts the optional parameters
|
161
|
+
# @option opts [Integer] :page Page number. The default pagination is 50.
|
162
|
+
# @return [Array<(PiggyBankEventArray, Integer, Hash)>] PiggyBankEventArray data, response status code and response headers
|
163
|
+
def list_event_by_piggy_bank_with_http_info(id, opts = {})
|
164
|
+
if @api_client.config.debugging
|
165
|
+
@api_client.config.logger.debug 'Calling API: PiggyBanksApi.list_event_by_piggy_bank ...'
|
166
|
+
end
|
167
|
+
# verify the required parameter 'id' is set
|
168
|
+
if @api_client.config.client_side_validation && id.nil?
|
169
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling PiggyBanksApi.list_event_by_piggy_bank"
|
170
|
+
end
|
171
|
+
# resource path
|
172
|
+
local_var_path = '/api/v1/piggy_banks/{id}/events'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
173
|
+
|
174
|
+
# query parameters
|
175
|
+
query_params = opts[:query_params] || {}
|
176
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
177
|
+
|
178
|
+
# header parameters
|
179
|
+
header_params = opts[:header_params] || {}
|
180
|
+
# HTTP header 'Accept' (if needed)
|
181
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
182
|
+
|
183
|
+
# form parameters
|
184
|
+
form_params = opts[:form_params] || {}
|
185
|
+
|
186
|
+
# http body (model)
|
187
|
+
post_body = opts[:debug_body]
|
188
|
+
|
189
|
+
# return_type
|
190
|
+
return_type = opts[:debug_return_type] || 'PiggyBankEventArray'
|
191
|
+
|
192
|
+
# auth_names
|
193
|
+
auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
|
194
|
+
|
195
|
+
new_options = opts.merge(
|
196
|
+
:operation => :"PiggyBanksApi.list_event_by_piggy_bank",
|
197
|
+
:header_params => header_params,
|
198
|
+
:query_params => query_params,
|
199
|
+
:form_params => form_params,
|
200
|
+
:body => post_body,
|
201
|
+
:auth_names => auth_names,
|
202
|
+
:return_type => return_type
|
203
|
+
)
|
204
|
+
|
205
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
206
|
+
if @api_client.config.debugging
|
207
|
+
@api_client.config.logger.debug "API called: PiggyBanksApi#list_event_by_piggy_bank\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
208
|
+
end
|
209
|
+
return data, status_code, headers
|
210
|
+
end
|
211
|
+
|
212
|
+
# List all piggy banks.
|
213
|
+
# List all piggy banks.
|
214
|
+
# @param [Hash] opts the optional parameters
|
215
|
+
# @option opts [Integer] :page Page number. The default pagination is 50.
|
216
|
+
# @return [PiggyBankArray]
|
217
|
+
def list_piggy_bank(opts = {})
|
218
|
+
data, _status_code, _headers = list_piggy_bank_with_http_info(opts)
|
219
|
+
data
|
220
|
+
end
|
221
|
+
|
222
|
+
# List all piggy banks.
|
223
|
+
# List all piggy banks.
|
224
|
+
# @param [Hash] opts the optional parameters
|
225
|
+
# @option opts [Integer] :page Page number. The default pagination is 50.
|
226
|
+
# @return [Array<(PiggyBankArray, Integer, Hash)>] PiggyBankArray data, response status code and response headers
|
227
|
+
def list_piggy_bank_with_http_info(opts = {})
|
228
|
+
if @api_client.config.debugging
|
229
|
+
@api_client.config.logger.debug 'Calling API: PiggyBanksApi.list_piggy_bank ...'
|
230
|
+
end
|
231
|
+
# resource path
|
232
|
+
local_var_path = '/api/v1/piggy_banks'
|
233
|
+
|
234
|
+
# query parameters
|
235
|
+
query_params = opts[:query_params] || {}
|
236
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
237
|
+
|
238
|
+
# header parameters
|
239
|
+
header_params = opts[:header_params] || {}
|
240
|
+
# HTTP header 'Accept' (if needed)
|
241
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
242
|
+
|
243
|
+
# form parameters
|
244
|
+
form_params = opts[:form_params] || {}
|
245
|
+
|
246
|
+
# http body (model)
|
247
|
+
post_body = opts[:debug_body]
|
248
|
+
|
249
|
+
# return_type
|
250
|
+
return_type = opts[:debug_return_type] || 'PiggyBankArray'
|
251
|
+
|
252
|
+
# auth_names
|
253
|
+
auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
|
254
|
+
|
255
|
+
new_options = opts.merge(
|
256
|
+
:operation => :"PiggyBanksApi.list_piggy_bank",
|
257
|
+
:header_params => header_params,
|
258
|
+
:query_params => query_params,
|
259
|
+
:form_params => form_params,
|
260
|
+
:body => post_body,
|
261
|
+
:auth_names => auth_names,
|
262
|
+
:return_type => return_type
|
263
|
+
)
|
264
|
+
|
265
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
266
|
+
if @api_client.config.debugging
|
267
|
+
@api_client.config.logger.debug "API called: PiggyBanksApi#list_piggy_bank\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
268
|
+
end
|
269
|
+
return data, status_code, headers
|
270
|
+
end
|
271
|
+
|
272
|
+
# Store a new piggy bank
|
273
|
+
# Creates a new piggy bank. The data required can be submitted as a JSON body or as a list of parameters.
|
274
|
+
# @param piggy_bank [PiggyBank] JSON array or key=value pairs with the necessary piggy bank information. See the model for the exact specifications.
|
275
|
+
# @param [Hash] opts the optional parameters
|
276
|
+
# @return [PiggyBankSingle]
|
277
|
+
def store_piggy_bank(piggy_bank, opts = {})
|
278
|
+
data, _status_code, _headers = store_piggy_bank_with_http_info(piggy_bank, opts)
|
279
|
+
data
|
280
|
+
end
|
281
|
+
|
282
|
+
# Store a new piggy bank
|
283
|
+
# Creates a new piggy bank. The data required can be submitted as a JSON body or as a list of parameters.
|
284
|
+
# @param piggy_bank [PiggyBank] JSON array or key=value pairs with the necessary piggy bank information. See the model for the exact specifications.
|
285
|
+
# @param [Hash] opts the optional parameters
|
286
|
+
# @return [Array<(PiggyBankSingle, Integer, Hash)>] PiggyBankSingle data, response status code and response headers
|
287
|
+
def store_piggy_bank_with_http_info(piggy_bank, opts = {})
|
288
|
+
if @api_client.config.debugging
|
289
|
+
@api_client.config.logger.debug 'Calling API: PiggyBanksApi.store_piggy_bank ...'
|
290
|
+
end
|
291
|
+
# verify the required parameter 'piggy_bank' is set
|
292
|
+
if @api_client.config.client_side_validation && piggy_bank.nil?
|
293
|
+
fail ArgumentError, "Missing the required parameter 'piggy_bank' when calling PiggyBanksApi.store_piggy_bank"
|
294
|
+
end
|
295
|
+
# resource path
|
296
|
+
local_var_path = '/api/v1/piggy_banks'
|
297
|
+
|
298
|
+
# query parameters
|
299
|
+
query_params = opts[:query_params] || {}
|
300
|
+
|
301
|
+
# header parameters
|
302
|
+
header_params = opts[:header_params] || {}
|
303
|
+
# HTTP header 'Accept' (if needed)
|
304
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
305
|
+
# HTTP header 'Content-Type'
|
306
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
|
307
|
+
|
308
|
+
# form parameters
|
309
|
+
form_params = opts[:form_params] || {}
|
310
|
+
|
311
|
+
# http body (model)
|
312
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(piggy_bank)
|
313
|
+
|
314
|
+
# return_type
|
315
|
+
return_type = opts[:debug_return_type] || 'PiggyBankSingle'
|
316
|
+
|
317
|
+
# auth_names
|
318
|
+
auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
|
319
|
+
|
320
|
+
new_options = opts.merge(
|
321
|
+
:operation => :"PiggyBanksApi.store_piggy_bank",
|
322
|
+
:header_params => header_params,
|
323
|
+
:query_params => query_params,
|
324
|
+
:form_params => form_params,
|
325
|
+
:body => post_body,
|
326
|
+
:auth_names => auth_names,
|
327
|
+
:return_type => return_type
|
328
|
+
)
|
329
|
+
|
330
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
331
|
+
if @api_client.config.debugging
|
332
|
+
@api_client.config.logger.debug "API called: PiggyBanksApi#store_piggy_bank\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
333
|
+
end
|
334
|
+
return data, status_code, headers
|
335
|
+
end
|
336
|
+
|
337
|
+
# Update existing piggy bank.
|
338
|
+
# Update existing piggy bank.
|
339
|
+
# @param id [Integer] The ID of the piggy bank
|
340
|
+
# @param piggy_bank [PiggyBank] JSON array with updated piggy bank information. See the model for the exact specifications.
|
341
|
+
# @param [Hash] opts the optional parameters
|
342
|
+
# @return [PiggyBankSingle]
|
343
|
+
def update_piggy_bank(id, piggy_bank, opts = {})
|
344
|
+
data, _status_code, _headers = update_piggy_bank_with_http_info(id, piggy_bank, opts)
|
345
|
+
data
|
346
|
+
end
|
347
|
+
|
348
|
+
# Update existing piggy bank.
|
349
|
+
# Update existing piggy bank.
|
350
|
+
# @param id [Integer] The ID of the piggy bank
|
351
|
+
# @param piggy_bank [PiggyBank] JSON array with updated piggy bank information. See the model for the exact specifications.
|
352
|
+
# @param [Hash] opts the optional parameters
|
353
|
+
# @return [Array<(PiggyBankSingle, Integer, Hash)>] PiggyBankSingle data, response status code and response headers
|
354
|
+
def update_piggy_bank_with_http_info(id, piggy_bank, opts = {})
|
355
|
+
if @api_client.config.debugging
|
356
|
+
@api_client.config.logger.debug 'Calling API: PiggyBanksApi.update_piggy_bank ...'
|
357
|
+
end
|
358
|
+
# verify the required parameter 'id' is set
|
359
|
+
if @api_client.config.client_side_validation && id.nil?
|
360
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling PiggyBanksApi.update_piggy_bank"
|
361
|
+
end
|
362
|
+
# verify the required parameter 'piggy_bank' is set
|
363
|
+
if @api_client.config.client_side_validation && piggy_bank.nil?
|
364
|
+
fail ArgumentError, "Missing the required parameter 'piggy_bank' when calling PiggyBanksApi.update_piggy_bank"
|
365
|
+
end
|
366
|
+
# resource path
|
367
|
+
local_var_path = '/api/v1/piggy_banks/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
368
|
+
|
369
|
+
# query parameters
|
370
|
+
query_params = opts[:query_params] || {}
|
371
|
+
|
372
|
+
# header parameters
|
373
|
+
header_params = opts[:header_params] || {}
|
374
|
+
# HTTP header 'Accept' (if needed)
|
375
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
376
|
+
# HTTP header 'Content-Type'
|
377
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
|
378
|
+
|
379
|
+
# form parameters
|
380
|
+
form_params = opts[:form_params] || {}
|
381
|
+
|
382
|
+
# http body (model)
|
383
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(piggy_bank)
|
384
|
+
|
385
|
+
# return_type
|
386
|
+
return_type = opts[:debug_return_type] || 'PiggyBankSingle'
|
387
|
+
|
388
|
+
# auth_names
|
389
|
+
auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
|
390
|
+
|
391
|
+
new_options = opts.merge(
|
392
|
+
:operation => :"PiggyBanksApi.update_piggy_bank",
|
393
|
+
:header_params => header_params,
|
394
|
+
:query_params => query_params,
|
395
|
+
:form_params => form_params,
|
396
|
+
:body => post_body,
|
397
|
+
:auth_names => auth_names,
|
398
|
+
:return_type => return_type
|
399
|
+
)
|
400
|
+
|
401
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
402
|
+
if @api_client.config.debugging
|
403
|
+
@api_client.config.logger.debug "API called: PiggyBanksApi#update_piggy_bank\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
404
|
+
end
|
405
|
+
return data, status_code, headers
|
406
|
+
end
|
407
|
+
end
|
408
|
+
end
|
@@ -0,0 +1,216 @@
|
|
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 PreferencesApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Return a single preference.
|
23
|
+
# Return a single preference.
|
24
|
+
# @param name [String] The name of the preference.
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [PreferenceSingle]
|
27
|
+
def get_preference(name, opts = {})
|
28
|
+
data, _status_code, _headers = get_preference_with_http_info(name, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Return a single preference.
|
33
|
+
# Return a single preference.
|
34
|
+
# @param name [String] The name of the preference.
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(PreferenceSingle, Integer, Hash)>] PreferenceSingle data, response status code and response headers
|
37
|
+
def get_preference_with_http_info(name, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: PreferencesApi.get_preference ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'name' is set
|
42
|
+
if @api_client.config.client_side_validation && name.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PreferencesApi.get_preference"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/api/v1/preferences/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = opts[:query_params] || {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = opts[:header_params] || {}
|
53
|
+
# HTTP header 'Accept' (if needed)
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
55
|
+
|
56
|
+
# form parameters
|
57
|
+
form_params = opts[:form_params] || {}
|
58
|
+
|
59
|
+
# http body (model)
|
60
|
+
post_body = opts[:debug_body]
|
61
|
+
|
62
|
+
# return_type
|
63
|
+
return_type = opts[:debug_return_type] || 'PreferenceSingle'
|
64
|
+
|
65
|
+
# auth_names
|
66
|
+
auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
|
67
|
+
|
68
|
+
new_options = opts.merge(
|
69
|
+
:operation => :"PreferencesApi.get_preference",
|
70
|
+
:header_params => header_params,
|
71
|
+
:query_params => query_params,
|
72
|
+
:form_params => form_params,
|
73
|
+
:body => post_body,
|
74
|
+
:auth_names => auth_names,
|
75
|
+
:return_type => return_type
|
76
|
+
)
|
77
|
+
|
78
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
79
|
+
if @api_client.config.debugging
|
80
|
+
@api_client.config.logger.debug "API called: PreferencesApi#get_preference\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
81
|
+
end
|
82
|
+
return data, status_code, headers
|
83
|
+
end
|
84
|
+
|
85
|
+
# List all users preferences.
|
86
|
+
# List all preferences of the user.
|
87
|
+
# @param [Hash] opts the optional parameters
|
88
|
+
# @option opts [Integer] :page Page number. The default pagination is 50.
|
89
|
+
# @return [PreferenceArray]
|
90
|
+
def list_preference(opts = {})
|
91
|
+
data, _status_code, _headers = list_preference_with_http_info(opts)
|
92
|
+
data
|
93
|
+
end
|
94
|
+
|
95
|
+
# List all users preferences.
|
96
|
+
# List all preferences of the user.
|
97
|
+
# @param [Hash] opts the optional parameters
|
98
|
+
# @option opts [Integer] :page Page number. The default pagination is 50.
|
99
|
+
# @return [Array<(PreferenceArray, Integer, Hash)>] PreferenceArray data, response status code and response headers
|
100
|
+
def list_preference_with_http_info(opts = {})
|
101
|
+
if @api_client.config.debugging
|
102
|
+
@api_client.config.logger.debug 'Calling API: PreferencesApi.list_preference ...'
|
103
|
+
end
|
104
|
+
# resource path
|
105
|
+
local_var_path = '/api/v1/preferences'
|
106
|
+
|
107
|
+
# query parameters
|
108
|
+
query_params = opts[:query_params] || {}
|
109
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
110
|
+
|
111
|
+
# header parameters
|
112
|
+
header_params = opts[:header_params] || {}
|
113
|
+
# HTTP header 'Accept' (if needed)
|
114
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
115
|
+
|
116
|
+
# form parameters
|
117
|
+
form_params = opts[:form_params] || {}
|
118
|
+
|
119
|
+
# http body (model)
|
120
|
+
post_body = opts[:debug_body]
|
121
|
+
|
122
|
+
# return_type
|
123
|
+
return_type = opts[:debug_return_type] || 'PreferenceArray'
|
124
|
+
|
125
|
+
# auth_names
|
126
|
+
auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
|
127
|
+
|
128
|
+
new_options = opts.merge(
|
129
|
+
:operation => :"PreferencesApi.list_preference",
|
130
|
+
:header_params => header_params,
|
131
|
+
:query_params => query_params,
|
132
|
+
:form_params => form_params,
|
133
|
+
:body => post_body,
|
134
|
+
:auth_names => auth_names,
|
135
|
+
:return_type => return_type
|
136
|
+
)
|
137
|
+
|
138
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
139
|
+
if @api_client.config.debugging
|
140
|
+
@api_client.config.logger.debug "API called: PreferencesApi#list_preference\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
141
|
+
end
|
142
|
+
return data, status_code, headers
|
143
|
+
end
|
144
|
+
|
145
|
+
# Update preference
|
146
|
+
# Update a user's preference.
|
147
|
+
# @param name [String] The name of the preference. Will always overwrite. Will be created if it does not exist.
|
148
|
+
# @param preference [Preference] JSON array or key=value pairs with the necessary preference information. See the model for the exact specifications.
|
149
|
+
# @param [Hash] opts the optional parameters
|
150
|
+
# @return [PreferenceSingle]
|
151
|
+
def update_preference(name, preference, opts = {})
|
152
|
+
data, _status_code, _headers = update_preference_with_http_info(name, preference, opts)
|
153
|
+
data
|
154
|
+
end
|
155
|
+
|
156
|
+
# Update preference
|
157
|
+
# Update a user's preference.
|
158
|
+
# @param name [String] The name of the preference. Will always overwrite. Will be created if it does not exist.
|
159
|
+
# @param preference [Preference] JSON array or key=value pairs with the necessary preference information. See the model for the exact specifications.
|
160
|
+
# @param [Hash] opts the optional parameters
|
161
|
+
# @return [Array<(PreferenceSingle, Integer, Hash)>] PreferenceSingle data, response status code and response headers
|
162
|
+
def update_preference_with_http_info(name, preference, opts = {})
|
163
|
+
if @api_client.config.debugging
|
164
|
+
@api_client.config.logger.debug 'Calling API: PreferencesApi.update_preference ...'
|
165
|
+
end
|
166
|
+
# verify the required parameter 'name' is set
|
167
|
+
if @api_client.config.client_side_validation && name.nil?
|
168
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PreferencesApi.update_preference"
|
169
|
+
end
|
170
|
+
# verify the required parameter 'preference' is set
|
171
|
+
if @api_client.config.client_side_validation && preference.nil?
|
172
|
+
fail ArgumentError, "Missing the required parameter 'preference' when calling PreferencesApi.update_preference"
|
173
|
+
end
|
174
|
+
# resource path
|
175
|
+
local_var_path = '/api/v1/preferences/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))
|
176
|
+
|
177
|
+
# query parameters
|
178
|
+
query_params = opts[:query_params] || {}
|
179
|
+
|
180
|
+
# header parameters
|
181
|
+
header_params = opts[:header_params] || {}
|
182
|
+
# HTTP header 'Accept' (if needed)
|
183
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
184
|
+
# HTTP header 'Content-Type'
|
185
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
|
186
|
+
|
187
|
+
# form parameters
|
188
|
+
form_params = opts[:form_params] || {}
|
189
|
+
|
190
|
+
# http body (model)
|
191
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(preference)
|
192
|
+
|
193
|
+
# return_type
|
194
|
+
return_type = opts[:debug_return_type] || 'PreferenceSingle'
|
195
|
+
|
196
|
+
# auth_names
|
197
|
+
auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']
|
198
|
+
|
199
|
+
new_options = opts.merge(
|
200
|
+
:operation => :"PreferencesApi.update_preference",
|
201
|
+
:header_params => header_params,
|
202
|
+
:query_params => query_params,
|
203
|
+
:form_params => form_params,
|
204
|
+
:body => post_body,
|
205
|
+
:auth_names => auth_names,
|
206
|
+
:return_type => return_type
|
207
|
+
)
|
208
|
+
|
209
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
210
|
+
if @api_client.config.debugging
|
211
|
+
@api_client.config.logger.debug "API called: PreferencesApi#update_preference\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
212
|
+
end
|
213
|
+
return data, status_code, headers
|
214
|
+
end
|
215
|
+
end
|
216
|
+
end
|