diff options
Diffstat (limited to 'docs/BudgetsApi.md')
| -rw-r--r-- | docs/BudgetsApi.md | 43 |
1 files changed, 16 insertions, 27 deletions
diff --git a/docs/BudgetsApi.md b/docs/BudgetsApi.md index 563b754..d91cd6d 100644 --- a/docs/BudgetsApi.md +++ b/docs/BudgetsApi.md @@ -12,32 +12,22 @@ Method | HTTP request | Description ## get_budget_by_id -> ::models::BudgetDetailResponse get_budget_by_id(ctx, budget_id, optional) +> crate::models::BudgetDetailResponse get_budget_by_id(budget_id, last_knowledge_of_server) Single budget Returns a single budget with all related entities. This resource is effectively a full budget export. -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **budget_id** | **String**| The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | - **optional** | **map[string]interface{}** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a map[string]interface{}. - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **budget_id** | **String**| The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | - **last_knowledge_of_server** | **i64**| The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | +**last_knowledge_of_server** | **i64** | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included. | | ### Return type -[**::models::BudgetDetailResponse**](BudgetDetailResponse.md) +[**crate::models::BudgetDetailResponse**](BudgetDetailResponse.md) ### Authorization @@ -53,22 +43,21 @@ Name | Type | Description | Notes ## get_budget_settings_by_id -> ::models::BudgetSettingsResponse get_budget_settings_by_id(ctx, budget_id) +> crate::models::BudgetSettingsResponse get_budget_settings_by_id(budget_id) Budget Settings Returns settings for a budget -### Required Parameters +### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context containing the authentication | nil if no authentication - **budget_id** | **String**| The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**budget_id** | **String** | The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget) | Required | ### Return type -[**::models::BudgetSettingsResponse**](BudgetSettingsResponse.md) +[**crate::models::BudgetSettingsResponse**](BudgetSettingsResponse.md) ### Authorization @@ -84,18 +73,18 @@ Name | Type | Description | Notes ## get_budgets -> ::models::BudgetSummaryResponse get_budgets(ctx, ) +> crate::models::BudgetSummaryResponse get_budgets() List budgets Returns budgets list with summary information -### Required Parameters +### Parameters This endpoint does not need any parameter. ### Return type -[**::models::BudgetSummaryResponse**](BudgetSummaryResponse.md) +[**crate::models::BudgetSummaryResponse**](BudgetSummaryResponse.md) ### Authorization |