ynab 3.9.0 → 5.0.0

data/docs/ScheduledTransactionsApi.md

@@ -4,18 +4,18 @@ All URIs are relative to *https://api.ynab.com/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**create_scheduled_transaction**](ScheduledTransactionsApi.md#create_scheduled_transaction) | **POST** /budgets/{budget_id}/scheduled_transactions | Create a single scheduled transaction |
-| [**delete_scheduled_transaction**](ScheduledTransactionsApi.md#delete_scheduled_transaction) | **DELETE** /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id} | Deletes an existing scheduled transaction |
-| [**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 |
-| [**update_scheduled_transaction**](ScheduledTransactionsApi.md#update_scheduled_transaction) | **PUT** /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id} | Updates an existing scheduled transaction |
+| [**create_scheduled_transaction**](ScheduledTransactionsApi.md#create_scheduled_transaction) | **POST** /plans/{plan_id}/scheduled_transactions | Create a scheduled transaction |
+| [**delete_scheduled_transaction**](ScheduledTransactionsApi.md#delete_scheduled_transaction) | **DELETE** /plans/{plan_id}/scheduled_transactions/{scheduled_transaction_id} | Delete a scheduled transaction |
+| [**get_scheduled_transaction_by_id**](ScheduledTransactionsApi.md#get_scheduled_transaction_by_id) | **GET** /plans/{plan_id}/scheduled_transactions/{scheduled_transaction_id} | Get a scheduled transaction |
+| [**get_scheduled_transactions**](ScheduledTransactionsApi.md#get_scheduled_transactions) | **GET** /plans/{plan_id}/scheduled_transactions | Get all scheduled transactions |
+| [**update_scheduled_transaction**](ScheduledTransactionsApi.md#update_scheduled_transaction) | **PUT** /plans/{plan_id}/scheduled_transactions/{scheduled_transaction_id} | Update a scheduled transaction |
 
 
 ## create_scheduled_transaction
 
-> <ScheduledTransactionResponse> create_scheduled_transaction(budget_id, data)
+> <ScheduledTransactionResponse> create_scheduled_transaction(plan_id, data)
 
-Create a single scheduled transaction
+Create a scheduled transaction
 
 Creates a single scheduled transaction (a transaction with a future date).
 
@@ -23,7 +23,7 @@ Creates a single scheduled transaction (a transaction with a future date).
 
 | 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). |  |
+| **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). |  |
 | **data** | [**PostScheduledTransactionWrapper**](PostScheduledTransactionWrapper.md) | The scheduled transaction to create |  |
 
 ### Return type
@@ -33,9 +33,9 @@ Creates a single scheduled transaction (a transaction with a future date).
 
 ## delete_scheduled_transaction
 
-> <ScheduledTransactionResponse> delete_scheduled_transaction(budget_id, scheduled_transaction_id)
+> <ScheduledTransactionResponse> delete_scheduled_transaction(plan_id, scheduled_transaction_id)
 
-Deletes an existing scheduled transaction
+Delete a scheduled transaction
 
 Deletes a scheduled transaction
 
@@ -43,7 +43,7 @@ Deletes a scheduled transaction
 
 | 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). |  |
+| **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). |  |
 | **scheduled_transaction_id** | **String** | The id of the scheduled transaction |  |
 
 ### Return type
@@ -53,9 +53,9 @@ Deletes a scheduled transaction
 
 ## get_scheduled_transaction_by_id
 
-> <ScheduledTransactionResponse> get_scheduled_transaction_by_id(budget_id, scheduled_transaction_id)
+> <ScheduledTransactionResponse> get_scheduled_transaction_by_id(plan_id, scheduled_transaction_id)
 
-Single scheduled transaction
+Get a scheduled transaction
 
 Returns a single scheduled transaction
 
@@ -63,7 +63,7 @@ Returns a single scheduled transaction
 
 | 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). |  |
+| **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). |  |
 | **scheduled_transaction_id** | **String** | The id of the scheduled transaction |  |
 
 ### Return type
@@ -73,9 +73,9 @@ Returns a single scheduled transaction
 
 ## get_scheduled_transactions
 
-> <ScheduledTransactionsResponse> get_scheduled_transactions(budget_id, opts)
+> <ScheduledTransactionsResponse> get_scheduled_transactions(plan_id, opts)
 
-List scheduled transactions
+Get all scheduled transactions
 
 Returns all scheduled transactions
 
@@ -83,7 +83,7 @@ Returns all scheduled transactions
 
 | 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). |  |
+| **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). |  |
 | **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
@@ -93,9 +93,9 @@ Returns all scheduled transactions
 
 ## update_scheduled_transaction
 
-> <ScheduledTransactionResponse> update_scheduled_transaction(budget_id, scheduled_transaction_id, put_scheduled_transaction_wrapper)
+> <ScheduledTransactionResponse> update_scheduled_transaction(plan_id, scheduled_transaction_id, put_scheduled_transaction_wrapper)
 
-Updates an existing scheduled transaction
+Update a scheduled transaction
 
 Updates a single scheduled transaction
 
@@ -103,7 +103,7 @@ Updates a single scheduled transaction
 
 | 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). |  |
+| **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). |  |
 | **scheduled_transaction_id** | **String** | The id of the scheduled transaction |  |
 | **put_scheduled_transaction_wrapper** | [**PutScheduledTransactionWrapper**](PutScheduledTransactionWrapper.md) | The scheduled transaction to update |  |
 

data/docs/TransactionsApi.md

@@ -4,22 +4,22 @@ 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, excluding any pending transactions |
-| [**get_transactions_by_month**](TransactionsApi.md#get_transactions_by_month) | **GET** /budgets/{budget_id}/months/{month}/transactions | List transactions in month, excluding any pending transactions |
-| [**get_transactions_by_payee**](TransactionsApi.md#get_transactions_by_payee) | **GET** /budgets/{budget_id}/payees/{payee_id}/transactions | List payee transactions, excluding any pending 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**](TransactionsApi.md#create_transaction) | **POST** /plans/{plan_id}/transactions | Create a single transaction or multiple transactions |
+| [**delete_transaction**](TransactionsApi.md#delete_transaction) | **DELETE** /plans/{plan_id}/transactions/{transaction_id} | Delete a transaction |
+| [**get_transaction_by_id**](TransactionsApi.md#get_transaction_by_id) | **GET** /plans/{plan_id}/transactions/{transaction_id} | Get a transaction |
+| [**get_transactions**](TransactionsApi.md#get_transactions) | **GET** /plans/{plan_id}/transactions | Get all transactions |
+| [**get_transactions_by_account**](TransactionsApi.md#get_transactions_by_account) | **GET** /plans/{plan_id}/accounts/{account_id}/transactions | Get all account transactions |
+| [**get_transactions_by_category**](TransactionsApi.md#get_transactions_by_category) | **GET** /plans/{plan_id}/categories/{category_id}/transactions | Get all category transactions |
+| [**get_transactions_by_month**](TransactionsApi.md#get_transactions_by_month) | **GET** /plans/{plan_id}/months/{month}/transactions | Get all plan month transactions |
+| [**get_transactions_by_payee**](TransactionsApi.md#get_transactions_by_payee) | **GET** /plans/{plan_id}/payees/{payee_id}/transactions | Get all payee transactions |
+| [**import_transactions**](TransactionsApi.md#import_transactions) | **POST** /plans/{plan_id}/transactions/import | Import transactions |
+| [**update_transaction**](TransactionsApi.md#update_transaction) | **PUT** /plans/{plan_id}/transactions/{transaction_id} | Update a transaction |
+| [**update_transactions**](TransactionsApi.md#update_transactions) | **PATCH** /plans/{plan_id}/transactions | Update multiple transactions |
 
 
 ## create_transaction
 
-> <SaveTransactionsResponse> create_transaction(budget_id, data)
+> <SaveTransactionsResponse> create_transaction(plan_id, data)
 
 Create a single transaction or multiple transactions
 
@@ -29,7 +29,7 @@ Creates a single transaction or multiple transactions.  If you provide a body co
 
 | 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). |  |
+| **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). |  |
 | **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
@@ -39,9 +39,9 @@ Creates a single transaction or multiple transactions.  If you provide a body co
 
 ## delete_transaction
 
-> <TransactionResponse> delete_transaction(budget_id, transaction_id)
+> <TransactionResponse> delete_transaction(plan_id, transaction_id)
 
-Deletes an existing transaction
+Delete a transaction
 
 Deletes a transaction
 
@@ -49,7 +49,7 @@ Deletes a transaction
 
 | 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). |  |
+| **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). |  |
 | **transaction_id** | **String** | The id of the transaction |  |
 
 ### Return type
@@ -59,9 +59,9 @@ Deletes a transaction
 
 ## get_transaction_by_id
 
-> <TransactionResponse> get_transaction_by_id(budget_id, transaction_id)
+> <TransactionResponse> get_transaction_by_id(plan_id, transaction_id)
 
-Single transaction
+Get a transaction
 
 Returns a single transaction
 
@@ -69,7 +69,7 @@ Returns a single transaction
 
 | 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). |  |
+| **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). |  |
 | **transaction_id** | **String** | The id of the transaction |  |
 
 ### Return type
@@ -79,17 +79,17 @@ Returns a single transaction
 
 ## get_transactions
 
-> <TransactionsResponse> get_transactions(budget_id, opts)
+> <TransactionsResponse> get_transactions(plan_id, opts)
 
-List transactions
+Get all transactions
 
-Returns budget transactions, excluding any pending transactions
+Returns plan transactions, excluding any pending 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). |  |
+| **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). |  |
 | **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] |
@@ -101,9 +101,9 @@ Returns budget transactions, excluding any pending transactions
 
 ## get_transactions_by_account
 
-> <TransactionsResponse> get_transactions_by_account(budget_id, account_id, opts)
+> <TransactionsResponse> get_transactions_by_account(plan_id, account_id, opts)
 
-List account transactions
+Get all account transactions
 
 Returns all transactions for a specified account, excluding any pending transactions
 
@@ -111,7 +111,7 @@ Returns all transactions for a specified account, excluding any pending transact
 
 | 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). |  |
+| **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). |  |
 | **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] |
@@ -124,17 +124,17 @@ Returns all transactions for a specified account, excluding any pending transact
 
 ## get_transactions_by_category
 
-> <HybridTransactionsResponse> get_transactions_by_category(budget_id, category_id, opts)
+> <HybridTransactionsResponse> get_transactions_by_category(plan_id, category_id, opts)
 
-List category transactions, excluding any pending transactions
+Get all category transactions
 
-Returns all transactions for a specified category
+Returns all transactions for a specified category, excluding any pending 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). |  |
+| **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). |  |
 | **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] |
@@ -147,40 +147,40 @@ Returns all transactions for a specified category
 
 ## get_transactions_by_month
 
-> <HybridTransactionsResponse> get_transactions_by_month(budget_id, month, opts)
+> <TransactionsResponse> get_transactions_by_month(plan_id, month, opts)
 
-List transactions in month, excluding any pending transactions
+Get all plan month transactions
 
-Returns all transactions for a specified month
+Returns all transactions for a specified month, excluding any pending 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). |  |
-| **month** | **String** | The budget month in ISO format (e.g. 2016-12-01) (\&quot;current\&quot; can also be used to specify the current calendar month (UTC)) |  |
+| **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). |  |
+| **month** | **String** | The plan month in ISO format (e.g. 2016-12-01) (\&quot;current\&quot; can also be used to specify the current calendar month (UTC)) |  |
 | **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)
+[**TransactionsResponse**](TransactionsResponse.md)
 
 
 ## get_transactions_by_payee
 
-> <HybridTransactionsResponse> get_transactions_by_payee(budget_id, payee_id, opts)
+> <HybridTransactionsResponse> get_transactions_by_payee(plan_id, payee_id, opts)
 
-List payee transactions, excluding any pending transactions
+Get all payee transactions
 
-Returns all transactions for a specified payee
+Returns all transactions for a specified payee, excluding any pending 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). |  |
+| **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). |  |
 | **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] |
@@ -193,17 +193,17 @@ Returns all transactions for a specified payee
 
 ## import_transactions
 
-> <TransactionsImportResponse> import_transactions(budget_id)
+> <TransactionsImportResponse> import_transactions(plan_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.
+Imports available transactions on all linked accounts for the given plan.  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). |  |
+| **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). |  |
 
 ### Return type
 
@@ -212,9 +212,9 @@ Imports available transactions on all linked accounts for the given budget.  Lin
 
 ## update_transaction
 
-> <TransactionResponse> update_transaction(budget_id, transaction_id, data)
+> <TransactionResponse> update_transaction(plan_id, transaction_id, data)
 
-Updates an existing transaction
+Update a transaction
 
 Updates a single transaction
 
@@ -222,7 +222,7 @@ Updates a single transaction
 
 | 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). |  |
+| **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). |  |
 | **transaction_id** | **String** | The id of the transaction |  |
 | **data** | [**PutTransactionWrapper**](PutTransactionWrapper.md) | The transaction to update |  |
 
@@ -233,7 +233,7 @@ Updates a single transaction
 
 ## update_transactions
 
-> <SaveTransactionsResponse> update_transactions(budget_id, data)
+> <SaveTransactionsResponse> update_transactions(plan_id, data)
 
 Update multiple transactions
 
@@ -243,7 +243,7 @@ Updates multiple transactions, by `id` or `import_id`.
 
 | 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). |  |
+| **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). |  |
 | **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 its &#x60;import_id&#x60;. If an &#x60;id&#x60; is specified, it will always be used for lookup.  You should not specify both &#x60;id&#x60; and &#x60;import_id&#x60;.  Updating an &#x60;import_id&#x60; on an existing transaction is not allowed; if an &#x60;import_id&#x60; is specified, it will only be used to lookup the transaction. |  |
 
 ### Return type

data/docs/UserApi.md

@@ -4,14 +4,14 @@ 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**](UserApi.md#get_user) | **GET** /user | Get user |
 
 
 ## get_user
 
 > <UserResponse> get_user
 
-User info
+Get user
 
 Returns authenticated user information
 

data/examples/category-balance.rb

@@ -3,13 +3,13 @@ require 'ynab'
 access_token = ENV['YNAB_ACCESS_TOKEN']
 ynab = YNAB::API.new(access_token)
 
-budget_id = ENV['YNAB_BUDGET_ID']
+plan_id = ENV['YNAB_plan_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_response = ynab.categories.get_category_by_id(plan_id, category_id)
   category = category_response.data.category
 
   puts "==========="

data/examples/create-multiple-transactions.rb

@@ -4,7 +4,7 @@ require 'ynab'
 access_token = ENV['YNAB_ACCESS_TOKEN']
 ynab = YNAB::API.new(access_token)
 
-budget_id = ENV['YNAB_BUDGET_ID']
+plan_id = ENV['YNAB_plan_id']
 account_id = 'f6fe07cb-c895-not-real-acfac0b7f026'
 category_id = 'a191ac84-de09-not-real-6c5ed8cfdabe'
 
@@ -36,7 +36,7 @@ data = {
 }
 
 begin
-  ynab.transactions.create_transaction(budget_id, data)
+  ynab.transactions.create_transaction(plan_id, data)
 rescue YNAB::ApiError => e
   puts "ERROR: id=#{e.id}; name=#{e.name}; detail: #{e.detail}"
 end

data/examples/create-transaction.rb

@@ -4,7 +4,7 @@ require 'ynab'
 access_token = ENV['YNAB_ACCESS_TOKEN']
 ynab = YNAB::API.new(access_token)
 
-budget_id = ENV['YNAB_BUDGET_ID']
+plan_id = ENV['YNAB_plan_id']
 account_id = 'f6fe07cb-c895-not-real-acfac0b7f026'
 category_id = 'a191ac84-de09-not-real-6c5ed8cfdabe'
 
@@ -23,7 +23,7 @@ data = {
 }
 
 begin
-  ynab.transactions.create_transaction(budget_id, data)
+  ynab.transactions.create_transaction(plan_id, data)
 rescue YNAB::ApiError => e
   puts "ERROR: id=#{e.id}; name=#{e.name}; detail: #{e.detail}"
 end

data/examples/{budget-list.rb → plan-list.rb}

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

data/examples/{budget-month.rb → plan-month.rb}

@@ -4,24 +4,23 @@ require 'date'
 access_token = ENV['YNAB_ACCESS_TOKEN']
 ynab = YNAB::API.new(access_token)
 
-budget_id = ENV['YNAB_BUDGET_ID']
+plan_id = ENV['YNAB_plan_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
+
+  month_response = ynab.months.get_plan_month(plan_id, first_day_of_month_iso)
+  plan_month = month_response.data.month
 
   puts "============"
-  puts "BUDGET MONTH"
+  puts "PLAN 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 "         Month: #{plan_month.month}"
+  puts "          Note: #{plan_month.note}"
+  puts "To Be Budgeted: #{plan_month.to_be_budgeted}"
+  puts "  Age of Money: #{plan_month.age_of_money}"
   puts "    Categories: "
 
   budget_month.categories.each do |category|

data/examples/update-category-budgeted.rb

@@ -4,7 +4,7 @@ require 'ynab'
 access_token = ENV['YNAB_ACCESS_TOKEN']
 ynab = YNAB::API.new(access_token)
 
-budget_id = ENV['YNAB_BUDGET_ID']
+plan_id = ENV['YNAB_plan_id']
 category_id = 'a191ac84-de09-not-real-6c5ed8cfdabe'
 month = '2019-01-01'
 
@@ -16,7 +16,7 @@ data = {
 
 begin
   # Update budgeted amount to 203.82 in 2018-09-01 for category_id
-  response = ynab.categories.update_month_category(budget_id, month, category_id, data)
+  response = ynab.categories.update_month_category(plan_id, month, category_id, data)
   month_category_response = response.data.category
   puts "[budgeted: #{month_category_response.budgeted}, balance: #{month_category_response.balance}]"
 rescue YNAB::ApiError => e

data/examples/update-multiple-transactions.rb

@@ -3,18 +3,18 @@ require 'ynab'
 access_token = ENV['YNAB_ACCESS_TOKEN']
 ynab = YNAB::API.new(access_token)
 
-budget_id = ENV['YNAB_BUDGET_ID']
+plan_id = ENV['YNAB_plan_id']
 
 begin
   # Fetch all unapproved transactions and update them all as approved
-  unapproved_transaction_data = ynab.transactions.get_transactions(budget_id, { type: 'unapproved' }).data
+  unapproved_transaction_data = ynab.transactions.get_transactions(plan_id, { type: 'unapproved' }).data
 
   data = unapproved_transaction_data.clone
   data.transactions.each do |t|
     t.approved = true
   end
 
-  ynab.transactions.update_transactions(budget_id, update_data)
+  ynab.transactions.update_transactions(plan_id, update_data)
 rescue YNAB::ApiError => e
   puts "ERROR: id=#{e.id}; name=#{e.name}; detail: #{e.detail}"
 end