diff options
| author | Jesse Luehrs <doy@tozt.net> | 2019-08-19 00:19:38 -0400 |
|---|---|---|
| committer | Jesse Luehrs <doy@tozt.net> | 2019-08-19 00:19:38 -0400 |
| commit | aa52e632b866b51d455787a96bcd2f5a63b7ac89 (patch) | |
| tree | 7e947c62510404f6233be24c303d7fb6f455be0d /ynab-api/docs | |
| parent | 3539ceb20f5383a332a8ad1fcab816cf083f277e (diff) | |
| download | ynab-api-aa52e632b866b51d455787a96bcd2f5a63b7ac89.tar.gz ynab-api-aa52e632b866b51d455787a96bcd2f5a63b7ac89.zip | |
move ynab-api to its own repository
Diffstat (limited to 'ynab-api/docs')
94 files changed, 0 insertions, 2256 deletions
diff --git a/ynab-api/docs/Account.md b/ynab-api/docs/Account.md deleted file mode 100644 index 265294b..0000000 --- a/ynab-api/docs/Account.md +++ /dev/null @@ -1,21 +0,0 @@ -# Account - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | -**name** | **String** | | -**_type** | **String** | The type of account. Note: payPal, merchantAccount, investmentAccount, and mortgage types have been deprecated and will be removed in the future. | -**on_budget** | **bool** | Whether this account is on budget or not | -**closed** | **bool** | Whether this account is closed or not | -**note** | **String** | | [optional] -**balance** | **i64** | The current balance of the account in milliunits format | -**cleared_balance** | **i64** | The current cleared balance of the account in milliunits format | -**uncleared_balance** | **i64** | The current uncleared balance of the account in milliunits format | -**transfer_payee_id** | **String** | The payee id which should be used when transferring to this account | -**deleted** | **bool** | Whether or not the account has been deleted. Deleted accounts will only be included in delta requests. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/AccountResponse.md b/ynab-api/docs/AccountResponse.md deleted file mode 100644 index eb39808..0000000 --- a/ynab-api/docs/AccountResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# AccountResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::AccountResponseData**](AccountResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/AccountResponseData.md b/ynab-api/docs/AccountResponseData.md deleted file mode 100644 index d437a2f..0000000 --- a/ynab-api/docs/AccountResponseData.md +++ /dev/null @@ -1,11 +0,0 @@ -# AccountResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**account** | [***::models::Account**](Account.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/AccountsApi.md b/ynab-api/docs/AccountsApi.md deleted file mode 100644 index 98270b9..0000000 --- a/ynab-api/docs/AccountsApi.md +++ /dev/null @@ -1,83 +0,0 @@ -# \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) - diff --git a/ynab-api/docs/AccountsResponse.md b/ynab-api/docs/AccountsResponse.md deleted file mode 100644 index 6dc10dd..0000000 --- a/ynab-api/docs/AccountsResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# AccountsResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::AccountsResponseData**](AccountsResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/AccountsResponseData.md b/ynab-api/docs/AccountsResponseData.md deleted file mode 100644 index 968cad8..0000000 --- a/ynab-api/docs/AccountsResponseData.md +++ /dev/null @@ -1,12 +0,0 @@ -# AccountsResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**accounts** | [**Vec<::models::Account>**](Account.md) | | -**server_knowledge** | **i64** | The knowledge of the server | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/BudgetDetail.md b/ynab-api/docs/BudgetDetail.md deleted file mode 100644 index 3dac64b..0000000 --- a/ynab-api/docs/BudgetDetail.md +++ /dev/null @@ -1,27 +0,0 @@ -# BudgetDetail - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | -**name** | **String** | | -**last_modified_on** | **String** | The last time any changes were made to the budget from either a web or mobile client | [optional] -**first_month** | [***String**](string.md) | The earliest budget month | [optional] -**last_month** | [***String**](string.md) | The latest budget month | [optional] -**date_format** | [***::models::DateFormat**](DateFormat.md) | | [optional] -**currency_format** | [***::models::CurrencyFormat**](CurrencyFormat.md) | | [optional] -**accounts** | [**Vec<::models::Account>**](Account.md) | | [optional] -**payees** | [**Vec<::models::Payee>**](Payee.md) | | [optional] -**payee_locations** | [**Vec<::models::PayeeLocation>**](PayeeLocation.md) | | [optional] -**category_groups** | [**Vec<::models::CategoryGroup>**](CategoryGroup.md) | | [optional] -**categories** | [**Vec<::models::Category>**](Category.md) | | [optional] -**months** | [**Vec<::models::MonthDetail>**](MonthDetail.md) | | [optional] -**transactions** | [**Vec<::models::TransactionSummary>**](TransactionSummary.md) | | [optional] -**subtransactions** | [**Vec<::models::SubTransaction>**](SubTransaction.md) | | [optional] -**scheduled_transactions** | [**Vec<::models::ScheduledTransactionSummary>**](ScheduledTransactionSummary.md) | | [optional] -**scheduled_subtransactions** | [**Vec<::models::ScheduledSubTransaction>**](ScheduledSubTransaction.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/BudgetDetailAllOf.md b/ynab-api/docs/BudgetDetailAllOf.md deleted file mode 100644 index f5df347..0000000 --- a/ynab-api/docs/BudgetDetailAllOf.md +++ /dev/null @@ -1,20 +0,0 @@ -# BudgetDetailAllOf - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**accounts** | [**Vec<::models::Account>**](Account.md) | | [optional] -**payees** | [**Vec<::models::Payee>**](Payee.md) | | [optional] -**payee_locations** | [**Vec<::models::PayeeLocation>**](PayeeLocation.md) | | [optional] -**category_groups** | [**Vec<::models::CategoryGroup>**](CategoryGroup.md) | | [optional] -**categories** | [**Vec<::models::Category>**](Category.md) | | [optional] -**months** | [**Vec<::models::MonthDetail>**](MonthDetail.md) | | [optional] -**transactions** | [**Vec<::models::TransactionSummary>**](TransactionSummary.md) | | [optional] -**subtransactions** | [**Vec<::models::SubTransaction>**](SubTransaction.md) | | [optional] -**scheduled_transactions** | [**Vec<::models::ScheduledTransactionSummary>**](ScheduledTransactionSummary.md) | | [optional] -**scheduled_subtransactions** | [**Vec<::models::ScheduledSubTransaction>**](ScheduledSubTransaction.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/BudgetDetailResponse.md b/ynab-api/docs/BudgetDetailResponse.md deleted file mode 100644 index 97cc82e..0000000 --- a/ynab-api/docs/BudgetDetailResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# BudgetDetailResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::BudgetDetailResponseData**](BudgetDetailResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/BudgetDetailResponseData.md b/ynab-api/docs/BudgetDetailResponseData.md deleted file mode 100644 index 8697aae..0000000 --- a/ynab-api/docs/BudgetDetailResponseData.md +++ /dev/null @@ -1,12 +0,0 @@ -# BudgetDetailResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**budget** | [***::models::BudgetDetail**](BudgetDetail.md) | | -**server_knowledge** | **i64** | The knowledge of the server | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/BudgetSettings.md b/ynab-api/docs/BudgetSettings.md deleted file mode 100644 index b0604b4..0000000 --- a/ynab-api/docs/BudgetSettings.md +++ /dev/null @@ -1,12 +0,0 @@ -# BudgetSettings - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**date_format** | [***::models::DateFormat**](DateFormat.md) | | -**currency_format** | [***::models::CurrencyFormat**](CurrencyFormat.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/BudgetSettingsResponse.md b/ynab-api/docs/BudgetSettingsResponse.md deleted file mode 100644 index ee92163..0000000 --- a/ynab-api/docs/BudgetSettingsResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# BudgetSettingsResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::BudgetSettingsResponseData**](BudgetSettingsResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/BudgetSettingsResponseData.md b/ynab-api/docs/BudgetSettingsResponseData.md deleted file mode 100644 index 3d2c4cc..0000000 --- a/ynab-api/docs/BudgetSettingsResponseData.md +++ /dev/null @@ -1,11 +0,0 @@ -# BudgetSettingsResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**settings** | [***::models::BudgetSettings**](BudgetSettings.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/BudgetSummary.md b/ynab-api/docs/BudgetSummary.md deleted file mode 100644 index f2e444b..0000000 --- a/ynab-api/docs/BudgetSummary.md +++ /dev/null @@ -1,17 +0,0 @@ -# BudgetSummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | -**name** | **String** | | -**last_modified_on** | **String** | The last time any changes were made to the budget from either a web or mobile client | [optional] -**first_month** | [***String**](string.md) | The earliest budget month | [optional] -**last_month** | [***String**](string.md) | The latest budget month | [optional] -**date_format** | [***::models::DateFormat**](DateFormat.md) | | [optional] -**currency_format** | [***::models::CurrencyFormat**](CurrencyFormat.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/BudgetSummaryResponse.md b/ynab-api/docs/BudgetSummaryResponse.md deleted file mode 100644 index 5b029dd..0000000 --- a/ynab-api/docs/BudgetSummaryResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# BudgetSummaryResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::BudgetSummaryResponseData**](BudgetSummaryResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/BudgetSummaryResponseData.md b/ynab-api/docs/BudgetSummaryResponseData.md deleted file mode 100644 index 2836bfa..0000000 --- a/ynab-api/docs/BudgetSummaryResponseData.md +++ /dev/null @@ -1,12 +0,0 @@ -# BudgetSummaryResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**budgets** | [**Vec<::models::BudgetSummary>**](BudgetSummary.md) | | -**default_budget** | [***::models::BudgetSummary**](BudgetSummary.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - 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) - diff --git a/ynab-api/docs/BulkResponse.md b/ynab-api/docs/BulkResponse.md deleted file mode 100644 index 009e60c..0000000 --- a/ynab-api/docs/BulkResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# BulkResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::BulkResponseData**](BulkResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/BulkResponseData.md b/ynab-api/docs/BulkResponseData.md deleted file mode 100644 index 82fef82..0000000 --- a/ynab-api/docs/BulkResponseData.md +++ /dev/null @@ -1,11 +0,0 @@ -# BulkResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bulk** | [***::models::BulkResponseDataBulk**](BulkResponse_data_bulk.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/BulkResponseDataBulk.md b/ynab-api/docs/BulkResponseDataBulk.md deleted file mode 100644 index 97ff1dc..0000000 --- a/ynab-api/docs/BulkResponseDataBulk.md +++ /dev/null @@ -1,12 +0,0 @@ -# BulkResponseDataBulk - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transaction_ids** | **Vec<String>** | The list of Transaction ids that were created. | -**duplicate_import_ids** | **Vec<String>** | If any Transactions were not created because they had an import_id matching a transaction already on the same account, the specified import_id(s) will be included in this list. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/BulkTransactions.md b/ynab-api/docs/BulkTransactions.md deleted file mode 100644 index dc990e4..0000000 --- a/ynab-api/docs/BulkTransactions.md +++ /dev/null @@ -1,11 +0,0 @@ -# BulkTransactions - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transactions** | [**Vec<::models::SaveTransaction>**](SaveTransaction.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/CategoriesApi.md b/ynab-api/docs/CategoriesApi.md deleted file mode 100644 index 00294b8..0000000 --- a/ynab-api/docs/CategoriesApi.md +++ /dev/null @@ -1,152 +0,0 @@ -# \CategoriesApi - -All URIs are relative to *https://api.youneedabudget.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_categories**](CategoriesApi.md#get_categories) | **get** /budgets/{budget_id}/categories | List categories -[**get_category_by_id**](CategoriesApi.md#get_category_by_id) | **get** /budgets/{budget_id}/categories/{category_id} | Single category -[**get_month_category_by_id**](CategoriesApi.md#get_month_category_by_id) | **get** /budgets/{budget_id}/months/{month}/categories/{category_id} | Single category for a specific budget month -[**update_month_category**](CategoriesApi.md#update_month_category) | **patch** /budgets/{budget_id}/months/{month}/categories/{category_id} | Update a category for a specific month - - - -## get_categories - -> ::models::CategoriesResponse get_categories(ctx, budget_id, optional) -List categories - -Returns all categories grouped by category group. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). - -### 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::CategoriesResponse**](CategoriesResponse.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_category_by_id - -> ::models::CategoryResponse get_category_by_id(ctx, 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 - - -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 | - -### Return type - -[**::models::CategoryResponse**](CategoryResponse.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_month_category_by_id - -> ::models::CategoryResponse get_month_category_by_id(ctx, 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 - - -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 | - -### Return type - -[**::models::CategoryResponse**](CategoryResponse.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) - - -## update_month_category - -> ::models::SaveCategoryResponse update_month_category(ctx, budget_id, month, category_id, data) -Update a category for a specific month - -Update a category for a specific month - -### 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) | - **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 | - -### Return type - -[**::models::SaveCategoryResponse**](SaveCategoryResponse.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) - diff --git a/ynab-api/docs/CategoriesResponse.md b/ynab-api/docs/CategoriesResponse.md deleted file mode 100644 index e760b74..0000000 --- a/ynab-api/docs/CategoriesResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# CategoriesResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::CategoriesResponseData**](CategoriesResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/CategoriesResponseData.md b/ynab-api/docs/CategoriesResponseData.md deleted file mode 100644 index 766aae4..0000000 --- a/ynab-api/docs/CategoriesResponseData.md +++ /dev/null @@ -1,12 +0,0 @@ -# CategoriesResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**category_groups** | [**Vec<::models::CategoryGroupWithCategories>**](CategoryGroupWithCategories.md) | | -**server_knowledge** | **i64** | The knowledge of the server | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/Category.md b/ynab-api/docs/Category.md deleted file mode 100644 index 217979b..0000000 --- a/ynab-api/docs/Category.md +++ /dev/null @@ -1,25 +0,0 @@ -# Category - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | -**category_group_id** | **String** | | -**name** | **String** | | -**hidden** | **bool** | Whether or not the category is hidden | -**original_category_group_id** | **String** | If category is hidden this is the id of the category group it originally belonged to before it was hidden. | [optional] -**note** | **String** | | [optional] -**budgeted** | **i64** | Budgeted amount in milliunits format | -**activity** | **i64** | Activity amount in milliunits format | -**balance** | **i64** | Balance in milliunits format | -**goal_type** | **String** | The type of goal, if the cagegory has a goal (TB=Target Category Balance, TBD=Target Category Balance by Date, MF=Monthly Funding) | [optional] -**goal_creation_month** | [***String**](string.md) | The month a goal was created | [optional] -**goal_target** | **i64** | The goal target amount in milliunits | -**goal_target_month** | [***String**](string.md) | If the goal type is 'TBD' (Target Category Balance by Date), this is the target month for the goal to be completed | [optional] -**goal_percentage_complete** | **i32** | The percentage completion of the goal | [optional] -**deleted** | **bool** | Whether or not the category has been deleted. Deleted categories will only be included in delta requests. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/CategoryGroup.md b/ynab-api/docs/CategoryGroup.md deleted file mode 100644 index 498f3c5..0000000 --- a/ynab-api/docs/CategoryGroup.md +++ /dev/null @@ -1,14 +0,0 @@ -# CategoryGroup - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | -**name** | **String** | | -**hidden** | **bool** | Whether or not the category group is hidden | -**deleted** | **bool** | Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/CategoryGroupWithCategories.md b/ynab-api/docs/CategoryGroupWithCategories.md deleted file mode 100644 index c1355c2..0000000 --- a/ynab-api/docs/CategoryGroupWithCategories.md +++ /dev/null @@ -1,15 +0,0 @@ -# CategoryGroupWithCategories - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | -**name** | **String** | | -**hidden** | **bool** | Whether or not the category group is hidden | -**deleted** | **bool** | Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests. | -**categories** | [**Vec<::models::Category>**](Category.md) | Category group categories. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/CategoryGroupWithCategoriesAllOf.md b/ynab-api/docs/CategoryGroupWithCategoriesAllOf.md deleted file mode 100644 index 0a11fb9..0000000 --- a/ynab-api/docs/CategoryGroupWithCategoriesAllOf.md +++ /dev/null @@ -1,11 +0,0 @@ -# CategoryGroupWithCategoriesAllOf - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**categories** | [**Vec<::models::Category>**](Category.md) | Category group categories. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/CategoryResponse.md b/ynab-api/docs/CategoryResponse.md deleted file mode 100644 index efe3d40..0000000 --- a/ynab-api/docs/CategoryResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# CategoryResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::CategoryResponseData**](CategoryResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/CategoryResponseData.md b/ynab-api/docs/CategoryResponseData.md deleted file mode 100644 index 187bf07..0000000 --- a/ynab-api/docs/CategoryResponseData.md +++ /dev/null @@ -1,11 +0,0 @@ -# CategoryResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**category** | [***::models::Category**](Category.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/CurrencyFormat.md b/ynab-api/docs/CurrencyFormat.md deleted file mode 100644 index 98cd6fd..0000000 --- a/ynab-api/docs/CurrencyFormat.md +++ /dev/null @@ -1,18 +0,0 @@ -# CurrencyFormat - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**iso_code** | **String** | | -**example_format** | **String** | | -**decimal_digits** | **i32** | | -**decimal_separator** | **String** | | -**symbol_first** | **bool** | | -**group_separator** | **String** | | -**currency_symbol** | **String** | | -**display_symbol** | **bool** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/DateFormat.md b/ynab-api/docs/DateFormat.md deleted file mode 100644 index 53add08..0000000 --- a/ynab-api/docs/DateFormat.md +++ /dev/null @@ -1,11 +0,0 @@ -# DateFormat - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**format** | **String** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/DeprecatedApi.md b/ynab-api/docs/DeprecatedApi.md deleted file mode 100644 index 85bdc80..0000000 --- a/ynab-api/docs/DeprecatedApi.md +++ /dev/null @@ -1,41 +0,0 @@ -# \DeprecatedApi - -All URIs are relative to *https://api.youneedabudget.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**bulk_create_transactions**](DeprecatedApi.md#bulk_create_transactions) | **post** /budgets/{budget_id}/transactions/bulk | Bulk create transactions - - - -## bulk_create_transactions - -> ::models::BulkResponse bulk_create_transactions(ctx, budget_id, transactions) -Bulk create transactions - -Creates multiple transactions. Although this endpoint is still supported, it is recommended to use 'POST /budgets/{budget_id}/transactions' to create multiple transactions. - -### 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) | - **transactions** | [**BulkTransactions**](BulkTransactions.md)| The list of transactions to create | - -### Return type - -[**::models::BulkResponse**](BulkResponse.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) - diff --git a/ynab-api/docs/ErrorDetail.md b/ynab-api/docs/ErrorDetail.md deleted file mode 100644 index dd6d022..0000000 --- a/ynab-api/docs/ErrorDetail.md +++ /dev/null @@ -1,13 +0,0 @@ -# ErrorDetail - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | -**name** | **String** | | -**detail** | **String** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/ErrorResponse.md b/ynab-api/docs/ErrorResponse.md deleted file mode 100644 index 382b263..0000000 --- a/ynab-api/docs/ErrorResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# ErrorResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**error** | [***::models::ErrorDetail**](ErrorDetail.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/HybridTransaction.md b/ynab-api/docs/HybridTransaction.md deleted file mode 100644 index c168944..0000000 --- a/ynab-api/docs/HybridTransaction.md +++ /dev/null @@ -1,30 +0,0 @@ -# HybridTransaction - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | -**date** | [***String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01) | -**amount** | **i64** | The transaction amount in milliunits format | -**memo** | **String** | | [optional] -**cleared** | **String** | The cleared status of the transaction | -**approved** | **bool** | Whether or not the transaction is approved | -**flag_color** | **String** | The transaction flag | [optional] -**account_id** | **String** | | -**payee_id** | **String** | | [optional] -**category_id** | **String** | | [optional] -**transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers | [optional] -**transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer | [optional] -**matched_transaction_id** | **String** | If transaction is matched, the id of the matched transaction | [optional] -**import_id** | **String** | If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. | [optional] -**deleted** | **bool** | Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests. | -**_type** | **String** | Whether the hybrid transaction represents a regular transaction or a subtransaction | -**parent_transaction_id** | **String** | For subtransaction types, this is the id of the pararent transaction. For transaction types, this id will be always be null. | [optional] -**account_name** | **String** | | -**payee_name** | **String** | | [optional] -**category_name** | **String** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/HybridTransactionAllOf.md b/ynab-api/docs/HybridTransactionAllOf.md deleted file mode 100644 index af38160..0000000 --- a/ynab-api/docs/HybridTransactionAllOf.md +++ /dev/null @@ -1,15 +0,0 @@ -# HybridTransactionAllOf - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_type** | **String** | Whether the hybrid transaction represents a regular transaction or a subtransaction | -**parent_transaction_id** | **String** | For subtransaction types, this is the id of the pararent transaction. For transaction types, this id will be always be null. | [optional] -**account_name** | **String** | | -**payee_name** | **String** | | [optional] -**category_name** | **String** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/HybridTransactionsResponse.md b/ynab-api/docs/HybridTransactionsResponse.md deleted file mode 100644 index df8437a..0000000 --- a/ynab-api/docs/HybridTransactionsResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# HybridTransactionsResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::HybridTransactionsResponseData**](HybridTransactionsResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/HybridTransactionsResponseData.md b/ynab-api/docs/HybridTransactionsResponseData.md deleted file mode 100644 index 241e7b6..0000000 --- a/ynab-api/docs/HybridTransactionsResponseData.md +++ /dev/null @@ -1,11 +0,0 @@ -# HybridTransactionsResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transactions** | [**Vec<::models::HybridTransaction>**](HybridTransaction.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/MonthDetail.md b/ynab-api/docs/MonthDetail.md deleted file mode 100644 index 1d7a22b..0000000 --- a/ynab-api/docs/MonthDetail.md +++ /dev/null @@ -1,19 +0,0 @@ -# MonthDetail - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**month** | [***String**](string.md) | | -**note** | **String** | | [optional] -**income** | **i64** | The total amount in transactions categorized to 'Inflow: To be Budgeted' in the month | -**budgeted** | **i64** | The total amount budgeted in the month | -**activity** | **i64** | The total amount in transactions in the month, excluding those categorized to 'Inflow: To be Budgeted' | -**to_be_budgeted** | **i64** | The available amount for 'To be Budgeted' | -**age_of_money** | **i32** | The Age of Money as of the month | [optional] -**deleted** | **bool** | Whether or not the month has been deleted. Deleted months will only be included in delta requests. | -**categories** | [**Vec<::models::Category>**](Category.md) | The budget month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/MonthDetailAllOf.md b/ynab-api/docs/MonthDetailAllOf.md deleted file mode 100644 index 81da8f5..0000000 --- a/ynab-api/docs/MonthDetailAllOf.md +++ /dev/null @@ -1,11 +0,0 @@ -# MonthDetailAllOf - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**categories** | [**Vec<::models::Category>**](Category.md) | The budget month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/MonthDetailResponse.md b/ynab-api/docs/MonthDetailResponse.md deleted file mode 100644 index bfeaae8..0000000 --- a/ynab-api/docs/MonthDetailResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# MonthDetailResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::MonthDetailResponseData**](MonthDetailResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/MonthDetailResponseData.md b/ynab-api/docs/MonthDetailResponseData.md deleted file mode 100644 index 83bab88..0000000 --- a/ynab-api/docs/MonthDetailResponseData.md +++ /dev/null @@ -1,11 +0,0 @@ -# MonthDetailResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**month** | [***::models::MonthDetail**](MonthDetail.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/MonthSummariesResponse.md b/ynab-api/docs/MonthSummariesResponse.md deleted file mode 100644 index fb7f315..0000000 --- a/ynab-api/docs/MonthSummariesResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# MonthSummariesResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::MonthSummariesResponseData**](MonthSummariesResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/MonthSummariesResponseData.md b/ynab-api/docs/MonthSummariesResponseData.md deleted file mode 100644 index f9907b3..0000000 --- a/ynab-api/docs/MonthSummariesResponseData.md +++ /dev/null @@ -1,12 +0,0 @@ -# MonthSummariesResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**months** | [**Vec<::models::MonthSummary>**](MonthSummary.md) | | -**server_knowledge** | **i64** | The knowledge of the server | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/MonthSummary.md b/ynab-api/docs/MonthSummary.md deleted file mode 100644 index a78cbfc..0000000 --- a/ynab-api/docs/MonthSummary.md +++ /dev/null @@ -1,18 +0,0 @@ -# MonthSummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**month** | [***String**](string.md) | | -**note** | **String** | | [optional] -**income** | **i64** | The total amount in transactions categorized to 'Inflow: To be Budgeted' in the month | -**budgeted** | **i64** | The total amount budgeted in the month | -**activity** | **i64** | The total amount in transactions in the month, excluding those categorized to 'Inflow: To be Budgeted' | -**to_be_budgeted** | **i64** | The available amount for 'To be Budgeted' | -**age_of_money** | **i32** | The Age of Money as of the month | [optional] -**deleted** | **bool** | Whether or not the month has been deleted. Deleted months will only be included in delta requests. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/MonthsApi.md b/ynab-api/docs/MonthsApi.md deleted file mode 100644 index 337c03c..0000000 --- a/ynab-api/docs/MonthsApi.md +++ /dev/null @@ -1,83 +0,0 @@ -# \MonthsApi - -All URIs are relative to *https://api.youneedabudget.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_budget_month**](MonthsApi.md#get_budget_month) | **get** /budgets/{budget_id}/months/{month} | Single budget month -[**get_budget_months**](MonthsApi.md#get_budget_months) | **get** /budgets/{budget_id}/months | List budget months - - - -## get_budget_month - -> ::models::MonthDetailResponse get_budget_month(ctx, budget_id, month) -Single budget month - -Returns a single budget month - -### 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) | - **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)) | - -### Return type - -[**::models::MonthDetailResponse**](MonthDetailResponse.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_months - -> ::models::MonthSummariesResponse get_budget_months(ctx, budget_id, optional) -List budget months - -Returns all budget months - -### 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::MonthSummariesResponse**](MonthSummariesResponse.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) - diff --git a/ynab-api/docs/Payee.md b/ynab-api/docs/Payee.md deleted file mode 100644 index ff886e6..0000000 --- a/ynab-api/docs/Payee.md +++ /dev/null @@ -1,14 +0,0 @@ -# Payee - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | -**name** | **String** | | -**transfer_account_id** | **String** | If a transfer payee, the account_id to which this payee transfers to | [optional] -**deleted** | **bool** | Whether or not the payee has been deleted. Deleted payees will only be included in delta requests. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/PayeeLocation.md b/ynab-api/docs/PayeeLocation.md deleted file mode 100644 index f73c3be..0000000 --- a/ynab-api/docs/PayeeLocation.md +++ /dev/null @@ -1,15 +0,0 @@ -# PayeeLocation - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | -**payee_id** | **String** | | -**latitude** | **String** | | -**longitude** | **String** | | -**deleted** | **bool** | Whether or not the payee location has been deleted. Deleted payee locations will only be included in delta requests. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/PayeeLocationResponse.md b/ynab-api/docs/PayeeLocationResponse.md deleted file mode 100644 index b34e691..0000000 --- a/ynab-api/docs/PayeeLocationResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# PayeeLocationResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::PayeeLocationResponseData**](PayeeLocationResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/PayeeLocationResponseData.md b/ynab-api/docs/PayeeLocationResponseData.md deleted file mode 100644 index bba1cb7..0000000 --- a/ynab-api/docs/PayeeLocationResponseData.md +++ /dev/null @@ -1,11 +0,0 @@ -# PayeeLocationResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payee_location** | [***::models::PayeeLocation**](PayeeLocation.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/PayeeLocationsApi.md b/ynab-api/docs/PayeeLocationsApi.md deleted file mode 100644 index e51787a..0000000 --- a/ynab-api/docs/PayeeLocationsApi.md +++ /dev/null @@ -1,106 +0,0 @@ -# \PayeeLocationsApi - -All URIs are relative to *https://api.youneedabudget.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_payee_location_by_id**](PayeeLocationsApi.md#get_payee_location_by_id) | **get** /budgets/{budget_id}/payee_locations/{payee_location_id} | Single payee location -[**get_payee_locations**](PayeeLocationsApi.md#get_payee_locations) | **get** /budgets/{budget_id}/payee_locations | List payee locations -[**get_payee_locations_by_payee**](PayeeLocationsApi.md#get_payee_locations_by_payee) | **get** /budgets/{budget_id}/payees/{payee_id}/payee_locations | List locations for a payee - - - -## get_payee_location_by_id - -> ::models::PayeeLocationResponse get_payee_location_by_id(ctx, budget_id, payee_location_id) -Single payee location - -Returns a single payee location - -### 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) | - **payee_location_id** | **String**| id of payee location | - -### Return type - -[**::models::PayeeLocationResponse**](PayeeLocationResponse.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_payee_locations - -> ::models::PayeeLocationsResponse get_payee_locations(ctx, budget_id) -List payee locations - -Returns all payee locations - -### 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::PayeeLocationsResponse**](PayeeLocationsResponse.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_payee_locations_by_payee - -> ::models::PayeeLocationsResponse get_payee_locations_by_payee(ctx, budget_id, payee_id) -List locations for a payee - -Returns all payee locations for the specified payee - -### 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) | - **payee_id** | **String**| id of payee | - -### Return type - -[**::models::PayeeLocationsResponse**](PayeeLocationsResponse.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) - diff --git a/ynab-api/docs/PayeeLocationsResponse.md b/ynab-api/docs/PayeeLocationsResponse.md deleted file mode 100644 index f118e8e..0000000 --- a/ynab-api/docs/PayeeLocationsResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# PayeeLocationsResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::PayeeLocationsResponseData**](PayeeLocationsResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/PayeeLocationsResponseData.md b/ynab-api/docs/PayeeLocationsResponseData.md deleted file mode 100644 index 4ad0748..0000000 --- a/ynab-api/docs/PayeeLocationsResponseData.md +++ /dev/null @@ -1,11 +0,0 @@ -# PayeeLocationsResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payee_locations** | [**Vec<::models::PayeeLocation>**](PayeeLocation.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/PayeeResponse.md b/ynab-api/docs/PayeeResponse.md deleted file mode 100644 index 6a38dfd..0000000 --- a/ynab-api/docs/PayeeResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# PayeeResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::PayeeResponseData**](PayeeResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/PayeeResponseData.md b/ynab-api/docs/PayeeResponseData.md deleted file mode 100644 index 9618470..0000000 --- a/ynab-api/docs/PayeeResponseData.md +++ /dev/null @@ -1,11 +0,0 @@ -# PayeeResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payee** | [***::models::Payee**](Payee.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/PayeesApi.md b/ynab-api/docs/PayeesApi.md deleted file mode 100644 index 173c79d..0000000 --- a/ynab-api/docs/PayeesApi.md +++ /dev/null @@ -1,83 +0,0 @@ -# \PayeesApi - -All URIs are relative to *https://api.youneedabudget.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_payee_by_id**](PayeesApi.md#get_payee_by_id) | **get** /budgets/{budget_id}/payees/{payee_id} | Single payee -[**get_payees**](PayeesApi.md#get_payees) | **get** /budgets/{budget_id}/payees | List payees - - - -## get_payee_by_id - -> ::models::PayeeResponse get_payee_by_id(ctx, budget_id, payee_id) -Single payee - -Returns single payee - -### 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) | - **payee_id** | **String**| The id of the payee | - -### Return type - -[**::models::PayeeResponse**](PayeeResponse.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_payees - -> ::models::PayeesResponse get_payees(ctx, budget_id, optional) -List payees - -Returns all payees - -### 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::PayeesResponse**](PayeesResponse.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) - diff --git a/ynab-api/docs/PayeesResponse.md b/ynab-api/docs/PayeesResponse.md deleted file mode 100644 index 18bd7d2..0000000 --- a/ynab-api/docs/PayeesResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# PayeesResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::PayeesResponseData**](PayeesResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/PayeesResponseData.md b/ynab-api/docs/PayeesResponseData.md deleted file mode 100644 index c3a5518..0000000 --- a/ynab-api/docs/PayeesResponseData.md +++ /dev/null @@ -1,12 +0,0 @@ -# PayeesResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payees** | [**Vec<::models::Payee>**](Payee.md) | | -**server_knowledge** | **i64** | The knowledge of the server | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/SaveCategoryResponse.md b/ynab-api/docs/SaveCategoryResponse.md deleted file mode 100644 index 64a832f..0000000 --- a/ynab-api/docs/SaveCategoryResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# SaveCategoryResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::SaveCategoryResponseData**](SaveCategoryResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/SaveCategoryResponseData.md b/ynab-api/docs/SaveCategoryResponseData.md deleted file mode 100644 index 941f72f..0000000 --- a/ynab-api/docs/SaveCategoryResponseData.md +++ /dev/null @@ -1,12 +0,0 @@ -# SaveCategoryResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**category** | [***::models::Category**](Category.md) | | -**server_knowledge** | **i64** | The knowledge of the server | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/SaveMonthCategory.md b/ynab-api/docs/SaveMonthCategory.md deleted file mode 100644 index 1c4abb9..0000000 --- a/ynab-api/docs/SaveMonthCategory.md +++ /dev/null @@ -1,11 +0,0 @@ -# SaveMonthCategory - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**budgeted** | **i64** | Budgeted amount in milliunits format | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/SaveMonthCategoryWrapper.md b/ynab-api/docs/SaveMonthCategoryWrapper.md deleted file mode 100644 index 1b7e38a..0000000 --- a/ynab-api/docs/SaveMonthCategoryWrapper.md +++ /dev/null @@ -1,11 +0,0 @@ -# SaveMonthCategoryWrapper - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**category** | [***::models::SaveMonthCategory**](SaveMonthCategory.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/SaveTransaction.md b/ynab-api/docs/SaveTransaction.md deleted file mode 100644 index dabee87..0000000 --- a/ynab-api/docs/SaveTransaction.md +++ /dev/null @@ -1,21 +0,0 @@ -# SaveTransaction - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**account_id** | **String** | | -**date** | [***String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored. | -**amount** | **i64** | The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored. | -**payee_id** | **String** | The payee for the transaction | [optional] -**payee_name** | **String** | The payee name. If a payee_name value is provided and payee_id has a null value, the payee_name value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified) or (2) a payee with the same name or (3) creation of a new payee. | [optional] -**category_id** | **String** | The category for the transaction. Split and Credit Card Payment categories are not permitted and will be ignored if supplied. If an existing transaction has a Split category it cannot be changed. | [optional] -**memo** | **String** | | [optional] -**cleared** | **String** | The cleared status of the transaction | [optional] -**approved** | **bool** | Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default. | [optional] -**flag_color** | **String** | The transaction flag | [optional] -**import_id** | **String** | If specified, the new transaction will be assigned this import_id and considered \"imported\". *At the time of import* we will attempt to match \"imported\" transactions with non-imported (i.e. \"user-entered\") transactions.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a \"user-entered\" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API). | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/SaveTransactionWrapper.md b/ynab-api/docs/SaveTransactionWrapper.md deleted file mode 100644 index a9f3fcc..0000000 --- a/ynab-api/docs/SaveTransactionWrapper.md +++ /dev/null @@ -1,11 +0,0 @@ -# SaveTransactionWrapper - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transaction** | [***::models::SaveTransaction**](SaveTransaction.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/SaveTransactionsResponse.md b/ynab-api/docs/SaveTransactionsResponse.md deleted file mode 100644 index 0458ef6..0000000 --- a/ynab-api/docs/SaveTransactionsResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# SaveTransactionsResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::SaveTransactionsResponseData**](SaveTransactionsResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/SaveTransactionsResponseData.md b/ynab-api/docs/SaveTransactionsResponseData.md deleted file mode 100644 index 8617702..0000000 --- a/ynab-api/docs/SaveTransactionsResponseData.md +++ /dev/null @@ -1,15 +0,0 @@ -# SaveTransactionsResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transaction_ids** | **Vec<String>** | The transaction ids that were saved | -**transaction** | [***::models::TransactionDetail**](TransactionDetail.md) | | [optional] -**transactions** | [**Vec<::models::TransactionDetail>**](TransactionDetail.md) | If multiple transactions were specified, the transactions that were saved | [optional] -**duplicate_import_ids** | **Vec<String>** | If multiple transactions were specified, a list of import_ids that were not created because of an existing import_id found on the same account | [optional] -**server_knowledge** | **i64** | The knowledge of the server | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/SaveTransactionsWrapper.md b/ynab-api/docs/SaveTransactionsWrapper.md deleted file mode 100644 index d79e4ee..0000000 --- a/ynab-api/docs/SaveTransactionsWrapper.md +++ /dev/null @@ -1,12 +0,0 @@ -# SaveTransactionsWrapper - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transaction** | [***::models::SaveTransaction**](SaveTransaction.md) | | [optional] -**transactions** | [**Vec<::models::SaveTransaction>**](SaveTransaction.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/ScheduledSubTransaction.md b/ynab-api/docs/ScheduledSubTransaction.md deleted file mode 100644 index 6178bab..0000000 --- a/ynab-api/docs/ScheduledSubTransaction.md +++ /dev/null @@ -1,18 +0,0 @@ -# ScheduledSubTransaction - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | -**scheduled_transaction_id** | **String** | | -**amount** | **i64** | The scheduled subtransaction amount in milliunits format | -**memo** | **String** | | [optional] -**payee_id** | **String** | | [optional] -**category_id** | **String** | | -**transfer_account_id** | **String** | If a transfer, the account_id which the scheduled subtransaction transfers to | [optional] -**deleted** | **bool** | Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/ScheduledTransactionDetail.md b/ynab-api/docs/ScheduledTransactionDetail.md deleted file mode 100644 index 5f45c7e..0000000 --- a/ynab-api/docs/ScheduledTransactionDetail.md +++ /dev/null @@ -1,26 +0,0 @@ -# ScheduledTransactionDetail - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | -**date_first** | [***String**](string.md) | The first date for which the Scheduled Transaction was scheduled. | -**date_next** | [***String**](string.md) | The next date for which the Scheduled Transaction is scheduled. | -**frequency** | **String** | | -**amount** | **i64** | The scheduled transaction amount in milliunits format | -**memo** | **String** | | [optional] -**flag_color** | **String** | The scheduled transaction flag | -**account_id** | **String** | | -**payee_id** | **String** | | [optional] -**category_id** | **String** | | -**transfer_account_id** | **String** | If a transfer, the account_id which the scheduled transaction transfers to | [optional] -**deleted** | **bool** | Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests. | -**account_name** | **String** | | -**payee_name** | **String** | | -**category_name** | **String** | | -**subtransactions** | [**Vec<::models::ScheduledSubTransaction>**](ScheduledSubTransaction.md) | If a split scheduled transaction, the subtransactions. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/ScheduledTransactionDetailAllOf.md b/ynab-api/docs/ScheduledTransactionDetailAllOf.md deleted file mode 100644 index 3c2757f..0000000 --- a/ynab-api/docs/ScheduledTransactionDetailAllOf.md +++ /dev/null @@ -1,14 +0,0 @@ -# ScheduledTransactionDetailAllOf - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**account_name** | **String** | | -**payee_name** | **String** | | -**category_name** | **String** | | -**subtransactions** | [**Vec<::models::ScheduledSubTransaction>**](ScheduledSubTransaction.md) | If a split scheduled transaction, the subtransactions. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/ScheduledTransactionResponse.md b/ynab-api/docs/ScheduledTransactionResponse.md deleted file mode 100644 index 28c4b7e..0000000 --- a/ynab-api/docs/ScheduledTransactionResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# ScheduledTransactionResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::ScheduledTransactionResponseData**](ScheduledTransactionResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/ScheduledTransactionResponseData.md b/ynab-api/docs/ScheduledTransactionResponseData.md deleted file mode 100644 index bd05d93..0000000 --- a/ynab-api/docs/ScheduledTransactionResponseData.md +++ /dev/null @@ -1,11 +0,0 @@ -# ScheduledTransactionResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**scheduled_transaction** | [***::models::ScheduledTransactionDetail**](ScheduledTransactionDetail.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/ScheduledTransactionSummary.md b/ynab-api/docs/ScheduledTransactionSummary.md deleted file mode 100644 index 4b248b0..0000000 --- a/ynab-api/docs/ScheduledTransactionSummary.md +++ /dev/null @@ -1,22 +0,0 @@ -# ScheduledTransactionSummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | -**date_first** | [***String**](string.md) | The first date for which the Scheduled Transaction was scheduled. | -**date_next** | [***String**](string.md) | The next date for which the Scheduled Transaction is scheduled. | -**frequency** | **String** | | -**amount** | **i64** | The scheduled transaction amount in milliunits format | -**memo** | **String** | | [optional] -**flag_color** | **String** | The scheduled transaction flag | -**account_id** | **String** | | -**payee_id** | **String** | | [optional] -**category_id** | **String** | | -**transfer_account_id** | **String** | If a transfer, the account_id which the scheduled transaction transfers to | [optional] -**deleted** | **bool** | Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/ScheduledTransactionsApi.md b/ynab-api/docs/ScheduledTransactionsApi.md deleted file mode 100644 index 48856a7..0000000 --- a/ynab-api/docs/ScheduledTransactionsApi.md +++ /dev/null @@ -1,83 +0,0 @@ -# \ScheduledTransactionsApi - -All URIs are relative to *https://api.youneedabudget.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_scheduled_transaction_by_id**](ScheduledTransactionsApi.md#get_scheduled_transaction_by_id) | **get** /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id} | Single scheduled transaction -[**get_scheduled_transactions**](ScheduledTransactionsApi.md#get_scheduled_transactions) | **get** /budgets/{budget_id}/scheduled_transactions | List scheduled transactions - - - -## get_scheduled_transaction_by_id - -> ::models::ScheduledTransactionResponse get_scheduled_transaction_by_id(ctx, budget_id, scheduled_transaction_id) -Single scheduled transaction - -Returns a single scheduled transaction - -### 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) | - **scheduled_transaction_id** | **String**| The id of the scheduled transaction | - -### Return type - -[**::models::ScheduledTransactionResponse**](ScheduledTransactionResponse.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_scheduled_transactions - -> ::models::ScheduledTransactionsResponse get_scheduled_transactions(ctx, budget_id, optional) -List scheduled transactions - -Returns all scheduled transactions - -### 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::ScheduledTransactionsResponse**](ScheduledTransactionsResponse.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) - diff --git a/ynab-api/docs/ScheduledTransactionsResponse.md b/ynab-api/docs/ScheduledTransactionsResponse.md deleted file mode 100644 index b3dbffc..0000000 --- a/ynab-api/docs/ScheduledTransactionsResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# ScheduledTransactionsResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::ScheduledTransactionsResponseData**](ScheduledTransactionsResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/ScheduledTransactionsResponseData.md b/ynab-api/docs/ScheduledTransactionsResponseData.md deleted file mode 100644 index f5bc860..0000000 --- a/ynab-api/docs/ScheduledTransactionsResponseData.md +++ /dev/null @@ -1,12 +0,0 @@ -# ScheduledTransactionsResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**scheduled_transactions** | [**Vec<::models::ScheduledTransactionDetail>**](ScheduledTransactionDetail.md) | | -**server_knowledge** | **i64** | The knowledge of the server | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/SubTransaction.md b/ynab-api/docs/SubTransaction.md deleted file mode 100644 index 77bad7f..0000000 --- a/ynab-api/docs/SubTransaction.md +++ /dev/null @@ -1,18 +0,0 @@ -# SubTransaction - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | -**transaction_id** | **String** | | -**amount** | **i64** | The subtransaction amount in milliunits format | -**memo** | **String** | | [optional] -**payee_id** | **String** | | [optional] -**category_id** | **String** | | [optional] -**transfer_account_id** | **String** | If a transfer, the account_id which the subtransaction transfers to | [optional] -**deleted** | **bool** | Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/TransactionDetail.md b/ynab-api/docs/TransactionDetail.md deleted file mode 100644 index 3d23f44..0000000 --- a/ynab-api/docs/TransactionDetail.md +++ /dev/null @@ -1,29 +0,0 @@ -# TransactionDetail - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | -**date** | [***String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01) | -**amount** | **i64** | The transaction amount in milliunits format | -**memo** | **String** | | [optional] -**cleared** | **String** | The cleared status of the transaction | -**approved** | **bool** | Whether or not the transaction is approved | -**flag_color** | **String** | The transaction flag | [optional] -**account_id** | **String** | | -**payee_id** | **String** | | [optional] -**category_id** | **String** | | [optional] -**transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers | [optional] -**transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer | [optional] -**matched_transaction_id** | **String** | If transaction is matched, the id of the matched transaction | [optional] -**import_id** | **String** | If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. | [optional] -**deleted** | **bool** | Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests. | -**account_name** | **String** | | -**payee_name** | **String** | | [optional] -**category_name** | **String** | | [optional] -**subtransactions** | [**Vec<::models::SubTransaction>**](SubTransaction.md) | If a split transaction, the subtransactions. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/TransactionDetailAllOf.md b/ynab-api/docs/TransactionDetailAllOf.md deleted file mode 100644 index 2db8459..0000000 --- a/ynab-api/docs/TransactionDetailAllOf.md +++ /dev/null @@ -1,14 +0,0 @@ -# TransactionDetailAllOf - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**account_name** | **String** | | -**payee_name** | **String** | | [optional] -**category_name** | **String** | | [optional] -**subtransactions** | [**Vec<::models::SubTransaction>**](SubTransaction.md) | If a split transaction, the subtransactions. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/TransactionResponse.md b/ynab-api/docs/TransactionResponse.md deleted file mode 100644 index ac81dfa..0000000 --- a/ynab-api/docs/TransactionResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# TransactionResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::TransactionResponseData**](TransactionResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/TransactionResponseData.md b/ynab-api/docs/TransactionResponseData.md deleted file mode 100644 index 81977f0..0000000 --- a/ynab-api/docs/TransactionResponseData.md +++ /dev/null @@ -1,11 +0,0 @@ -# TransactionResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transaction** | [***::models::TransactionDetail**](TransactionDetail.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/TransactionSummary.md b/ynab-api/docs/TransactionSummary.md deleted file mode 100644 index fd93b15..0000000 --- a/ynab-api/docs/TransactionSummary.md +++ /dev/null @@ -1,25 +0,0 @@ -# TransactionSummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | -**date** | [***String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01) | -**amount** | **i64** | The transaction amount in milliunits format | -**memo** | **String** | | [optional] -**cleared** | **String** | The cleared status of the transaction | -**approved** | **bool** | Whether or not the transaction is approved | -**flag_color** | **String** | The transaction flag | [optional] -**account_id** | **String** | | -**payee_id** | **String** | | [optional] -**category_id** | **String** | | [optional] -**transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers | [optional] -**transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer | [optional] -**matched_transaction_id** | **String** | If transaction is matched, the id of the matched transaction | [optional] -**import_id** | **String** | If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. | [optional] -**deleted** | **bool** | Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/TransactionsApi.md b/ynab-api/docs/TransactionsApi.md deleted file mode 100644 index 64ecb4b..0000000 --- a/ynab-api/docs/TransactionsApi.md +++ /dev/null @@ -1,323 +0,0 @@ -# \TransactionsApi - -All URIs are relative to *https://api.youneedabudget.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_transaction**](TransactionsApi.md#create_transaction) | **post** /budgets/{budget_id}/transactions | Create a single transaction or multiple transactions -[**get_transaction_by_id**](TransactionsApi.md#get_transaction_by_id) | **get** /budgets/{budget_id}/transactions/{transaction_id} | Single transaction -[**get_transactions**](TransactionsApi.md#get_transactions) | **get** /budgets/{budget_id}/transactions | List transactions -[**get_transactions_by_account**](TransactionsApi.md#get_transactions_by_account) | **get** /budgets/{budget_id}/accounts/{account_id}/transactions | List account transactions -[**get_transactions_by_category**](TransactionsApi.md#get_transactions_by_category) | **get** /budgets/{budget_id}/categories/{category_id}/transactions | List category transactions -[**get_transactions_by_payee**](TransactionsApi.md#get_transactions_by_payee) | **get** /budgets/{budget_id}/payees/{payee_id}/transactions | List payee transactions -[**update_transaction**](TransactionsApi.md#update_transaction) | **put** /budgets/{budget_id}/transactions/{transaction_id} | Updates an existing transaction -[**update_transactions**](TransactionsApi.md#update_transactions) | **patch** /budgets/{budget_id}/transactions | Update multiple transactions - - - -## create_transaction - -> ::models::SaveTransactionsResponse create_transaction(ctx, budget_id, data) -Create a single transaction or multiple transactions - -Creates a single transaction or multiple transactions. If you provide a body containing a 'transaction' object, a single transaction will be created and if you provide a body containing a 'transactions' array, multiple transactions will be created. Scheduled transactions cannot be created on this endpoint. - -### 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) | - **data** | [**SaveTransactionsWrapper**](SaveTransactionsWrapper.md)| The transaction or transactions to create. To create a single transaction you can specify a value for the 'transaction' object and to create multiple transactions you can specify an array of 'transactions'. It is expected that you will only provide a value for one of these objects. | - -### Return type - -[**::models::SaveTransactionsResponse**](SaveTransactionsResponse.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_transaction_by_id - -> ::models::TransactionResponse get_transaction_by_id(ctx, budget_id, transaction_id) -Single transaction - -Returns a single transaction - -### 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) | - **transaction_id** | **String**| The id of the transaction | - -### Return type - -[**::models::TransactionResponse**](TransactionResponse.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_transactions - -> ::models::TransactionsResponse get_transactions(ctx, budget_id, optional) -List transactions - -Returns budget transactions - -### 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) | - **since_date** | **String**| If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | - **_type** | **String**| If specified, only transactions of the specified type will be included. 'uncategorized' and 'unapproved' are currently supported. | - **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::TransactionsResponse**](TransactionsResponse.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_transactions_by_account - -> ::models::TransactionsResponse get_transactions_by_account(ctx, budget_id, account_id, optional) -List account transactions - -Returns all transactions for a specified 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**| The id of the account | - **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) | - **account_id** | **String**| The id of the account | - **since_date** | **String**| If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | - **_type** | **String**| If specified, only transactions of the specified type will be included. 'uncategorized' and 'unapproved' are currently supported. | - **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::TransactionsResponse**](TransactionsResponse.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_transactions_by_category - -> ::models::HybridTransactionsResponse get_transactions_by_category(ctx, budget_id, category_id, optional) -List category transactions - -Returns all transactions for a specified category - -### 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) | - **category_id** | **String**| The id of the category | - **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) | - **category_id** | **String**| The id of the category | - **since_date** | **String**| If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | - **_type** | **String**| If specified, only transactions of the specified type will be included. 'uncategorized' and 'unapproved' are currently supported. | - **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::HybridTransactionsResponse**](HybridTransactionsResponse.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_transactions_by_payee - -> ::models::HybridTransactionsResponse get_transactions_by_payee(ctx, budget_id, payee_id, optional) -List payee transactions - -Returns all transactions for a specified payee - -### 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) | - **payee_id** | **String**| The id of the payee | - **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) | - **payee_id** | **String**| The id of the payee | - **since_date** | **String**| If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | - **_type** | **String**| If specified, only transactions of the specified type will be included. 'uncategorized' and 'unapproved' are currently supported. | - **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::HybridTransactionsResponse**](HybridTransactionsResponse.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) - - -## update_transaction - -> ::models::TransactionResponse update_transaction(ctx, budget_id, transaction_id, data) -Updates an existing transaction - -Updates a transaction - -### 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) | - **transaction_id** | **String**| The id of the transaction | - **data** | [**UpdateTransactionWrapper**](UpdateTransactionWrapper.md)| The transaction to update | - -### Return type - -[**::models::TransactionResponse**](TransactionResponse.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) - - -## update_transactions - -> ::models::UpdateTransactionsResponse update_transactions(ctx, budget_id, data) -Update multiple transactions - -Updates multiple transactions, by 'id' or 'import_id'. - -### 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) | - **data** | [**UpdateTransactionsWrapper**](UpdateTransactionsWrapper.md)| The transactions to update. Optionally, transaction 'id' value(s) can be specified as null and an 'import_id' value can be provided which will allow transaction(s) to updated by their import_id. | - -### Return type - -[**::models::UpdateTransactionsResponse**](UpdateTransactionsResponse.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) - diff --git a/ynab-api/docs/TransactionsResponse.md b/ynab-api/docs/TransactionsResponse.md deleted file mode 100644 index fec6f21..0000000 --- a/ynab-api/docs/TransactionsResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# TransactionsResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::TransactionsResponseData**](TransactionsResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/TransactionsResponseData.md b/ynab-api/docs/TransactionsResponseData.md deleted file mode 100644 index 2b64bf7..0000000 --- a/ynab-api/docs/TransactionsResponseData.md +++ /dev/null @@ -1,12 +0,0 @@ -# TransactionsResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transactions** | [**Vec<::models::TransactionDetail>**](TransactionDetail.md) | | -**server_knowledge** | **i64** | The knowledge of the server | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/UpdateTransaction.md b/ynab-api/docs/UpdateTransaction.md deleted file mode 100644 index 6d6ecb0..0000000 --- a/ynab-api/docs/UpdateTransaction.md +++ /dev/null @@ -1,22 +0,0 @@ -# UpdateTransaction - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | [optional] -**account_id** | **String** | | -**date** | [***String**](string.md) | The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored. | -**amount** | **i64** | The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored. | -**payee_id** | **String** | The payee for the transaction | [optional] -**payee_name** | **String** | The payee name. If a payee_name value is provided and payee_id has a null value, the payee_name value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified) or (2) a payee with the same name or (3) creation of a new payee. | [optional] -**category_id** | **String** | The category for the transaction. Split and Credit Card Payment categories are not permitted and will be ignored if supplied. If an existing transaction has a Split category it cannot be changed. | [optional] -**memo** | **String** | | [optional] -**cleared** | **String** | The cleared status of the transaction | [optional] -**approved** | **bool** | Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default. | [optional] -**flag_color** | **String** | The transaction flag | [optional] -**import_id** | **String** | If specified, the new transaction will be assigned this import_id and considered \"imported\". *At the time of import* we will attempt to match \"imported\" transactions with non-imported (i.e. \"user-entered\") transactions.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a \"user-entered\" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API). | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/UpdateTransactionWrapper.md b/ynab-api/docs/UpdateTransactionWrapper.md deleted file mode 100644 index df6846f..0000000 --- a/ynab-api/docs/UpdateTransactionWrapper.md +++ /dev/null @@ -1,11 +0,0 @@ -# UpdateTransactionWrapper - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transaction** | [***::models::UpdateTransaction**](UpdateTransaction.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/UpdateTransactionsResponse.md b/ynab-api/docs/UpdateTransactionsResponse.md deleted file mode 100644 index 77e6431..0000000 --- a/ynab-api/docs/UpdateTransactionsResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# UpdateTransactionsResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::SaveTransactionsResponseData**](SaveTransactionsResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/UpdateTransactionsWrapper.md b/ynab-api/docs/UpdateTransactionsWrapper.md deleted file mode 100644 index f039804..0000000 --- a/ynab-api/docs/UpdateTransactionsWrapper.md +++ /dev/null @@ -1,12 +0,0 @@ -# UpdateTransactionsWrapper - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transaction** | [***::models::UpdateTransaction**](UpdateTransaction.md) | | [optional] -**transactions** | [**Vec<::models::UpdateTransaction>**](UpdateTransaction.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/User.md b/ynab-api/docs/User.md deleted file mode 100644 index 28cb9e0..0000000 --- a/ynab-api/docs/User.md +++ /dev/null @@ -1,11 +0,0 @@ -# User - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/UserApi.md b/ynab-api/docs/UserApi.md deleted file mode 100644 index c2f9359..0000000 --- a/ynab-api/docs/UserApi.md +++ /dev/null @@ -1,36 +0,0 @@ -# \UserApi - -All URIs are relative to *https://api.youneedabudget.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_user**](UserApi.md#get_user) | **get** /user | User info - - - -## get_user - -> ::models::UserResponse get_user(ctx, ) -User info - -Returns authenticated user information - -### Required Parameters - -This endpoint does not need any parameter. - -### Return type - -[**::models::UserResponse**](UserResponse.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) - diff --git a/ynab-api/docs/UserResponse.md b/ynab-api/docs/UserResponse.md deleted file mode 100644 index 31b0d2f..0000000 --- a/ynab-api/docs/UserResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# UserResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [***::models::UserResponseData**](UserResponse_data.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/ynab-api/docs/UserResponseData.md b/ynab-api/docs/UserResponseData.md deleted file mode 100644 index 3aff41b..0000000 --- a/ynab-api/docs/UserResponseData.md +++ /dev/null @@ -1,11 +0,0 @@ -# UserResponseData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | [***::models::User**](User.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - |