diff options
Diffstat (limited to 'docs/CategoriesApi.md')
| -rw-r--r-- | docs/CategoriesApi.md | 75 |
1 files changed, 31 insertions, 44 deletions
diff --git a/docs/CategoriesApi.md b/docs/CategoriesApi.md index 00294b8..4266752 100644 --- a/docs/CategoriesApi.md +++ b/docs/CategoriesApi.md @@ -13,32 +13,22 @@ Method | HTTP request | Description ## get_categories -> ::models::CategoriesResponse get_categories(ctx, budget_id, optional) +> crate::models::CategoriesResponse get_categories(budget_id, last_knowledge_of_server) List categories Returns all categories grouped by category group. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). -### 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::CategoriesResponse**](CategoriesResponse.md) +[**crate::models::CategoriesResponse**](CategoriesResponse.md) ### Authorization @@ -54,23 +44,22 @@ Name | Type | Description | Notes ## get_category_by_id -> ::models::CategoryResponse get_category_by_id(ctx, budget_id, category_id) +> crate::models::CategoryResponse get_category_by_id(budget_id, category_id) Single category Returns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). -### 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) | - **category_id** | **String**| The id of the category | +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 | +**category_id** | **String** | The id of the category | Required | ### Return type -[**::models::CategoryResponse**](CategoryResponse.md) +[**crate::models::CategoryResponse**](CategoryResponse.md) ### Authorization @@ -86,24 +75,23 @@ Name | Type | Description | Notes ## get_month_category_by_id -> ::models::CategoryResponse get_month_category_by_id(ctx, budget_id, month, category_id) +> crate::models::CategoryResponse get_month_category_by_id(budget_id, month, category_id) Single category for a specific budget month Returns a single category for a specific budget month. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). -### 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) | - **month** | **String**| The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) | - **category_id** | **String**| The id of the category | +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 | +**month** | **String** | The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) | Required | +**category_id** | **String** | The id of the category | Required | ### Return type -[**::models::CategoryResponse**](CategoryResponse.md) +[**crate::models::CategoryResponse**](CategoryResponse.md) ### Authorization @@ -119,25 +107,24 @@ Name | Type | Description | Notes ## update_month_category -> ::models::SaveCategoryResponse update_month_category(ctx, budget_id, month, category_id, data) +> crate::models::SaveCategoryResponse update_month_category(budget_id, month, category_id, data) Update a category for a specific month Update a category for a specific month -### 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) | - **month** | **String**| The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) | - **category_id** | **String**| The id of the category | - **data** | [**SaveMonthCategoryWrapper**](SaveMonthCategoryWrapper.md)| The category to update | +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 | +**month** | **String** | The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) | Required | +**category_id** | **String** | The id of the category | Required | +**data** | [**SaveMonthCategoryWrapper**](SaveMonthCategoryWrapper.md) | The category to update | Required | ### Return type -[**::models::SaveCategoryResponse**](SaveCategoryResponse.md) +[**crate::models::SaveCategoryResponse**](SaveCategoryResponse.md) ### Authorization |