ynab 0.1.0

data/docs/CategoryGroupsWrapper.md

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

data/docs/CategoryResponse.md

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

data/docs/CategoryWrapper.md

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

data/docs/CurrencyFormat.md

@@ -0,0 +1,8 @@
+# YnabApi::CurrencyFormat
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**locale** | **String** |  | 
+
+

data/docs/DateFormat.md

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

data/docs/ErrorDetail.md

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

data/docs/ErrorResponse.md

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

data/docs/MonthDetail.md

@@ -0,0 +1,12 @@
+# YnabApi::MonthDetail
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**month** | **Date** |  | 
+**note** | **String** |  | 
+**to_be_budgeted** | **Float** | The current balance of the account in milliunits format | 
+**age_of_money** | **Float** |  | 
+**categories** | [**Array<Category>**](Category.md) | The budget month categories | 
+
+

data/docs/MonthDetailResponse.md

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

data/docs/MonthDetailWrapper.md

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

data/docs/MonthSummariesResponse.md

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

data/docs/MonthSummariesWrapper.md

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

data/docs/MonthSummary.md

@@ -0,0 +1,11 @@
+# YnabApi::MonthSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**month** | **Date** |  | 
+**note** | **String** |  | 
+**to_be_budgeted** | **Float** | The current balance of the account in milliunits format | 
+**age_of_money** | **Float** |  | 
+
+

data/docs/MonthsApi.md

@@ -0,0 +1,121 @@
+# YnabApi::MonthsApi
+
+All URIs are relative to *https://api.youneedabudget.com/papi/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
+
+### Example
+```ruby
+# load the gem
+require 'ynab'
+# setup authorization
+YnabApi.configure do |config|
+  # Configure API key authorization: bearer
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = YnabApi::MonthsApi.new
+
+budget_id = "budget_id_example" # String | The ID of the Budget.
+
+month = Date.parse("2013-10-20") # Date | The Budget Month.  \"current\" can also be used to specify the current calendar month (UTC).
+
+
+begin
+  #Single budget month
+  result = api_instance.get_budget_month(budget_id, month)
+  p result
+rescue YnabApi::ApiError => e
+  puts "Exception when calling MonthsApi->get_budget_month: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget_id** | [**String**](.md)| The ID of the Budget. | 
+ **month** | **Date**| The Budget Month.  \"current\" can also be used to specify the current calendar month (UTC). | 
+
+### Return type
+
+[**MonthDetailResponse**](MonthDetailResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_budget_months**
+> MonthSummariesResponse get_budget_months(budget_id)
+
+List budget months
+
+Returns all budget months
+
+### Example
+```ruby
+# load the gem
+require 'ynab'
+# setup authorization
+YnabApi.configure do |config|
+  # Configure API key authorization: bearer
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = YnabApi::MonthsApi.new
+
+budget_id = "budget_id_example" # String | The ID of the Budget.
+
+
+begin
+  #List budget months
+  result = api_instance.get_budget_months(budget_id)
+  p result
+rescue YnabApi::ApiError => e
+  puts "Exception when calling MonthsApi->get_budget_months: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget_id** | [**String**](.md)| The ID of the Budget. | 
+
+### Return type
+
+[**MonthSummariesResponse**](MonthSummariesResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/Payee.md

@@ -0,0 +1,10 @@
+# YnabApi::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 | 
+
+

data/docs/PayeeLocation.md

@@ -0,0 +1,11 @@
+# YnabApi::PayeeLocation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**payee_id** | **String** |  | 
+**latitude** | **String** |  | 
+**longitude** | **String** |  | 
+
+

data/docs/PayeeLocationResponse.md

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

data/docs/PayeeLocationWrapper.md

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

data/docs/PayeeLocationsApi.md

@@ -0,0 +1,179 @@
+# YnabApi::PayeeLocationsApi
+
+All URIs are relative to *https://api.youneedabudget.com/papi/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
+
+### Example
+```ruby
+# load the gem
+require 'ynab'
+# setup authorization
+YnabApi.configure do |config|
+  # Configure API key authorization: bearer
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = YnabApi::PayeeLocationsApi.new
+
+budget_id = "budget_id_example" # String | The ID of the Budget.
+
+payee_location_id = "payee_location_id_example" # String | ID of payee location
+
+
+begin
+  #Single payee location
+  result = api_instance.get_payee_location_by_id(budget_id, payee_location_id)
+  p result
+rescue YnabApi::ApiError => e
+  puts "Exception when calling PayeeLocationsApi->get_payee_location_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget_id** | [**String**](.md)| The ID of the Budget. | 
+ **payee_location_id** | [**String**](.md)| ID of payee location | 
+
+### Return type
+
+[**PayeeLocationResponse**](PayeeLocationResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_payee_locations**
+> PayeeLocationsResponse get_payee_locations(budget_id)
+
+List payee locations
+
+Returns all payee locations
+
+### Example
+```ruby
+# load the gem
+require 'ynab'
+# setup authorization
+YnabApi.configure do |config|
+  # Configure API key authorization: bearer
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = YnabApi::PayeeLocationsApi.new
+
+budget_id = "budget_id_example" # String | The ID of the Budget.
+
+
+begin
+  #List payee locations
+  result = api_instance.get_payee_locations(budget_id)
+  p result
+rescue YnabApi::ApiError => e
+  puts "Exception when calling PayeeLocationsApi->get_payee_locations: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget_id** | [**String**](.md)| The ID of the Budget. | 
+
+### Return type
+
+[**PayeeLocationsResponse**](PayeeLocationsResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **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
+
+### Example
+```ruby
+# load the gem
+require 'ynab'
+# setup authorization
+YnabApi.configure do |config|
+  # Configure API key authorization: bearer
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = YnabApi::PayeeLocationsApi.new
+
+budget_id = "budget_id_example" # String | The ID of the Budget.
+
+payee_id = "payee_id_example" # String | ID of payee
+
+
+begin
+  #List locations for a payee
+  result = api_instance.get_payee_locations_by_payee(budget_id, payee_id)
+  p result
+rescue YnabApi::ApiError => e
+  puts "Exception when calling PayeeLocationsApi->get_payee_locations_by_payee: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget_id** | [**String**](.md)| The ID of the Budget. | 
+ **payee_id** | [**String**](.md)| ID of payee | 
+
+### Return type
+
+[**PayeeLocationsResponse**](PayeeLocationsResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+