ynab 1.5.0 → 1.6.0

data/docs/PayeesApi.md

@@ -1,45 +0,0 @@
-# YNAB::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**
-> PayeeResponse get_payee_by_id(budget_id, payee_id)
-
-Single payee
-
-Returns single 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)| The id of the payee | 
-
-### Return type
-
-[**PayeeResponse**](PayeeResponse.md)
-
-# **get_payees**
-> PayeesResponse get_payees(budget_id)
-
-List payees
-
-Returns all payees
-
-### 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
-
-[**PayeesResponse**](PayeesResponse.md)
-

data/docs/PayeesResponse.md

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

data/docs/PayeesWrapper.md

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

data/docs/SaveMonthCategory.md

@@ -1,8 +0,0 @@
-# YNAB::SaveMonthCategory
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**budgeted** | **Integer** | Budgeted amount in milliunits format | 
-
-

data/docs/SaveMonthCategoryWrapper.md

@@ -1,8 +0,0 @@
-# YNAB::SaveMonthCategoryWrapper
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**month_category** | [**SaveMonthCategory**](SaveMonthCategory.md) |  | 
-
-

data/docs/SaveTransaction.md

@@ -1,18 +0,0 @@
-# YNAB::SaveTransaction
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**account_id** | **String** |  | 
-**date** | **Date** |  | 
-**amount** | **Integer** | The transaction amount in milliunits format | 
-**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** | **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]:[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.  If import_id is specified as null, the transaction will be treated as a user entered transaction. | [optional] 
-
-

data/docs/SaveTransactionWrapper.md

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

data/docs/SaveTransactionsResponse.md

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

data/docs/SaveTransactionsResponseData.md

@@ -1,11 +0,0 @@
-# YNAB::SaveTransactionsResponseData
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**transaction_ids** | **Array<String>** | The transaction ids that were saved | 
-**transaction** | [**TransactionDetail**](TransactionDetail.md) | If a single transaction was specified, the transaction that was saved | [optional] 
-**transactions** | [**Array<TransactionDetail>**](TransactionDetail.md) | If multiple transactions were specified, the transactions that were saved | [optional] 
-**duplicate_import_ids** | **Array<String>** | If multiple transactions were specified, a list of import_ids that were not were created because of an existing import_id found on the same account | [optional] 
-
-

data/docs/SaveTransactionsWrapper.md

@@ -1,9 +0,0 @@
-# YNAB::SaveTransactionsWrapper
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**transaction** | [**SaveTransaction**](SaveTransaction.md) |  | [optional] 
-**transactions** | [**Array<SaveTransaction>**](SaveTransaction.md) |  | [optional] 
-
-

data/docs/ScheduledSubTransaction.md

@@ -1,15 +0,0 @@
-# YNAB::ScheduledSubTransaction
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | 
-**scheduled_transaction_id** | **String** |  | 
-**amount** | **Integer** | The scheduled subtransaction 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 subtransaction transfers to | 
-**deleted** | **BOOLEAN** | Whether or not the scheduled subtransaction has been deleted.  Deleted scheduled subtransactions will only be included in delta requests. | 
-
-

data/docs/ScheduledTransactionDetail.md

@@ -1,23 +0,0 @@
-# YNAB::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** | **Integer** | The scheduled transaction amount in milliunits format | 
-**memo** | **String** |  | 
-**flag_color** | **String** | The scheduled transaction flag | 
-**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 | 
-**deleted** | **BOOLEAN** | 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** | [**Array<ScheduledSubTransaction>**](ScheduledSubTransaction.md) | If a split scheduled transaction, the subtransactions. | 
-
-

data/docs/ScheduledTransactionResponse.md

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

data/docs/ScheduledTransactionSummary.md

@@ -1,19 +0,0 @@
-# YNAB::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** | **Integer** | The scheduled transaction amount in milliunits format | 
-**memo** | **String** |  | 
-**flag_color** | **String** | The scheduled transaction flag | 
-**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 | 
-**deleted** | **BOOLEAN** | Whether or not the scheduled transaction has been deleted.  Deleted scheduled transactions will only be included in delta requests. | 
-
-

data/docs/ScheduledTransactionWrapper.md

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

data/docs/ScheduledTransactionsApi.md

@@ -1,45 +0,0 @@
-# YNAB::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**
-> ScheduledTransactionResponse get_scheduled_transaction_by_id(budget_id, scheduled_transaction_id)
-
-Single scheduled transaction
-
-Returns a single scheduled transaction
-
-### 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) | 
- **scheduled_transaction_id** | [**String**](.md)| The id of the scheduled transaction | 
-
-### Return type
-
-[**ScheduledTransactionResponse**](ScheduledTransactionResponse.md)
-
-# **get_scheduled_transactions**
-> ScheduledTransactionsResponse get_scheduled_transactions(budget_id)
-
-List scheduled transactions
-
-Returns all scheduled transactions
-
-### 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
-
-[**ScheduledTransactionsResponse**](ScheduledTransactionsResponse.md)
-

data/docs/ScheduledTransactionsResponse.md

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

data/docs/ScheduledTransactionsWrapper.md

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

data/docs/SubTransaction.md

@@ -1,15 +0,0 @@
-# YNAB::SubTransaction
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | 
-**transaction_id** | **String** |  | 
-**amount** | **Integer** | The subtransaction 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 | 
-**deleted** | **BOOLEAN** | Whether or not the subtransaction has been deleted.  Deleted subtransactions will only be included in delta requests. | 
-
-

data/docs/TransactionDetail.md

@@ -1,25 +0,0 @@
-# YNAB::TransactionDetail
-
-## 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. | 
-**account_name** | **String** |  | 
-**payee_name** | **String** |  | 
-**category_name** | **String** |  | 
-**subtransactions** | [**Array<SubTransaction>**](SubTransaction.md) | If a split transaction, the subtransactions. | 
-
-

data/docs/TransactionResponse.md

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

data/docs/TransactionSummary.md

@@ -1,21 +0,0 @@
-# YNAB::TransactionSummary
-
-## 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. | 
-
-

data/docs/TransactionWrapper.md

@@ -1,8 +0,0 @@
-# YNAB::TransactionWrapper
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**transaction** | [**TransactionDetail**](TransactionDetail.md) |  | 
-
-

data/docs/TransactionsApi.md

@@ -1,168 +0,0 @@
-# YNAB::TransactionsApi
-
-All URIs are relative to *https://api.youneedabudget.com/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**bulk_create_transactions**](TransactionsApi.md#bulk_create_transactions) | **POST** /budgets/{budget_id}/transactions/bulk | Bulk create transactions
-[**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
-
-
-# **bulk_create_transactions**
-> BulkResponse bulk_create_transactions(budget_id, transactions)
-
-Bulk create transactions
-
-Creates multiple transactions
-
-### 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) | 
- **transactions** | [**BulkTransactions**](BulkTransactions.md)| The list of transactions to create | 
-
-### Return type
-
-[**BulkResponse**](BulkResponse.md)
-
-# **create_transaction**
-> SaveTransactionsResponse create_transaction(budget_id, save_transactions)
-
-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.
-
-### 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) | 
- **save_transactions** | [**SaveTransactionsWrapper**](SaveTransactionsWrapper.md)| The transaction or transactions to create | 
-
-### Return type
-
-[**SaveTransactionsResponse**](SaveTransactionsResponse.md)
-
-# **get_transaction_by_id**
-> TransactionResponse get_transaction_by_id(budget_id, transaction_id)
-
-Single transaction
-
-Returns a single transaction
-
-### 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) | 
- **transaction_id** | [**String**](.md)| The id of the transaction | 
-
-### Return type
-
-[**TransactionResponse**](TransactionResponse.md)
-
-# **get_transactions**
-> TransactionsResponse get_transactions(budget_id, opts)
-
-List transactions
-
-Returns budget transactions
-
-### 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) | 
- **since_date** | **Date**| Only return transactions on or after this date | [optional] 
- **type** | **String**| Only return transactions of a certain type ('uncategorized' and 'unapproved' are currently supported) | [optional] 
-
-### Return type
-
-[**TransactionsResponse**](TransactionsResponse.md)
-
-# **get_transactions_by_account**
-> TransactionsResponse get_transactions_by_account(budget_id, account_id, opts)
-
-List account transactions
-
-Returns all transactions for a specified account
-
-### 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) | 
- **account_id** | [**String**](.md)| The id of the account | 
- **since_date** | **Date**| Only return transactions on or after this date | [optional] 
- **type** | **String**| Only return transactions of a certain type (i.e. 'uncategorized', 'unapproved') | [optional] 
-
-### Return type
-
-[**TransactionsResponse**](TransactionsResponse.md)
-
-# **get_transactions_by_category**
-> HybridTransactionsResponse get_transactions_by_category(budget_id, category_id, opts)
-
-List category transactions
-
-Returns all transactions for a specified category
-
-### 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) | 
- **category_id** | [**String**](.md)| The id of the category | 
- **since_date** | **Date**| Only return transactions on or after this date | [optional] 
- **type** | **String**| Only return transactions of a certain type (i.e. 'uncategorized', 'unapproved') | [optional] 
-
-### Return type
-
-[**HybridTransactionsResponse**](HybridTransactionsResponse.md)
-
-# **get_transactions_by_payee**
-> HybridTransactionsResponse get_transactions_by_payee(budget_id, payee_id, opts)
-
-List payee transactions
-
-Returns all transactions for a 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)| The id of the payee | 
- **since_date** | **Date**| Only return transactions on or after this date | [optional] 
- **type** | **String**| Only return transactions of a certain type (i.e. 'uncategorized', 'unapproved') | [optional] 
-
-### Return type
-
-[**HybridTransactionsResponse**](HybridTransactionsResponse.md)
-
-# **update_transaction**
-> TransactionResponse update_transaction(budget_id, transaction_id, transaction)
-
-Updates an existing transaction
-
-Updates a transaction
-
-### 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) | 
- **transaction_id** | [**String**](.md)| The id of the transaction | 
- **transaction** | [**SaveTransactionWrapper**](SaveTransactionWrapper.md)| The transaction to update | 
-
-### Return type
-
-[**TransactionResponse**](TransactionResponse.md)
-