aboutsummaryrefslogtreecommitdiffstats
path: root/ynab-api/docs/AccountsApi.md
diff options
context:
space:
mode:
authorJesse Luehrs <doy@tozt.net>2019-08-09 02:06:22 -0400
committerJesse Luehrs <doy@tozt.net>2019-08-09 02:52:44 -0400
commitfaf9c8aa1e41df1889f8382e9c2183e2d5f85de1 (patch)
tree0e4218dd5c1d47735fd6324fb30a01c964aad781 /ynab-api/docs/AccountsApi.md
parentd54b8f01ea9c253a326a9601f58a423a64ba8b4a (diff)
downloadynab-api-faf9c8aa1e41df1889f8382e9c2183e2d5f85de1.tar.gz
ynab-api-faf9c8aa1e41df1889f8382e9c2183e2d5f85de1.zip
add openapi-generated api client
Diffstat (limited to 'ynab-api/docs/AccountsApi.md')
-rw-r--r--ynab-api/docs/AccountsApi.md83
1 files changed, 83 insertions, 0 deletions
diff --git a/ynab-api/docs/AccountsApi.md b/ynab-api/docs/AccountsApi.md
new file mode 100644
index 0000000..98270b9
--- /dev/null
+++ b/ynab-api/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)
+