ynab 1.31.0 → 2.0.0

data/docs/SubTransaction.md

@@ -0,0 +1,18 @@
+# YNAB::SubTransaction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **transaction_id** | **String** |  |  |
+| **amount** | **Integer** | The subtransaction amount in milliunits format |  |
+| **memo** | **String** |  | [optional] |
+| **payee_id** | **String** |  | [optional] |
+| **payee_name** | **String** |  | [optional] |
+| **category_id** | **String** |  | [optional] |
+| **category_name** | **String** |  | [optional] |
+| **transfer_account_id** | **String** | If a transfer, the account_id which the subtransaction transfers to | [optional] |
+| **transfer_transaction_id** | **String** | If a transfer, the id of transaction on the other side of the transfer | [optional] |
+| **deleted** | **Boolean** | Whether or not the subtransaction has been deleted.  Deleted subtransactions will only be included in delta requests. |  |
+

data/docs/TransactionDetail.md

@@ -0,0 +1,29 @@
+# YNAB::TransactionDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **date** | **Date** | The transaction date in ISO format (e.g. 2016-12-01) |  |
+| **amount** | **Integer** | The transaction amount in milliunits format |  |
+| **memo** | **String** |  | [optional] |
+| **cleared** | **String** | The cleared status of the transaction |  |
+| **approved** | **Boolean** | Whether or not the transaction is approved |  |
+| **flag_color** | **String** | The transaction flag | [optional] |
+| **account_id** | **String** |  |  |
+| **payee_id** | **String** |  | [optional] |
+| **category_id** | **String** |  | [optional] |
+| **transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers | [optional] |
+| **transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer | [optional] |
+| **matched_transaction_id** | **String** | If transaction is matched, the id of the matched transaction | [optional] |
+| **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'. | [optional] |
+| **import_payee_name** | **String** | If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules | [optional] |
+| **import_payee_name_original** | **String** | If the transaction was imported, the original payee name as it appeared on the statement | [optional] |
+| **debt_transaction_type** | **String** | If the transaction is a debt/loan account transaction, the type of transaction | [optional] |
+| **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** |  | [optional] |
+| **category_name** | **String** | The name of the category.  If a split transaction, this will be 'Split'. | [optional] |
+| **subtransactions** | [**Array<SubTransaction>**](SubTransaction.md) | If a split transaction, the subtransactions. |  |
+

data/docs/TransactionDetailAllOf.md

@@ -0,0 +1,11 @@
+# YNAB::TransactionDetailAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_name** | **String** |  |  |
+| **payee_name** | **String** |  | [optional] |
+| **category_name** | **String** | The name of the category.  If a split transaction, this will be 'Split'. | [optional] |
+| **subtransactions** | [**Array<SubTransaction>**](SubTransaction.md) | If a split transaction, the subtransactions. |  |
+

data/docs/TransactionResponse.md

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

data/docs/TransactionResponseData.md

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

data/docs/TransactionSummary.md

@@ -0,0 +1,25 @@
+# YNAB::TransactionSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **date** | **Date** | The transaction date in ISO format (e.g. 2016-12-01) |  |
+| **amount** | **Integer** | The transaction amount in milliunits format |  |
+| **memo** | **String** |  | [optional] |
+| **cleared** | **String** | The cleared status of the transaction |  |
+| **approved** | **Boolean** | Whether or not the transaction is approved |  |
+| **flag_color** | **String** | The transaction flag | [optional] |
+| **account_id** | **String** |  |  |
+| **payee_id** | **String** |  | [optional] |
+| **category_id** | **String** |  | [optional] |
+| **transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers | [optional] |
+| **transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer | [optional] |
+| **matched_transaction_id** | **String** | If transaction is matched, the id of the matched transaction | [optional] |
+| **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'. | [optional] |
+| **import_payee_name** | **String** | If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules | [optional] |
+| **import_payee_name_original** | **String** | If the transaction was imported, the original payee name as it appeared on the statement | [optional] |
+| **debt_transaction_type** | **String** | If the transaction is a debt/loan account transaction, the type of transaction | [optional] |
+| **deleted** | **Boolean** | Whether or not the transaction has been deleted.  Deleted transactions will only be included in delta requests. |  |
+

data/docs/TransactionWrapper.md

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

data/docs/TransactionsApi.md

@@ -0,0 +1,228 @@
+# YNAB::TransactionsApi
+
+All URIs are relative to *https://api.ynab.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_transaction**](TransactionsApi.md#create_transaction) | **POST** /budgets/{budget_id}/transactions | Create a single transaction or multiple transactions |
+| [**delete_transaction**](TransactionsApi.md#delete_transaction) | **DELETE** /budgets/{budget_id}/transactions/{transaction_id} | Deletes an existing transaction |
+| [**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 |
+| [**import_transactions**](TransactionsApi.md#import_transactions) | **POST** /budgets/{budget_id}/transactions/import | Import transactions |
+| [**update_transaction**](TransactionsApi.md#update_transaction) | **PUT** /budgets/{budget_id}/transactions/{transaction_id} | Updates an existing transaction |
+| [**update_transactions**](TransactionsApi.md#update_transactions) | **PATCH** /budgets/{budget_id}/transactions | Update multiple transactions |
+
+
+## create_transaction
+
+> <SaveTransactionsResponse> create_transaction(budget_id, data)
+
+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.  Scheduled transactions cannot be created on this endpoint.
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **data** | [**PostTransactionsWrapper**](PostTransactionsWrapper.md) | The transaction or transactions to create.  To create a single transaction you can specify a value for the &#x60;transaction&#x60; object and to create multiple transactions you can specify an array of &#x60;transactions&#x60;.  It is expected that you will only provide a value for one of these objects. |  |
+
+### Return type
+
+[**SaveTransactionsResponse**](SaveTransactionsResponse.md)
+
+
+## delete_transaction
+
+> <TransactionResponse> delete_transaction(budget_id, transaction_id)
+
+Deletes an existing transaction
+
+Deletes a transaction
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **transaction_id** | **String** | The id of the transaction |  |
+
+### Return type
+
+[**TransactionResponse**](TransactionResponse.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** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **transaction_id** | **String** | 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** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **since_date** | **Date** | If specified, only transactions on or after this date will be included.  The date should be ISO formatted (e.g. 2016-12-30). | [optional] |
+| **type** | **String** | If specified, only transactions of the specified type will be included. \&quot;uncategorized\&quot; and \&quot;unapproved\&quot; are currently supported. | [optional] |
+| **last_knowledge_of_server** | **Integer** | The starting server knowledge.  If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included. | [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** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **account_id** | **String** | The id of the account |  |
+| **since_date** | **Date** | If specified, only transactions on or after this date will be included.  The date should be ISO formatted (e.g. 2016-12-30). | [optional] |
+| **type** | **String** | If specified, only transactions of the specified type will be included. \&quot;uncategorized\&quot; and \&quot;unapproved\&quot; are currently supported. | [optional] |
+| **last_knowledge_of_server** | **Integer** | The starting server knowledge.  If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included. | [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** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **category_id** | **String** | The id of the category |  |
+| **since_date** | **Date** | If specified, only transactions on or after this date will be included.  The date should be ISO formatted (e.g. 2016-12-30). | [optional] |
+| **type** | **String** | If specified, only transactions of the specified type will be included. \&quot;uncategorized\&quot; and \&quot;unapproved\&quot; are currently supported. | [optional] |
+| **last_knowledge_of_server** | **Integer** | The starting server knowledge.  If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included. | [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** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **payee_id** | **String** | The id of the payee |  |
+| **since_date** | **Date** | If specified, only transactions on or after this date will be included.  The date should be ISO formatted (e.g. 2016-12-30). | [optional] |
+| **type** | **String** | If specified, only transactions of the specified type will be included. \&quot;uncategorized\&quot; and \&quot;unapproved\&quot; are currently supported. | [optional] |
+| **last_knowledge_of_server** | **Integer** | The starting server knowledge.  If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included. | [optional] |
+
+### Return type
+
+[**HybridTransactionsResponse**](HybridTransactionsResponse.md)
+
+
+## import_transactions
+
+> <TransactionsImportResponse> import_transactions(budget_id)
+
+Import transactions
+
+Imports available transactions on all linked accounts for the given budget.  Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import.  Sending a request to this endpoint is the equivalent of clicking \"Import\" on each account in the web application or tapping the \"New Transactions\" banner in the mobile applications.  The response for this endpoint contains the transaction ids that have been imported.
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+
+### Return type
+
+[**TransactionsImportResponse**](TransactionsImportResponse.md)
+
+
+## update_transaction
+
+> <TransactionResponse> update_transaction(budget_id, transaction_id, data)
+
+Updates an existing transaction
+
+Updates a single transaction
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **transaction_id** | **String** | The id of the transaction |  |
+| **data** | [**PutTransactionWrapper**](PutTransactionWrapper.md) | The transaction to update |  |
+
+### Return type
+
+[**TransactionResponse**](TransactionResponse.md)
+
+
+## update_transactions
+
+> <SaveTransactionsResponse> update_transactions(budget_id, data)
+
+Update multiple transactions
+
+Updates multiple transactions, by `id` or `import_id`.
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **data** | [**PatchTransactionsWrapper**](PatchTransactionsWrapper.md) | The transactions to update. Each transaction must have either an &#x60;id&#x60; or &#x60;import_id&#x60; specified. If &#x60;id&#x60; is specified as null an &#x60;import_id&#x60; value can be provided which will allow transaction(s) to be updated by their &#x60;import_id&#x60;. If an &#x60;id&#x60; is specified, it will always be used for lookup. |  |
+
+### Return type
+
+[**SaveTransactionsResponse**](SaveTransactionsResponse.md)
+

data/docs/TransactionsImportResponse.md

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

data/docs/TransactionsImportResponseData.md

@@ -0,0 +1,8 @@
+# YNAB::TransactionsImportResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_ids** | **Array<String>** | The list of transaction ids that were imported. |  |
+

data/docs/TransactionsResponse.md

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

data/docs/TransactionsResponseData.md

@@ -0,0 +1,9 @@
+# YNAB::TransactionsResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transactions** | [**Array<TransactionDetail>**](TransactionDetail.md) |  |  |
+| **server_knowledge** | **Integer** | The knowledge of the server |  |
+

data/docs/TransactionsWrapper.md

@@ -0,0 +1,9 @@
+# YNAB::TransactionsWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transactions** | [**Array<TransactionDetail>**](TransactionDetail.md) |  | 
+**server_knowledge** | **Integer** | The knowledge of the server | 
+
+

data/docs/UpdateTransaction.md

@@ -0,0 +1,20 @@
+# YNAB::UpdateTransaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** |  | 
+**date** | **Date** | The transaction date in ISO format (e.g. 2016-12-01).  Future dates (scheduled transactions) are not permitted.  Split transaction dates cannot be changed and if a different date is supplied it will be ignored. | 
+**amount** | **Integer** | The transaction amount in milliunits format.  Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored. | 
+**payee_id** | **String** | The payee for the transaction.  To create a transfer between two accounts, use the account transfer payee pointing to the target account.  Account transfer payees are specified as `tranfer_payee_id` on the account resource. | [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.  To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object.  If an existing transaction is a split, the `category_id` cannot be changed.  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, the new transaction will be assigned this `import_id` and considered \"imported\".  We will also attempt to match this imported transaction to an existing \"user-entered\" transation on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (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.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a \"user-entered\" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API). | [optional] 
+**subtransactions** | [**Array<SaveSubTransaction>**](SaveSubTransaction.md) | An array of subtransactions to configure a transaction as a split.  Updating `subtransactions` on an existing split transaction is not supported. | [optional] 
+**id** | **String** |  | 
+
+

data/docs/UpdateTransactionsWrapper.md

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

data/docs/User.md

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

data/docs/UserApi.md

@@ -0,0 +1,25 @@
+# YNAB::UserApi
+
+All URIs are relative to *https://api.ynab.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_user**](UserApi.md#get_user) | **GET** /user | User info |
+
+
+## get_user
+
+> <UserResponse> get_user
+
+User info
+
+Returns authenticated user information
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**UserResponse**](UserResponse.md)
+

data/docs/UserResponse.md

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

data/docs/UserResponseData.md

@@ -0,0 +1,8 @@
+# YNAB::UserResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | [**User**](User.md) |  |  |
+

data/docs/UserWrapper.md

@@ -0,0 +1,8 @@
+# YNAB::UserWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | [**User**](User.md) |  | 
+
+

data/examples/budget-list.rb

@@ -0,0 +1,21 @@
+require 'ynab'
+
+access_token = ENV['YNAB_ACCESS_TOKEN']
+ynab = YNAB::API.new(access_token)
+
+begin
+  puts 'Fetching budgets...'
+
+  budget_response = ynab.budgets.get_budgets
+  budgets = budget_response.data.budgets
+
+  puts '==========='
+  puts 'BUDGET LIST'
+  puts '==========='
+
+  budgets.each do |budget|
+    puts "[id: #{budget.id}, name: #{budget.name}]"
+  end
+rescue YNAB::ApiError => e
+  puts "ERROR: id=#{e.id}; name=#{e.name}; detail: #{e.detail}"
+end

data/examples/budget-month.rb

@@ -0,0 +1,33 @@
+require 'ynab'
+require 'date'
+
+access_token = ENV['YNAB_ACCESS_TOKEN']
+ynab = YNAB::API.new(access_token)
+
+budget_id = ENV['YNAB_BUDGET_ID']
+
+begin
+  puts 'Fetching month...'
+
+  first_day_of_month_iso = Date.new(Date.today.year, Date.today.month, 1).iso8601
+  current_date = Date.today
+  first_day_of_month = Date.new(current_date.year, current_date.month, 1)
+  month_response = ynab.months.get_budget_month(budget_id, first_day_of_month_iso)
+  budget_month = month_response.data.month
+
+  puts "============"
+  puts "BUDGET MONTH"
+  puts "============"
+  puts "         Month: #{budget_month.month}"
+  puts "          Note: #{budget_month.note}"
+  puts "To Be Budgeted: #{budget_month.to_be_budgeted}"
+  puts "  Age of Money: #{budget_month.age_of_money}"
+  puts "    Categories: "
+
+  budget_month.categories.each do |category|
+    puts "                #{category.name} - $#{category.balance}"
+  end
+rescue YNAB::ApiError => e
+  puts "ERROR: id=#{e.id}; name=#{e.name}; detail: #{e.detail}"
+end
+

data/examples/category-balance.rb

@@ -0,0 +1,23 @@
+require 'ynab'
+
+access_token = ENV['YNAB_ACCESS_TOKEN']
+ynab = YNAB::API.new(access_token)
+
+budget_id = ENV['YNAB_BUDGET_ID']
+category_id = 'a191ac84-de09-not-real-6c5ed8cfdabe'
+
+begin
+  puts 'Fetching category...'
+
+  category_response = ynab.categories.get_category_by_id(budget_id, category_id)
+  category = category_response.data.category
+
+  puts "==========="
+  puts "CATEGORY"
+  puts "==========="
+  puts "      Name: #{category.name}"
+  puts "  Budgeted: #{category.budgeted}"
+  puts "   Balance: #{category.balance}"
+rescue YNAB::ApiError => e
+  puts "ERROR: id=#{e.id}; name=#{e.name}; detail: #{e.detail}"
+end

data/examples/create-multiple-transactions.rb

@@ -0,0 +1,42 @@
+require 'date'
+require 'ynab'
+
+access_token = ENV['YNAB_ACCESS_TOKEN']
+ynab = YNAB::API.new(access_token)
+
+budget_id = ENV['YNAB_BUDGET_ID']
+account_id = 'f6fe07cb-c895-not-real-acfac0b7f026'
+category_id = 'a191ac84-de09-not-real-6c5ed8cfdabe'
+
+data = {
+  transactions: [
+    {
+      account_id: account_id,
+      category_id: category_id,
+      date: Date.today,
+      payee_name: 'A Test Payee',
+      memo: 'I was created through the API',
+      cleared: 'Cleared',
+      approved: true,
+      flag_color: 'Blue',
+      amount: 20000
+    },
+    {
+      account_id: account_id,
+      category_id: category_id,
+      date: Date.today,
+      payee_name: 'Another Test Payee',
+      memo: 'I was also created through the API',
+      cleared: 'Uncleared',
+      approved: false,
+      flag_color: 'Red',
+      amount: 39453
+    }
+  ]
+}
+
+begin
+  ynab.transactions.create_transaction(budget_id, data)
+rescue YNAB::ApiError => e
+  puts "ERROR: id=#{e.id}; name=#{e.name}; detail: #{e.detail}"
+end

data/examples/create-transaction.rb

@@ -0,0 +1,30 @@
+require 'date'
+require 'ynab'
+
+access_token = ENV['YNAB_ACCESS_TOKEN']
+ynab = YNAB::API.new(access_token)
+
+budget_id = ENV['YNAB_BUDGET_ID']
+account_id = 'f6fe07cb-c895-not-real-acfac0b7f026'
+category_id = 'a191ac84-de09-not-real-6c5ed8cfdabe'
+
+data = {
+  transaction: {
+    account_id: account_id,
+    category_id: category_id,
+    date: Date.today,
+    payee_name: 'A Test Payee',
+    memo: 'I was created through the API',
+    cleared: 'Cleared',
+    approved: true,
+    flag_color: 'Blue',
+    amount: 20000
+  }
+}
+
+begin
+  ynab.transactions.create_transaction(budget_id, data)
+rescue YNAB::ApiError => e
+  puts "ERROR: id=#{e.id}; name=#{e.name}; detail: #{e.detail}"
+end
+