ynab 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 376e9bdd8f0bd3297a0f8e7d7e7d3924f6763773c791d86063bff5d675d20517
-  data.tar.gz: 5d1611601e740c6d8280f2f4057edbcd21791b523ac7064f996917b107b8c3e7
+  metadata.gz: ba7a84ac5b9371284fb8fd66c0d19709ce704ee69f33832c670534b3956be77b
+  data.tar.gz: 959a2cb11043f907774c847d9752d5870f6c90f3db2862f2e518c7108618afe5
 SHA512:
-  metadata.gz: 81c0c4ad36f870329f74407cb2c901d19a37f2236251e451879fbaaec8ea34cfc822dbdd22888ef0be50758b45aac381a87169c14499a71215460d397835098b
-  data.tar.gz: ab3f318ee83b37ba72ea6732d99c35b6a467b99127a12c5bc23d7a37c83274580100e139ca18f2239666548b4f25493cd5824a7d0596da0f379a25437d29d359
+  metadata.gz: 05f22c154b9040eb336586b6f0fa08d297259100dbc9e324fb9f4a4aee5c8c82c483e189a2ada29e2f0abed15f2e1f930717db50c4e952f2bdc13225c9f5aa0f
+  data.tar.gz: 5ae228fd03e31c75c35d24135c1fd4781fd5b7d0cdb81904f1458c792cf2c096b56309d5ea8a0c3d1751bc04665c072e7692f5b91e3ef8121ee4eb208e829317

data/DEVELOPMENT.md

@@ -3,9 +3,13 @@
 ## Setup
 
 - Install dependencies: `bundle`
-- Generate latest client based on swagger spec: `rake generate`
-- Run tests: `rake spec` or `rspec`
+- Generate latest client based on OpenAPI spec:
+  - Install [OpenAPI Generator](https://openapi-generator.tech/), for macOS: `brew install openapi-generator`
+  - Run `bundle exec rake generate`
+- Run tests: `bundle exec rake spec` or `rspec`
 
 ## Publishing
 
 Run the "Publish" GitHub Actions workflow
+
+Note: Use the Publish workflow to bump the version number in `lib/ynab/version.rb`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ynab (4.31.0)
+    ynab (3.0.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -16,6 +16,8 @@ This client is generated using the [OpenAPI Generator](https://openapi-generator
 gem install ynab
 ```
 
+Note: The current version of this gem requires Ruby version 3.3 or later. If you are using an older version of Ruby, you can install [version 2.1](https://rubygems.org/gems/ynab/versions/2.1.0) of this gem.
+
 ## Usage
 To use this client you must
 [obtain an access token](https://api.ynab.com/#authentication-overview) from
@@ -78,6 +80,6 @@ The following methods are available in this library.
 
 ## License
 
-Copyright (c) 2022 You Need A Budget, LLC
+Copyright (c) 2024 You Need A Budget, LLC
 
 Licensed under the Apache-2.0 license

data/docs/BulkTransactions.md

@@ -4,5 +4,5 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **transactions** | [**Array<SaveTransaction>**](SaveTransaction.md) |  |  |
+| **transactions** | [**Array<SaveTransactionWithOptionalFields>**](SaveTransactionWithOptionalFields.md) |  |  |
 

data/docs/CategoriesApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://api.ynab.com/v1*
 | [**get_categories**](CategoriesApi.md#get_categories) | **GET** /budgets/{budget_id}/categories | List categories |
 | [**get_category_by_id**](CategoriesApi.md#get_category_by_id) | **GET** /budgets/{budget_id}/categories/{category_id} | Single category |
 | [**get_month_category_by_id**](CategoriesApi.md#get_month_category_by_id) | **GET** /budgets/{budget_id}/months/{month}/categories/{category_id} | Single category for a specific budget month |
+| [**update_category**](CategoriesApi.md#update_category) | **PATCH** /budgets/{budget_id}/categories/{category_id} | Update a category |
 | [**update_month_category**](CategoriesApi.md#update_month_category) | **PATCH** /budgets/{budget_id}/months/{month}/categories/{category_id} | Update a category for a specific month |
 
 
@@ -71,6 +72,27 @@ Returns a single category for a specific budget month.  Amounts (budgeted, activ
 [**CategoryResponse**](CategoryResponse.md)
 
 
+## update_category
+
+> <SaveCategoryResponse> update_category(budget_id, category_id, data)
+
+Update a category
+
+Update a 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 |  |
+| **data** | [**PatchCategoryWrapper**](PatchCategoryWrapper.md) | The category to update |  |
+
+### Return type
+
+[**SaveCategoryResponse**](SaveCategoryResponse.md)
+
+
 ## update_month_category
 
 > <SaveCategoryResponse> update_month_category(budget_id, month, category_id, data)

data/docs/ExistingTransaction.md

@@ -0,0 +1,18 @@
+# YNAB::ExistingTransaction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** |  | [optional] |
+| **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. | [optional] |
+| **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. | [optional] |
+| **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** | [**TransactionClearedStatus**](TransactionClearedStatus.md) |  | [optional] |
+| **approved** | **Boolean** | Whether or not the transaction is approved.  If not supplied, transaction will be unapproved by default. | [optional] |
+| **flag_color** | [**TransactionFlagColor**](TransactionFlagColor.md) |  | [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] |
+

data/docs/HybridTransaction.md

@@ -8,9 +8,10 @@
 | **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 |  |
+| **cleared** | [**TransactionClearedStatus**](TransactionClearedStatus.md) |  |  |
 | **approved** | **Boolean** | Whether or not the transaction is approved |  |
-| **flag_color** | **String** | The transaction flag | [optional] |
+| **flag_color** | [**TransactionFlagColor**](TransactionFlagColor.md) |  | [optional] |
+| **flag_name** | **String** | The customized name of a transaction flag | [optional] |
 | **account_id** | **String** |  |  |
 | **payee_id** | **String** |  | [optional] |
 | **category_id** | **String** |  | [optional] |

data/docs/NewTransaction.md

@@ -0,0 +1,19 @@
+# YNAB::NewTransaction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** |  | [optional] |
+| **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. | [optional] |
+| **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. | [optional] |
+| **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** | [**TransactionClearedStatus**](TransactionClearedStatus.md) |  | [optional] |
+| **approved** | **Boolean** | Whether or not the transaction is approved.  If not supplied, transaction will be unapproved by default. | [optional] |
+| **flag_color** | [**TransactionFlagColor**](TransactionFlagColor.md) |  | [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] |
+| **import_id** | **String** | If specified, a 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\" transaction 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] |
+

data/docs/PatchCategoryWrapper.md

@@ -0,0 +1,8 @@
+# YNAB::PatchCategoryWrapper
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category** | [**SaveCategory**](SaveCategory.md) |  |  |
+

data/docs/PatchPayeeWrapper.md

@@ -0,0 +1,8 @@
+# YNAB::PatchPayeeWrapper
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payee** | [**SavePayee**](SavePayee.md) |  |  |
+

data/docs/PatchTransactionsWrapper.md

@@ -4,5 +4,5 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **transactions** | [**Array<SaveTransactionWithId>**](SaveTransactionWithId.md) |  |  |
+| **transactions** | [**Array<SaveTransactionWithIdOrImportId>**](SaveTransactionWithIdOrImportId.md) |  |  |
 

data/docs/PayeesApi.md

@@ -6,6 +6,7 @@ All URIs are relative to *https://api.ynab.com/v1*
 | ------ | ------------ | ----------- |
 | [**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 |
+| [**update_payee**](PayeesApi.md#update_payee) | **PATCH** /budgets/{budget_id}/payees/{payee_id} | Update a payee |
 
 
 ## get_payee_by_id
@@ -47,3 +48,24 @@ Returns all payees
 
 [**PayeesResponse**](PayeesResponse.md)
 
+
+## update_payee
+
+> <SavePayeeResponse> update_payee(budget_id, payee_id, data)
+
+Update a payee
+
+Update a 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 |  |
+| **data** | [**PatchPayeeWrapper**](PatchPayeeWrapper.md) | The payee to update |  |
+
+### Return type
+
+[**SavePayeeResponse**](SavePayeeResponse.md)
+

data/docs/PostTransactionsWrapper.md

@@ -4,6 +4,6 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **transaction** | [**SaveTransaction**](SaveTransaction.md) |  | [optional] |
-| **transactions** | [**Array<SaveTransaction>**](SaveTransaction.md) |  | [optional] |
+| **transaction** | [**NewTransaction**](NewTransaction.md) |  | [optional] |
+| **transactions** | [**Array<NewTransaction>**](NewTransaction.md) |  | [optional] |
 

data/docs/PutTransactionWrapper.md

@@ -4,5 +4,5 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **transaction** | [**SaveTransaction**](SaveTransaction.md) |  |  |
+| **transaction** | [**ExistingTransaction**](ExistingTransaction.md) |  |  |
 

data/docs/SaveCategory.md

@@ -0,0 +1,10 @@
+# YNAB::SaveCategory
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **note** | **String** |  | [optional] |
+| **category_group_id** | **String** |  | [optional] |
+

data/docs/SavePayee.md

@@ -0,0 +1,8 @@
+# YNAB::SavePayee
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the payee. The name must be a maximum of 500 characters. | [optional] |
+

data/docs/SavePayeeResponse.md

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

data/docs/SavePayeeResponseData.md

@@ -0,0 +1,9 @@
+# YNAB::SavePayeeResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payee** | [**Payee**](Payee.md) |  |  |
+| **server_knowledge** | **Integer** | The knowledge of the server |  |
+

data/docs/SaveTransactionWithIdOrImportId.md

@@ -0,0 +1,20 @@
+# YNAB::SaveTransactionWithIdOrImportId
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** |  | [optional] |
+| **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. | [optional] |
+| **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. | [optional] |
+| **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** | [**TransactionClearedStatus**](TransactionClearedStatus.md) |  | [optional] |
+| **approved** | **Boolean** | Whether or not the transaction is approved.  If not supplied, transaction will be unapproved by default. | [optional] |
+| **flag_color** | [**TransactionFlagColor**](TransactionFlagColor.md) |  | [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** | If specified, this id will be used to lookup a transaction by its `id` for the purpose of updating the transaction itself. If not specified, an `import_id` should be supplied. | [optional] |
+| **import_id** | **String** | If specified, this id will be used to lookup a transaction by its `import_id` for the purpose of updating the transaction itself. If not specified, an `id` should be supplied.  You may not provide both an `id` and an `import_id` and updating an `import_id` on an existing transaction is not allowed. | [optional] |
+

data/docs/SaveTransactionWithOptionalFields.md

@@ -11,9 +11,8 @@
 | **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] |
+| **cleared** | [**TransactionClearedStatus**](TransactionClearedStatus.md) |  | [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] |
+| **flag_color** | [**TransactionFlagColor**](TransactionFlagColor.md) |  | [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] |
 

data/docs/ScheduledTransactionDetail.md

@@ -10,7 +10,8 @@
 | **frequency** | **String** |  |  |
 | **amount** | **Integer** | The scheduled transaction amount in milliunits format |  |
 | **memo** | **String** |  | [optional] |
-| **flag_color** | **String** | The scheduled transaction flag | [optional] |
+| **flag_color** | [**TransactionFlagColor**](TransactionFlagColor.md) |  | [optional] |
+| **flag_name** | **String** | The customized name of a transaction flag | [optional] |
 | **account_id** | **String** |  |  |
 | **payee_id** | **String** |  | [optional] |
 | **category_id** | **String** |  | [optional] |

data/docs/ScheduledTransactionSummary.md

@@ -10,7 +10,8 @@
 | **frequency** | **String** |  |  |
 | **amount** | **Integer** | The scheduled transaction amount in milliunits format |  |
 | **memo** | **String** |  | [optional] |
-| **flag_color** | **String** | The scheduled transaction flag | [optional] |
+| **flag_color** | [**TransactionFlagColor**](TransactionFlagColor.md) |  | [optional] |
+| **flag_name** | **String** | The customized name of a transaction flag | [optional] |
 | **account_id** | **String** |  |  |
 | **payee_id** | **String** |  | [optional] |
 | **category_id** | **String** |  | [optional] |

data/docs/TransactionClearedStatus.md

@@ -0,0 +1,7 @@
+# YNAB::TransactionClearedStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+

data/docs/TransactionDetail.md

@@ -8,9 +8,10 @@
 | **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 |  |
+| **cleared** | [**TransactionClearedStatus**](TransactionClearedStatus.md) |  |  |
 | **approved** | **Boolean** | Whether or not the transaction is approved |  |
-| **flag_color** | **String** | The transaction flag | [optional] |
+| **flag_color** | [**TransactionFlagColor**](TransactionFlagColor.md) |  | [optional] |
+| **flag_name** | **String** | The customized name of a transaction flag | [optional] |
 | **account_id** | **String** |  |  |
 | **payee_id** | **String** |  | [optional] |
 | **category_id** | **String** |  | [optional] |

data/docs/TransactionFlagColor.md

@@ -0,0 +1,7 @@
+# YNAB::TransactionFlagColor
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+

data/docs/TransactionSummary.md

@@ -8,9 +8,10 @@
 | **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 |  |
+| **cleared** | [**TransactionClearedStatus**](TransactionClearedStatus.md) |  |  |
 | **approved** | **Boolean** | Whether or not the transaction is approved |  |
-| **flag_color** | **String** | The transaction flag | [optional] |
+| **flag_color** | [**TransactionFlagColor**](TransactionFlagColor.md) |  | [optional] |
+| **flag_name** | **String** | The customized name of a transaction flag | [optional] |
 | **account_id** | **String** |  |  |
 | **payee_id** | **String** |  | [optional] |
 | **category_id** | **String** |  | [optional] |

data/docs/TransactionsApi.md

@@ -9,8 +9,8 @@ All URIs are relative to *https://api.ynab.com/v1*
 | [**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 |
+| [**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_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 |
@@ -82,7 +82,7 @@ Returns a single transaction
 
 List transactions
 
-Returns budget transactions
+Returns budget transactions, excluding any pending transactions
 
 ### Parameters
 
@@ -104,7 +104,7 @@ Returns budget transactions
 
 List account transactions
 
-Returns all transactions for a specified account
+Returns all transactions for a specified account, excluding any pending transactions
 
 ### Parameters
 
@@ -125,7 +125,7 @@ Returns all transactions for a specified account
 
 > <HybridTransactionsResponse> get_transactions_by_category(budget_id, category_id, opts)
 
-List category transactions
+List category transactions, excluding any pending transactions
 
 Returns all transactions for a specified category
 
@@ -148,7 +148,7 @@ Returns all transactions for a specified category
 
 > <HybridTransactionsResponse> get_transactions_by_payee(budget_id, payee_id, opts)
 
-List payee transactions
+List payee transactions, excluding any pending transactions
 
 Returns all transactions for a specified payee
 
@@ -220,7 +220,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). |  |
-| **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. |  |
+| **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/lib/ynab/api/accounts_api.rb

@@ -3,10 +3,10 @@
 
 #Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body.  API Documentation is at https://api.ynab.com
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 1.69.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.6.0
+Generator version: 7.6.0
 
 =end
 

data/lib/ynab/api/budgets_api.rb

@@ -3,10 +3,10 @@
 
 #Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body.  API Documentation is at https://api.ynab.com
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 1.69.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.6.0
+Generator version: 7.6.0
 
 =end
 

data/lib/ynab/api/categories_api.rb

@@ -3,10 +3,10 @@
 
 #Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body.  API Documentation is at https://api.ynab.com
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 1.69.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.6.0
+Generator version: 7.6.0
 
 =end
 
@@ -229,6 +229,86 @@ module YNAB
       return data, status_code, headers
     end
 
+    # Update a category
+    # Update a category
+    # @param budget_id [String] The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).
+    # @param category_id [String] The id of the category
+    # @param data [PatchCategoryWrapper] The category to update
+    # @param [Hash] opts the optional parameters
+    # @return [SaveCategoryResponse]
+    def update_category(budget_id, category_id, data, opts = {})
+      data, _status_code, _headers = update_category_with_http_info(budget_id, category_id, data, opts)
+      data
+    end
+
+    # Update a category
+    # Update a category
+    # @param budget_id [String] The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).
+    # @param category_id [String] The id of the category
+    # @param data [PatchCategoryWrapper] The category to update
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SaveCategoryResponse, Integer, Hash)>] SaveCategoryResponse data, response status code and response headers
+    def update_category_with_http_info(budget_id, category_id, data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CategoriesApi.update_category ...'
+      end
+      # verify the required parameter 'budget_id' is set
+      if @api_client.config.client_side_validation && budget_id.nil?
+        fail ArgumentError, "Missing the required parameter 'budget_id' when calling CategoriesApi.update_category"
+      end
+      # verify the required parameter 'category_id' is set
+      if @api_client.config.client_side_validation && category_id.nil?
+        fail ArgumentError, "Missing the required parameter 'category_id' when calling CategoriesApi.update_category"
+      end
+      # verify the required parameter 'data' is set
+      if @api_client.config.client_side_validation && data.nil?
+        fail ArgumentError, "Missing the required parameter 'data' when calling CategoriesApi.update_category"
+      end
+      # resource path
+      local_var_path = '/budgets/{budget_id}/categories/{category_id}'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s)).sub('{' + 'category_id' + '}', CGI.escape(category_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SaveCategoryResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"CategoriesApi.update_category",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CategoriesApi#update_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update a category for a specific month
     # Update a category for a specific month.  Only `budgeted` amount can be updated.
     # @param 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/lib/ynab/api/months_api.rb

@@ -3,10 +3,10 @@
 
 #Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body.  API Documentation is at https://api.ynab.com
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 1.69.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.6.0
+Generator version: 7.6.0
 
 =end
 

data/lib/ynab/api/payee_locations_api.rb

@@ -3,10 +3,10 @@
 
 #Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body.  API Documentation is at https://api.ynab.com
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 1.69.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.6.0
+Generator version: 7.6.0
 
 =end