diff options
Diffstat (limited to 'ynab-api/docs/BudgetsApi.md')
| -rw-r--r-- | ynab-api/docs/BudgetsApi.md | 110 |
1 files changed, 0 insertions, 110 deletions
diff --git a/ynab-api/docs/BudgetsApi.md b/ynab-api/docs/BudgetsApi.md deleted file mode 100644 index 563b754..0000000 --- a/ynab-api/docs/BudgetsApi.md +++ /dev/null @@ -1,110 +0,0 @@ -# \BudgetsApi - -All URIs are relative to *https://api.youneedabudget.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_budget_by_id**](BudgetsApi.md#get_budget_by_id) | **get** /budgets/{budget_id} | Single budget -[**get_budget_settings_by_id**](BudgetsApi.md#get_budget_settings_by_id) | **get** /budgets/{budget_id}/settings | Budget Settings -[**get_budgets**](BudgetsApi.md#get_budgets) | **get** /budgets | List budgets - - - -## get_budget_by_id - -> ::models::BudgetDetailResponse get_budget_by_id(ctx, budget_id, optional) -Single budget - -Returns a single budget with all related entities. This resource is effectively a full budget export. - -### Required 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. | - -### Return type - -[**::models::BudgetDetailResponse**](BudgetDetailResponse.md) - -### Authorization - -[bearer](../README.md#bearer) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -## get_budget_settings_by_id - -> ::models::BudgetSettingsResponse get_budget_settings_by_id(ctx, budget_id) -Budget Settings - -Returns settings for a budget - -### Required 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) | - -### Return type - -[**::models::BudgetSettingsResponse**](BudgetSettingsResponse.md) - -### Authorization - -[bearer](../README.md#bearer) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -## get_budgets - -> ::models::BudgetSummaryResponse get_budgets(ctx, ) -List budgets - -Returns budgets list with summary information - -### Required Parameters - -This endpoint does not need any parameter. - -### Return type - -[**::models::BudgetSummaryResponse**](BudgetSummaryResponse.md) - -### Authorization - -[bearer](../README.md#bearer) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - |