Lib.rs

› 网络编程
#api-client #client #openapi #economy #api-bindings

firefly-iii

Rust API 客户端用于 firefly-iii

由 OpenAPI Generator 团队和贡献者创建。 所有者 Ole Martin Ruud.

11 个版本

0.2.3 2020 年 8 月 15 日
0.2.2 2020 年 8 月 9 日
0.2.1 2020 年 7 月 4 日
0.1.0-alpha.72020 年 3 月 4 日
0.1.0-alpha.22019 年 12 月 6 日

#2193 in 网络编程

27 每月下载量

AGPL-3.0

500KB
8K SLoC

Rust API 客户端用于 firefly-iii

Crates.io Documentation

这是 Firefly III API 的官方文档。您可以在 Firefly III 的网站上找到相应的文档（见下文）。请报告任何错误或问题。此版本的 API 从 v4.7.9 版本开始生效。您可以使用下面的“授权”按钮尝试 API。

概述

此 API 客户端由 OpenAPI Generator 项目生成。通过使用来自远程服务器的 openapi-spec，您可以轻松生成 API 客户端。

  • API 版本：1.3.0
  • 包版本：1.3.0
  • 构建包：org.openapitools.codegen.languages.RustClientCodegen 更多信息，请访问 https://firefly-iii.org

安装

将包放在您的项目文件夹下，并在 Cargo.toml 下的 [dependencies] 中添加以下内容

firefly-iii = "0.2.3"

API 端点文档

所有 URI 都是相对于 https://demo.firefly-iii.org

类 方法 HTTP 请求 描述
AboutApi get_about GET /api/v1/about 系统信息端点。
AboutApi get_current_user GET /api/v1/about/user 当前认证用户端点。
AccountsApi delete_account DELETE /api/v1/accounts/{id} 永久删除账户。
AccountsApi get_account GET /api/v1/accounts/{id} 获取单个账户。
AccountsApi list_account GET /api/v1/accounts 列出所有账户。
AccountsApi list_attachment_by_account GET /api/v1/accounts/{id}/attachments 列出所有附件。
AccountsApi list_piggy_bank_by_account GET /api/v1/accounts/{id}/piggy_banks 列出与账户相关的所有储蓄罐。
AccountsApi list_transaction_by_account GET /api/v1/accounts/{id}/transactions 列出与账户相关的所有交易。
AccountsApi store_account POST /api/v1/accounts 创建新账户。
AccountsApi update_account PUT /api/v1/accounts/{id} 更新现有账户。
AttachmentsApi delete_attachment DELETE /api/v1/attachments/{id} 删除附件。
AttachmentsApi download_attachment GET /api/v1/attachments/{id}/download 下载单个附件。
AttachmentsApi get_attachment GET /api/v1/attachments/{id} 获取单个附件。
AttachmentsApi list_attachment GET /api/v1/attachments 列出所有附件。
AttachmentsApi store_attachment POST /api/v1/attachments 存储新的附件。
AttachmentsApi update_attachment PUT /api/v1/attachments/{id} 更新现有附件。
AttachmentsApi upload_attachment POST /api/v1/attachments/{id}/upload 上传附件。
AutocompleteApi get_accounts_ac GET /api/v1/autocomplete/accounts 用户的所有账户以基本自动完成数组的形式返回。
AutocompleteApi get_bills_ac GET /api/v1/autocomplete/bills 用户的所有账单以基本自动完成数组的形式返回。
AutocompleteApi get_budgets_ac GET /api/v1/autocomplete/budgets 用户的所有预算以基本自动完成数组的形式返回。
AutocompleteApi get_categories_ac GET /api/v1/autocomplete/categories 用户的所有类别以基本自动完成数组的形式返回。
AutocompleteApi get_currencies_ac GET /api/v1/autocomplete/currencies 用户的所有货币以基本自动完成数组的形式返回。
AutocompleteApi get_currencies_code_ac GET /api/v1/autocomplete/currencies-with-code 用户的所有货币以基本自动完成数组的形式返回。
AutocompleteApi get_object_groups_ac GET /api/v1/autocomplete/object-groups 用户的所有对象组以基本自动完成数组的形式返回。
AutocompleteApi get_rule_groups_ac GET /api/v1/autocomplete/rule-groups 用户的所有规则组以基本自动完成数组的形式返回。
AutocompleteApi get_rules_ac GET /api/v1/autocomplete/rules 用户的所有规则以基本自动完成数组的形式返回。
AutocompleteApi get_tag_ac GET /api/v1/autocomplete/tags 用户的所有标签以基本自动完成数组的形式返回。
AutocompleteApi get_transaction_types_ac GET /api/v1/autocomplete/transaction-types 所有交易类型以基本自动完成数组的形式返回。仅英文。
AutocompleteApi get_transactions_ac GET /api/v1/autocomplete/transactions 用户的所有交易描述以基本自动完成数组的形式返回。
AutocompleteApi get_transactions_idac GET /api/v1/autocomplete/transactions-with-id 用户的所有交易，包括它们的ID，以基本自动完成数组的形式返回。
AvailableBudgetsApi delete_available_budget DELETE /api/v1/available_budgets/{id} 删除可用的预算。
AvailableBudgetsApi get_available_budget GET /api/v1/available_budgets/{id} 获取单个可用的预算。
AvailableBudgetsApi list_available_budget GET /api/v1/available_budgets 列出所有可用的预算金额。
AvailableBudgetsApi store_available_budget POST /api/v1/available_budgets 存储新的可用预算
AvailableBudgetsApi update_available_budget PUT /api/v1/available_budgets/{id} 更新现有可用预算，例如更改金额的日期范围或金额本身。
BillsApi delete_bill DELETE /api/v1/bills/{id} 删除账单。
BillsApi get_bill GET /api/v1/bills/{id} 获取单个账单。
BillsApi list_attachment_by_bill GET /api/v1/bills/{id}/attachments 列出上传到账单的所有附件。
BillsApi list_bill GET /api/v1/bills 列出所有账单。
BillsApi list_rule_by_bill GET /api/v1/bills/{id}/rules 列出与账单关联的所有规则。
BillsApi list_transaction_by_bill GET /api/v1/bills/{id}/transactions 列出与账单关联的所有交易。
BillsApi store_bill POST /api/v1/bills 存储新的账单
BillsApi update_bill PUT /api/v1/bills/{id} 更新现有账单。
BudgetsApi delete_budget DELETE /api/v1/budgets/{id} 删除预算。
BudgetsApi delete_budget_limit DELETE /api/v1/budgets/limits/{id} 删除预算限制。
BudgetsApi get_budget GET /api/v1/budgets/{id} 获取单个预算。
BudgetsApi get_budget_limit GET /api/v1/budgets/limits/{id} 获取单个预算限制。
BudgetsApi list_attachment_by_budget GET /api/v1/budgets/{id}/attachments 列出所有附件。
BudgetsApi list_budget GET /api/v1/budgets 列出所有预算。
BudgetsApi list_budget_limit_by_budget GET /api/v1/budgets/{id}/limits 获取所有限制。
BudgetsApi list_transaction_by_budget GET /api/v1/budgets/{id}/transactions 列出针对预算的所有交易。
BudgetsApi list_transaction_by_budget_limit GET /api/v1/budgets/limits/{id}/transactions 列出按预算限制ID的所有交易。
BudgetsApi store_budget POST /api/v1/budgets 存储新预算。
BudgetsApi store_budget_limit POST /api/v1/budgets/{id}/limits 存储新的预算限制。
BudgetsApi update_budget PUT /api/v1/budgets/{id} 更新现有预算。
BudgetsApi update_budget_limit PUT /api/v1/budgets/limits/{id} 更新现有预算限制。
CategoriesApi delete_category DELETE /api/v1/categories/{id} 删除一个分类。
CategoriesApi get_category GET /api/v1/categories/{id} 获取单个分类。
CategoriesApi list_attachment_by_category GET /api/v1/categories/{id}/attachments 列出所有附件。
CategoriesApi list_category GET /api/v1/categories 列出所有分类。
CategoriesApi list_transaction_by_category GET /api/v1/categories/{id}/transactions 列出分类中的所有交易。
CategoriesApi store_category POST /api/v1/categories 存储新分类。
CategoriesApi update_category PUT /api/v1/categories/{id} 更新现有分类。
ChartsApi get_chart_ab_overview GET /api/v1/chart/ab/overview/{id} 仪表板图表，显示可用预算概览。
ChartsApi get_chart_account_expense GET /api/v1/chart/account/expense 仪表板图表，显示支出账户余额信息。
ChartsApi get_chart_account_overview GET /api/v1/chart/account/overview 仪表板图表，显示资产账户余额信息。
ChartsApi get_chart_account_revenue GET /api/v1/chart/account/revenue 仪表板图表，显示收入账户余额信息。
ChartsApi get_chart_category_overview GET /api/v1/chart/category/overview 仪表板图表，显示用户分类概览。
ConfigurationApi get_configuration GET /api/v1/configuration 获取Firefly III系统配置。
ConfigurationApi set_configuration POST /api/v1/configuration/{name} 更新配置。
CurrenciesApi default_currency POST /api/v1/currencies/{code}/default 将货币设置为默认货币。
CurrenciesApi delete_currency DELETE /api/v1/currencies/{code} 删除货币。
CurrenciesApi disable_currency POST /api/v1/currencies/{code}/disable 禁用货币。
CurrenciesApi enable_currency POST /api/v1/currencies/{code}/enable 启用单个货币。
CurrenciesApi get_currency GET /api/v1/currencies/{code} 获取单个货币。
CurrenciesApi get_default_currency GET /api/v1/currencies/default 获取用户的默认货币。
CurrenciesApi list_account_by_currency GET /api/v1/currencies/{code}/accounts 列出使用此货币的所有账户。
CurrenciesApi list_available_budget_by_currency GET /api/v1/currencies/{code}/available_budgets 列出使用此货币的所有可用预算。
CurrenciesApi list_bill_by_currency GET /api/v1/currencies/{code}/bills 列出使用此货币的所有账单。
CurrenciesApi list_budget_limit_by_currency GET /api/v1/currencies/{code}/budget_limits 列出使用此货币的所有预算限制。
CurrenciesApi list_currency GET /api/v1/currencies 列出所有货币。
CurrenciesApi list_exchange_rate_by_currency GET /api/v1/currencies/{code}/cer 列出与（从或到）此货币的所有已知汇率。
CurrenciesApi list_recurrence_by_currency GET /api/v1/currencies/{code}/recurrences 列出使用此货币的所有定期交易。
CurrenciesApi list_rule_by_currency GET /api/v1/currencies/{code}/rules 列出使用此货币的所有规则。
CurrenciesApi list_transaction_by_currency GET /api/v1/currencies/{code}/transactions 列出所有该货币的交易。
CurrenciesApi store_currency POST /api/v1/currencies 存储新的货币
CurrenciesApi update_currency PUT /api/v1/currencies/{code} 更新现有货币。
CurrencyExchangeRatesApi get_exchange_rate GET /api/v1/cer 获取汇率。
DataApi destroy_data DELETE /api/v1/data/destroy 销毁用户数据的端点。
ImportApi get_import GET /api/v1/import/{key} 显示单个导入的信息。
ImportApi list_import GET /api/v1/import/list 列出所有导入。
ImportApi list_transaction_by_import GET /api/v1/import/{key}/transactions 列出与导入作业相关的所有交易。关联通过标签进行。
LinksApi delete_link_type DELETE /api/v1/link_types/{id} 永久删除链接类型。
LinksApi delete_transaction_link DELETE /api/v1/transaction_links/{id} 永久删除交易之间的链接。
LinksApi get_link_type GET /api/v1/link_types/{id} 获取单个链接类型。
LinksApi get_transaction_link GET /api/v1/transaction_links/{id} 获取单个链接。
LinksApi list_link_type GET /api/v1/link_types 列出所有链接类型。
LinksApi list_transaction_by_link_type GET /api/v1/link_types/{id}/transactions 列出此链接类型下的所有交易。
LinksApi list_transaction_link GET /api/v1/transaction_links 列出所有交易链接。
LinksApi store_link_type POST /api/v1/link_types 创建新的链接类型
LinksApi store_transaction_link POST /api/v1/transaction_links 在交易之间创建新的链接
LinksApi update_link_type PUT /api/v1/link_types/{id} 更新现有链接类型。
LinksApi update_transaction_link PUT /api/v1/transaction_links/{id} 更新现有交易之间的链接。
PiggyBanksApi delete_piggy_bank DELETE /api/v1/piggy_banks/{id} 删除一个存钱罐。
PiggyBanksApi get_piggy_bank GET /api/v1/piggy_banks/{id} 获取单个存钱罐。
PiggyBanksApi list_attachment_by_piggy_bank GET /api/v1/piggy_banks/{id}/attachments 列出所有附件。
PiggyBanksApi list_event_by_piggy_bank GET /api/v1/piggy_banks/{id}/events 列出与存钱罐相关的所有事件。
PiggyBanksApi list_piggy_bank GET /api/v1/piggy_banks 列出所有存钱罐。
PiggyBanksApi store_piggy_bank POST /api/v1/piggy_banks 存储新的存钱罐
PiggyBanksApi update_piggy_bank PUT /api/v1/piggy_banks/{id} 更新现有存钱罐。
PreferencesApi get_preference GET /api/v1/preferences/{name} 返回单个偏好设置。
PreferencesApi list_preference GET /api/v1/preferences 列出所有用户的偏好设置。
PreferencesApi update_preference PUT /api/v1/preferences/{name} 更新偏好设置。
RecurrencesApi delete_recurrence DELETE /api/v1/recurrences/{id} 删除周期性交易。
RecurrencesApi get_recurrence GET /api/v1/recurrences/{id} 获取单个周期性交易。
RecurrencesApi list_recurrence GET /api/v1/recurrences 列出所有周期性交易。
RecurrencesApi list_transaction_by_recurrence GET /api/v1/recurrences/{id}/transactions 列出由周期性交易创建的所有交易。
RecurrencesApi store_recurrence POST /api/v1/recurrences 存储新的周期性交易
RecurrencesApi trigger_recurrence POST /api/v1/recurrences/trigger 触发周期性交易的创建（如cron作业）。
RecurrencesApi update_recurrence PUT /api/v1/recurrences/{id} 更新现有周期性交易。
RuleGroupsApi delete_rule_group DELETE /api/v1/rule_groups/{id} 删除规则组。
RuleGroupsApi fire_rule_group POST /api/v1/rule_groups/{id}/trigger 在您的交易中触发规则组。
RuleGroupsApi get_rule_group GET /api/v1/rule_groups/{id} 获取单个规则组。
RuleGroupsApi list_rule_by_group GET /api/v1/rule_groups/{id}/rules 列出此规则组中的规则。
RuleGroupsApi list_rule_group GET /api/v1/rule_groups 列出所有规则组。
RuleGroupsApi store_rule_group POST /api/v1/rule_groups 存储新的规则组。
RuleGroupsApi test_rule_group GET /api/v1/rule_groups/{id}/test 测试规则组将影响哪些交易。不会进行任何更改。
RuleGroupsApi update_rule_group PUT /api/v1/rule_groups/{id} 更新现有规则组。
RulesApi delete_rule DELETE /api/v1/rules/{id} 删除规则。
RulesApi fire_rule POST /api/v1/rules/{id}/trigger 在您的交易中触发规则。
RulesApi get_rule GET /api/v1/rules/{id} 获取单个规则。
RulesApi list_rule GET /api/v1/rules 列出所有规则。
RulesApi store_rule POST /api/v1/rules 存储新的规则。
RulesApi test_rule GET /api/v1/rules/{id}/test 测试规则将影响哪些交易。不会进行任何更改。
RulesApi update_rule PUT /api/v1/rules/{id} 更新现有规则。
SearchApi search_accounts GET /api/v1/search/accounts 搜索账户。
SearchApi search_transactions GET /api/v1/search/transactions 搜索交易。
SummaryApi get_basic_summary GET /api/v1/summary/basic 返回用户数据的摘要。
TagsApi delete_tag DELETE /api/v1/tags/{tag} 删除标签。
TagsApi get_tag GET /api/v1/tags/{tag} 获取单个标签。
TagsApi get_tag_cloud GET /api/v1/tag-cloud 返回基本标签云。
TagsApi list_attachment_by_tag GET /api/v1/tags/{tag}/attachments 列出所有附件。
TagsApi list_tag GET /api/v1/tags 列出所有标签。
TagsApi list_transaction_by_tag GET /api/v1/tags/{tag}/transactions 列出带有此标签的所有交易。
TagsApi store_tag POST /api/v1/tags 存储新的标签。
TagsApi update_tag PUT /api/v1/tags/{tag} 更新现有标签。
TransactionsApi delete_transaction DELETE /api/v1/transactions/{id} 删除交易。
TransactionsApi get_transaction GET /api/v1/transactions/{id} 获取单个交易。
TransactionsApi get_transaction_by_journal GET /api/v1/transaction-journals/{id} 根据底层数据库获取单个交易。
TransactionsApi list_attachment_by_transaction GET /api/v1/transactions/{id}/attachments 列出所有附件。
TransactionsApi list_event_by_transaction GET /api/v1/transactions/{id}/piggy_bank_events 列出所有猪储蓄罐事件。
TransactionsApi list_transaction GET /api/v1/transactions 列出所有用户的交易。
TransactionsApi store_transaction POST /api/v1/transactions 存储新的交易。
TransactionsApi update_transaction PUT /api/v1/transactions/{id} 更新现有交易。
UsersApi delete_user DELETE /api/v1/users/{id} 删除用户。
UsersApi get_user GET /api/v1/users/{id} 获取单个用户。
UsersApi list_user GET /api/v1/users 列出所有用户。
UsersApi store_user POST /api/v1/users 存储新的用户。
UsersApi update_user PUT /api/v1/users/{id} 更新现有用户信息。

模型文档

要获取生成的文档，请使用

cargo doc --open

作者

[email protected]

依赖关系

~3–7.5MB
~170K SLoC