ynab 0.1.0

data/docs/AccountsResponse.md

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

data/docs/AccountsWrapper.md

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

data/docs/BudgetDetail.md

@@ -0,0 +1,22 @@
+# YnabApi::BudgetDetail
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** |  | 
+**last_modified_on** | **DateTime** | The last time any changes were made to the budget from either a web or mobile client. | [optional] 
+**date_format** | [**DateFormat**](DateFormat.md) |  | [optional] 
+**currency_format** | [**CurrencyFormat**](CurrencyFormat.md) |  | [optional] 
+**accounts** | [**Array<Account>**](Account.md) |  | [optional] 
+**payees** | [**Array<Payee>**](Payee.md) |  | [optional] 
+**payee_locations** | [**Array<PayeeLocation>**](PayeeLocation.md) |  | [optional] 
+**category_groups** | [**Array<CategoryGroup>**](CategoryGroup.md) |  | [optional] 
+**categories** | [**Array<Category>**](Category.md) |  | [optional] 
+**months** | [**Array<MonthDetail>**](MonthDetail.md) |  | [optional] 
+**transactions** | [**Array<TransactionSummary>**](TransactionSummary.md) |  | [optional] 
+**subtransactions** | [**Array<SubTransaction>**](SubTransaction.md) |  | [optional] 
+**scheduled_transactions** | [**Array<ScheduledTransactionSummary>**](ScheduledTransactionSummary.md) |  | [optional] 
+**scheduled_subtransactions** | [**Array<ScheduledSubTransaction>**](ScheduledSubTransaction.md) |  | [optional] 
+
+

data/docs/BudgetDetailResponse.md

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

data/docs/BudgetDetailWrapper.md

@@ -0,0 +1,9 @@
+# YnabApi::BudgetDetailWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**budget** | [**BudgetDetail**](BudgetDetail.md) |  | 
+**server_knowledge** | **Float** | The knowledge of the server | 
+
+

data/docs/BudgetSummary.md

@@ -0,0 +1,12 @@
+# YnabApi::BudgetSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** |  | 
+**last_modified_on** | **DateTime** | The last time any changes were made to the budget from either a web or mobile client. | [optional] 
+**date_format** | [**DateFormat**](DateFormat.md) |  | [optional] 
+**currency_format** | [**CurrencyFormat**](CurrencyFormat.md) |  | [optional] 
+
+

data/docs/BudgetSummaryResponse.md

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

data/docs/BudgetSummaryWrapper.md

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

data/docs/BudgetsApi.md

@@ -0,0 +1,116 @@
+# YnabApi::BudgetsApi
+
+All URIs are relative to *https://api.youneedabudget.com/papi/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_budget_by_id**](BudgetsApi.md#get_budget_by_id) | **GET** /budgets/{budget_id} | Single budget
+[**get_budgets**](BudgetsApi.md#get_budgets) | **GET** /budgets | List budgets
+
+
+# **get_budget_by_id**
+> BudgetDetailResponse get_budget_by_id(budget_id, opts)
+
+Single budget
+
+Returns a single budget with all related entities.  This resource is effectively a full budget export.
+
+### 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::BudgetsApi.new
+
+budget_id = "budget_id_example" # String | The ID of the Budget.
+
+opts = { 
+  last_knowledge_of_server: 8.14 # Float | The starting server knowledge.  If provided, only entities that have changed since last_knowledge_of_server will be included.
+}
+
+begin
+  #Single budget
+  result = api_instance.get_budget_by_id(budget_id, opts)
+  p result
+rescue YnabApi::ApiError => e
+  puts "Exception when calling BudgetsApi->get_budget_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget_id** | [**String**](.md)| The ID of the Budget. | 
+ **last_knowledge_of_server** | **Float**| The starting server knowledge.  If provided, only entities that have changed since last_knowledge_of_server will be included. | [optional] 
+
+### Return type
+
+[**BudgetDetailResponse**](BudgetDetailResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_budgets**
+> BudgetSummaryResponse get_budgets
+
+List budgets
+
+Returns budgets list with summary information.
+
+### 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::BudgetsApi.new
+
+begin
+  #List budgets
+  result = api_instance.get_budgets
+  p result
+rescue YnabApi::ApiError => e
+  puts "Exception when calling BudgetsApi->get_budgets: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**BudgetSummaryResponse**](BudgetSummaryResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/BulkIdWrapper.md

@@ -0,0 +1,8 @@
+# YnabApi::BulkIdWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bulk** | [**BulkIds**](BulkIds.md) |  | 
+
+

data/docs/BulkIds.md

@@ -0,0 +1,9 @@
+# YnabApi::BulkIds
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_ids** | **Array<String>** | The list of Transaction IDs that were created. | 
+**duplicate_import_ids** | **Array<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. | 
+
+

data/docs/BulkResponse.md

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

data/docs/BulkTransactionCreateResponse.md

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

data/docs/BulkTransactionIds.md

@@ -0,0 +1,8 @@
+# YnabApi::BulkTransactionIds
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_ids** | **Array<String>** |  | 
+
+

data/docs/BulkTransactions.md

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

data/docs/CategoriesApi.md

@@ -0,0 +1,121 @@
+# YnabApi::CategoriesApi
+
+All URIs are relative to *https://api.youneedabudget.com/papi/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_categories**
+> CategoriesResponse get_categories(budget_id)
+
+List categories
+
+Returns all categories grouped by category group.
+
+### 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::CategoriesApi.new
+
+budget_id = "budget_id_example" # String | The ID of the Budget.
+
+
+begin
+  #List categories
+  result = api_instance.get_categories(budget_id)
+  p result
+rescue YnabApi::ApiError => e
+  puts "Exception when calling CategoriesApi->get_categories: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget_id** | [**String**](.md)| The ID of the Budget. | 
+
+### Return type
+
+[**CategoriesResponse**](CategoriesResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_category_by_id**
+> CategoryResponse get_category_by_id(budget_id, category_id)
+
+Single category
+
+Returns a single category
+
+### 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::CategoriesApi.new
+
+budget_id = "budget_id_example" # String | The ID of the Budget.
+
+category_id = "category_id_example" # String | The ID of the Category.
+
+
+begin
+  #Single category
+  result = api_instance.get_category_by_id(budget_id, category_id)
+  p result
+rescue YnabApi::ApiError => e
+  puts "Exception when calling CategoriesApi->get_category_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget_id** | [**String**](.md)| The ID of the Budget. | 
+ **category_id** | [**String**](.md)| The ID of the Category. | 
+
+### Return type
+
+[**CategoryResponse**](CategoryResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/CategoriesResponse.md

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

data/docs/Category.md

@@ -0,0 +1,15 @@
+# YnabApi::Category
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**category_group_id** | **String** |  | 
+**name** | **String** |  | 
+**hidden** | **BOOLEAN** | Whether or not the category is hidden | 
+**note** | **String** |  | 
+**budgeted** | **Float** | Budgeted amount in current month in milliunits format | 
+**activity** | **Float** | Activity amount in current month in milliunits format | 
+**balance** | **Float** | Balance in current month in milliunits format | 
+
+

data/docs/CategoryGroup.md

@@ -0,0 +1,10 @@
+# YnabApi::CategoryGroup
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** |  | 
+**hidden** | **BOOLEAN** | Whether or not the category group is hidden | 
+
+

data/docs/CategoryGroupWithCategories.md

@@ -0,0 +1,11 @@
+# YnabApi::CategoryGroupWithCategories
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** |  | 
+**hidden** | **BOOLEAN** | Whether or not the category group is hidden | 
+**categories** | [**Array<Category>**](Category.md) | Category group categories | 
+
+