ynab 1.5.0 → 1.6.0

data/docs/CategoriesResponse.md

@@ -1,8 +0,0 @@
-# YNAB::CategoriesResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CategoryGroupsWrapper**](CategoryGroupsWrapper.md) |  | 
-
-

data/docs/Category.md

@@ -1,22 +0,0 @@
-# YNAB::Category
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | 
-**category_group_id** | **String** |  | 
-**name** | **String** |  | 
-**hidden** | **BOOLEAN** | 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** |  | 
-**budgeted** | **Integer** | Budgeted amount in current month in milliunits format | 
-**activity** | **Integer** | Activity amount in current month in milliunits format | 
-**balance** | **Integer** | Balance in current month 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) | 
-**goal_creation_month** | **Date** | The month a goal was created | 
-**goal_target** | **Integer** | The goal target amount in milliunits | 
-**goal_target_month** | **Date** | If the goal type is 'TBD' (Target Category Balance by Date), this is the target month for the goal to be completed | 
-**goal_percentage_complete** | **Integer** | The percentage completion of the goal | 
-**deleted** | **BOOLEAN** | Whether or not the category has been deleted.  Deleted categories will only be included in delta requests. | 
-
-

data/docs/CategoryGroup.md

@@ -1,11 +0,0 @@
-# YNAB::CategoryGroup
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | 
-**name** | **String** |  | 
-**hidden** | **BOOLEAN** | Whether or not the category group is hidden | 
-**deleted** | **BOOLEAN** | Whether or not the category group has been deleted.  Deleted category groups will only be included in delta requests. | 
-
-

data/docs/CategoryGroupWithCategories.md

@@ -1,12 +0,0 @@
-# YNAB::CategoryGroupWithCategories
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | 
-**name** | **String** |  | 
-**hidden** | **BOOLEAN** | Whether or not the category group is hidden | 
-**deleted** | **BOOLEAN** | Whether or not the category group has been deleted.  Deleted category groups will only be included in delta requests. | 
-**categories** | [**Array<Category>**](Category.md) | Category group categories | 
-
-

data/docs/CategoryGroupsWrapper.md

@@ -1,8 +0,0 @@
-# YNAB::CategoryGroupsWrapper
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**category_groups** | [**Array<CategoryGroupWithCategories>**](CategoryGroupWithCategories.md) |  | 
-
-

data/docs/CategoryResponse.md

@@ -1,8 +0,0 @@
-# YNAB::CategoryResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**CategoryWrapper**](CategoryWrapper.md) |  | 
-
-

data/docs/CategoryWrapper.md

@@ -1,8 +0,0 @@
-# YNAB::CategoryWrapper
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**category** | [**Category**](Category.md) |  | 
-
-

data/docs/CurrencyFormat.md

@@ -1,15 +0,0 @@
-# YNAB::CurrencyFormat
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**iso_code** | **String** |  | 
-**example_format** | **String** |  | 
-**decimal_digits** | **Integer** |  | 
-**decimal_separator** | **String** |  | 
-**symbol_first** | **BOOLEAN** |  | 
-**group_separator** | **String** |  | 
-**currency_symbol** | **String** |  | 
-**display_symbol** | **BOOLEAN** |  | 
-
-

data/docs/DateFormat.md

@@ -1,8 +0,0 @@
-# YNAB::DateFormat
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**format** | **String** |  | 
-
-

data/docs/ErrorDetail.md

@@ -1,10 +0,0 @@
-# YNAB::ErrorDetail
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | 
-**name** | **String** |  | 
-**detail** | **String** |  | 
-
-

data/docs/ErrorResponse.md

@@ -1,8 +0,0 @@
-# YNAB::ErrorResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**error** | [**ErrorDetail**](ErrorDetail.md) |  | 
-
-

data/docs/HybridTransaction.md

@@ -1,26 +0,0 @@
-# YNAB::HybridTransaction
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | 
-**date** | **Date** |  | 
-**amount** | **Integer** | The transaction amount in milliunits format | 
-**memo** | **String** |  | 
-**cleared** | **String** | The cleared status of the transaction | 
-**approved** | **BOOLEAN** | Whether or not the transaction is approved | 
-**flag_color** | **String** | The transaction flag | 
-**account_id** | **String** |  | 
-**payee_id** | **String** |  | 
-**category_id** | **String** |  | 
-**transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers | 
-**transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer | 
-**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'. | 
-**deleted** | **BOOLEAN** | 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. | 
-**account_name** | **String** |  | 
-**payee_name** | **String** |  | 
-**category_name** | **String** |  | 
-
-

data/docs/HybridTransactionsResponse.md

@@ -1,8 +0,0 @@
-# YNAB::HybridTransactionsResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**HybridTransactionsWrapper**](HybridTransactionsWrapper.md) |  | 
-
-

data/docs/HybridTransactionsWrapper.md

@@ -1,8 +0,0 @@
-# YNAB::HybridTransactionsWrapper
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**transactions** | [**Array<HybridTransaction>**](HybridTransaction.md) |  | 
-
-

data/docs/MonthDetail.md

@@ -1,15 +0,0 @@
-# YNAB::MonthDetail
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**month** | **Date** |  | 
-**note** | **String** |  | 
-**income** | **Integer** | The total amount in transactions categorized to 'Inflow: To be Budgeted' in the month | 
-**budgeted** | **Integer** | The total amount budgeted in the month | 
-**activity** | **Integer** | The total amount in transactions in the month, excluding those categorized to 'Inflow: To be Budgeted' | 
-**to_be_budgeted** | **Integer** | The available amount for 'To be Budgeted' | 
-**age_of_money** | **Integer** | The Age of Money as of the month | 
-**categories** | [**Array<Category>**](Category.md) | the budget month categories | 
-
-

data/docs/MonthDetailResponse.md

@@ -1,8 +0,0 @@
-# YNAB::MonthDetailResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**MonthDetailWrapper**](MonthDetailWrapper.md) |  | 
-
-

data/docs/MonthDetailWrapper.md

@@ -1,8 +0,0 @@
-# YNAB::MonthDetailWrapper
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**month** | [**MonthDetail**](MonthDetail.md) |  | 
-
-

data/docs/MonthSummariesResponse.md

@@ -1,8 +0,0 @@
-# YNAB::MonthSummariesResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**MonthSummariesWrapper**](MonthSummariesWrapper.md) |  | 
-
-

data/docs/MonthSummariesWrapper.md

@@ -1,8 +0,0 @@
-# YNAB::MonthSummariesWrapper
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**months** | [**Array<MonthSummary>**](MonthSummary.md) |  | 
-
-

data/docs/MonthSummary.md

@@ -1,14 +0,0 @@
-# YNAB::MonthSummary
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**month** | **Date** |  | 
-**note** | **String** |  | 
-**income** | **Integer** | The total amount in transactions categorized to 'Inflow: To be Budgeted' in the month | 
-**budgeted** | **Integer** | The total amount budgeted in the month | 
-**activity** | **Integer** | The total amount in transactions in the month, excluding those categorized to 'Inflow: To be Budgeted' | 
-**to_be_budgeted** | **Integer** | The available amount for 'To be Budgeted' | 
-**age_of_money** | **Integer** | The Age of Money as of the month | 
-
-

data/docs/MonthsApi.md

@@ -1,45 +0,0 @@
-# YNAB::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**
-> MonthDetailResponse get_budget_month(budget_id, month)
-
-Single budget month
-
-Returns a single budget month
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) | 
- **month** | **Date**| 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
-
-[**MonthDetailResponse**](MonthDetailResponse.md)
-
-# **get_budget_months**
-> MonthSummariesResponse get_budget_months(budget_id)
-
-List budget months
-
-Returns all budget months
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) | 
-
-### Return type
-
-[**MonthSummariesResponse**](MonthSummariesResponse.md)
-

data/docs/Payee.md

@@ -1,11 +0,0 @@
-# YNAB::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 | 
-**deleted** | **BOOLEAN** | Whether or not the payee has been deleted.  Deleted payees will only be included in delta requests. | 
-
-

data/docs/PayeeLocation.md

@@ -1,12 +0,0 @@
-# YNAB::PayeeLocation
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | 
-**payee_id** | **String** |  | 
-**latitude** | **String** |  | 
-**longitude** | **String** |  | 
-**deleted** | **BOOLEAN** | Whether or not the payee location has been deleted.  Deleted payee locations will only be included in delta requests. | 
-
-

data/docs/PayeeLocationResponse.md

@@ -1,8 +0,0 @@
-# YNAB::PayeeLocationResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**PayeeLocationWrapper**](PayeeLocationWrapper.md) |  | 
-
-

data/docs/PayeeLocationWrapper.md

@@ -1,8 +0,0 @@
-# YNAB::PayeeLocationWrapper
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payee_location** | [**PayeeLocation**](PayeeLocation.md) |  | 
-
-

data/docs/PayeeLocationsApi.md

@@ -1,64 +0,0 @@
-# YNAB::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**
-> PayeeLocationResponse get_payee_location_by_id(budget_id, payee_location_id)
-
-Single payee location
-
-Returns a single payee location
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) | 
- **payee_location_id** | [**String**](.md)| ID of payee location | 
-
-### Return type
-
-[**PayeeLocationResponse**](PayeeLocationResponse.md)
-
-# **get_payee_locations**
-> PayeeLocationsResponse get_payee_locations(budget_id)
-
-List payee locations
-
-Returns all payee locations
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) | 
-
-### Return type
-
-[**PayeeLocationsResponse**](PayeeLocationsResponse.md)
-
-# **get_payee_locations_by_payee**
-> PayeeLocationsResponse get_payee_locations_by_payee(budget_id, payee_id)
-
-List locations for a payee
-
-Returns all payee locations for the specified payee
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) | 
- **payee_id** | [**String**](.md)| id of payee | 
-
-### Return type
-
-[**PayeeLocationsResponse**](PayeeLocationsResponse.md)
-

data/docs/PayeeLocationsResponse.md

@@ -1,8 +0,0 @@
-# YNAB::PayeeLocationsResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**PayeeLocationsWrapper**](PayeeLocationsWrapper.md) |  | 
-
-

data/docs/PayeeLocationsWrapper.md

@@ -1,8 +0,0 @@
-# YNAB::PayeeLocationsWrapper
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payee_locations** | [**Array<PayeeLocation>**](PayeeLocation.md) |  | 
-
-

data/docs/PayeeResponse.md

@@ -1,8 +0,0 @@
-# YNAB::PayeeResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**PayeeWrapper**](PayeeWrapper.md) |  | 
-
-

data/docs/PayeeWrapper.md

@@ -1,8 +0,0 @@
-# YNAB::PayeeWrapper
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payee** | [**Payee**](Payee.md) |  | 
-
-