From aa52e632b866b51d455787a96bcd2f5a63b7ac89 Mon Sep 17 00:00:00 2001 From: Jesse Luehrs Date: Mon, 19 Aug 2019 00:19:38 -0400 Subject: move ynab-api to its own repository --- docs/AccountsApi.md | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 docs/AccountsApi.md (limited to 'docs/AccountsApi.md') diff --git a/docs/AccountsApi.md b/docs/AccountsApi.md new file mode 100644 index 0000000..98270b9 --- /dev/null +++ b/docs/AccountsApi.md @@ -0,0 +1,83 @@ +# \AccountsApi + +All URIs are relative to *https://api.youneedabudget.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_account_by_id**](AccountsApi.md#get_account_by_id) | **get** /budgets/{budget_id}/accounts/{account_id} | Single account +[**get_accounts**](AccountsApi.md#get_accounts) | **get** /budgets/{budget_id}/accounts | Account list + + + +## get_account_by_id + +> ::models::AccountResponse get_account_by_id(ctx, budget_id, account_id) +Single account + +Returns a single account + +### 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) | + **account_id** | [**String**](.md)| The id of the account | + +### Return type + +[**::models::AccountResponse**](AccountResponse.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_accounts + +> ::models::AccountsResponse get_accounts(ctx, budget_id, optional) +Account list + +Returns all accounts + +### 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::AccountsResponse**](AccountsResponse.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) + -- cgit v1.2.3-54-g00ecf