ynab 0.1.0

data/docs/PayeeLocationsResponse.md

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

data/docs/PayeeLocationsWrapper.md

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

data/docs/PayeeResponse.md

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

data/docs/PayeeWrapper.md

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

data/docs/PayeesApi.md

@@ -0,0 +1,121 @@
+# YnabApi::PayeesApi
+
+All URIs are relative to *https://api.youneedabudget.com/papi/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**
+> PayeeResponse get_payee_by_id(budget_id, payee_id)
+
+Single payee
+
+Returns single 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::PayeesApi.new
+
+budget_id = "budget_id_example" # String | The ID of the Budget.
+
+payee_id = "payee_id_example" # String | The ID of the Payee.
+
+
+begin
+  #Single payee
+  result = api_instance.get_payee_by_id(budget_id, payee_id)
+  p result
+rescue YnabApi::ApiError => e
+  puts "Exception when calling PayeesApi->get_payee_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget_id** | [**String**](.md)| The ID of the Budget. | 
+ **payee_id** | [**String**](.md)| The ID of the Payee. | 
+
+### Return type
+
+[**PayeeResponse**](PayeeResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_payees**
+> PayeesResponse get_payees(budget_id)
+
+List payees
+
+Returns all payees
+
+### 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::PayeesApi.new
+
+budget_id = "budget_id_example" # String | The ID of the Budget.
+
+
+begin
+  #List payees
+  result = api_instance.get_payees(budget_id)
+  p result
+rescue YnabApi::ApiError => e
+  puts "Exception when calling PayeesApi->get_payees: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget_id** | [**String**](.md)| The ID of the Budget. | 
+
+### Return type
+
+[**PayeesResponse**](PayeesResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/PayeesResponse.md

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

data/docs/PayeesWrapper.md

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

data/docs/SaveTransaction.md

@@ -0,0 +1,18 @@
+# YnabApi::SaveTransaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** |  | 
+**date** | **Date** |  | 
+**amount** | **Float** | The transaction amount in milliunits format | 
+**payee_id** | **String** | The payee for the transaction.  Transfer payees are not permitted and will be ignored if supplied. | [optional] 
+**payee_name** | **String** | The payee name.  If a payee_name value is provided and payee_id is not included or has a null value, payee_name will be used to create or use an existing 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. | [optional] 
+**memo** | **String** |  | [optional] 
+**cleared** | **String** | The cleared status of the transaction | [optional] 
+**approved** | **BOOLEAN** | 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 for a new transaction, the transaction will be treated as Imported and assigned this import_id.  If another transaction on the same account with this same import_id is later attempted to be created, it will be skipped to prevent duplication.  Transactions imported through File Based Import or Direct Import and not through the API, are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurance]'.  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.  If import_id is specified as null, the transaction will be treated as a user entered transaction. | [optional] 
+
+

data/docs/SaveTransactionWrapper.md

@@ -0,0 +1,8 @@
+# YnabApi::SaveTransactionWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction** | [**SaveTransaction**](SaveTransaction.md) |  | 
+
+

data/docs/ScheduledSubTransaction.md

@@ -0,0 +1,14 @@
+# YnabApi::ScheduledSubTransaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**scheduled_transaction_id** | **String** |  | 
+**amount** | **Float** | The scheduled sub-transaction amount in milliunits format | 
+**memo** | **String** |  | 
+**payee_id** | **String** |  | 
+**category_id** | **String** |  | 
+**transfer_account_id** | **String** | If a transfer, the account_id which the scheduled sub transaction transfers to | 
+
+

data/docs/ScheduledTransactionDetail.md

@@ -0,0 +1,19 @@
+# YnabApi::ScheduledTransactionDetail
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**date_first** | **Date** | The first date for which the Scheduled Transaction was scheduled. | 
+**date_next** | **Date** | The next date for which the Scheduled Transaction is scheduled. | 
+**frequency** | **String** |  | 
+**amount** | **Float** | The scheduled transaction amount in milliunits format | 
+**memo** | **String** |  | 
+**flag_color** | **String** |  | 
+**account_id** | **String** |  | 
+**payee_id** | **String** |  | 
+**category_id** | **String** |  | 
+**transfer_account_id** | **String** | If a transfer, the account_id which the scheduled transaction transfers to | 
+**subtransactions** | [**Array<ScheduledSubTransaction>**](ScheduledSubTransaction.md) | If a split scheduled transaction, the sub-transactions. | 
+
+

data/docs/ScheduledTransactionResponse.md

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

data/docs/ScheduledTransactionSummary.md

@@ -0,0 +1,18 @@
+# YnabApi::ScheduledTransactionSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**date_first** | **Date** | The first date for which the Scheduled Transaction was scheduled. | 
+**date_next** | **Date** | The next date for which the Scheduled Transaction is scheduled. | 
+**frequency** | **String** |  | 
+**amount** | **Float** | The scheduled transaction amount in milliunits format | 
+**memo** | **String** |  | 
+**flag_color** | **String** |  | 
+**account_id** | **String** |  | 
+**payee_id** | **String** |  | 
+**category_id** | **String** |  | 
+**transfer_account_id** | **String** | If a transfer, the account_id which the scheduled transaction transfers to | 
+
+

data/docs/ScheduledTransactionWrapper.md

@@ -0,0 +1,8 @@
+# YnabApi::ScheduledTransactionWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scheduled_transaction** | [**ScheduledTransactionDetail**](ScheduledTransactionDetail.md) |  | 
+
+

data/docs/ScheduledTransactionsApi.md

@@ -0,0 +1,121 @@
+# YnabApi::ScheduledTransactionsApi
+
+All URIs are relative to *https://api.youneedabudget.com/papi/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**
+> ScheduledTransactionResponse get_scheduled_transaction_by_id(budget_id, scheduled_transaction_id)
+
+Single scheduled transaction
+
+Returns a single scheduled transaction
+
+### 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::ScheduledTransactionsApi.new
+
+budget_id = "budget_id_example" # String | The ID of the Budget.
+
+scheduled_transaction_id = "scheduled_transaction_id_example" # String | The ID of the Scheduled Transaction.
+
+
+begin
+  #Single scheduled transaction
+  result = api_instance.get_scheduled_transaction_by_id(budget_id, scheduled_transaction_id)
+  p result
+rescue YnabApi::ApiError => e
+  puts "Exception when calling ScheduledTransactionsApi->get_scheduled_transaction_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget_id** | [**String**](.md)| The ID of the Budget. | 
+ **scheduled_transaction_id** | [**String**](.md)| The ID of the Scheduled Transaction. | 
+
+### Return type
+
+[**ScheduledTransactionResponse**](ScheduledTransactionResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_scheduled_transactions**
+> ScheduledTransactionsResponse get_scheduled_transactions(budget_id)
+
+List scheduled transactions
+
+Returns all scheduled transactions
+
+### 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::ScheduledTransactionsApi.new
+
+budget_id = "budget_id_example" # String | The ID of the Budget.
+
+
+begin
+  #List scheduled transactions
+  result = api_instance.get_scheduled_transactions(budget_id)
+  p result
+rescue YnabApi::ApiError => e
+  puts "Exception when calling ScheduledTransactionsApi->get_scheduled_transactions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget_id** | [**String**](.md)| The ID of the Budget. | 
+
+### Return type
+
+[**ScheduledTransactionsResponse**](ScheduledTransactionsResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/ScheduledTransactionsResponse.md

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

data/docs/ScheduledTransactionsWrapper.md

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

data/docs/SubTransaction.md

@@ -0,0 +1,14 @@
+# YnabApi::SubTransaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**transaction_id** | **String** |  | 
+**amount** | **Float** | The sub-transaction amount in milliunits format | 
+**memo** | **String** |  | 
+**payee_id** | **String** |  | 
+**category_id** | **String** |  | 
+**transfer_account_id** | **String** | If a transfer, the account_id which the subtransaction transfers to | 
+
+