Generate from spec version 1.71.0 - POST scheduled txns

.openapi-generator/FILES

@@ -62,6 +62,7 @@ docs/PayeesApi.md
 docs/PayeesResponse.md
 docs/PayeesResponseData.md
 docs/PostAccountWrapper.md
+docs/PostScheduledTransactionWrapper.md
 docs/PostTransactionsWrapper.md
 docs/PutTransactionWrapper.md
 docs/SaveAccount.md
@@ -72,13 +73,15 @@ docs/SaveMonthCategory.md
 docs/SavePayee.md
 docs/SavePayeeResponse.md
 docs/SavePayeeResponseData.md
+docs/SaveScheduledTransaction.md
 docs/SaveSubTransaction.md
 docs/SaveTransactionWithIdOrImportId.md
 docs/SaveTransactionWithOptionalFields.md
 docs/SaveTransactionsResponse.md
 docs/SaveTransactionsResponseData.md
 docs/ScheduledSubTransaction.md
 docs/ScheduledTransactionDetail.md
+docs/ScheduledTransactionFrequency.md
 docs/ScheduledTransactionResponse.md
 docs/ScheduledTransactionResponseData.md
 docs/ScheduledTransactionSummary.md
@@ -169,6 +172,7 @@ lib/ynab/models/payee_response_data.rb
 lib/ynab/models/payees_response.rb
 lib/ynab/models/payees_response_data.rb
 lib/ynab/models/post_account_wrapper.rb
+lib/ynab/models/post_scheduled_transaction_wrapper.rb
 lib/ynab/models/post_transactions_wrapper.rb
 lib/ynab/models/put_transaction_wrapper.rb
 lib/ynab/models/save_account.rb
@@ -179,13 +183,15 @@ lib/ynab/models/save_month_category.rb
 lib/ynab/models/save_payee.rb
 lib/ynab/models/save_payee_response.rb
 lib/ynab/models/save_payee_response_data.rb
+lib/ynab/models/save_scheduled_transaction.rb
 lib/ynab/models/save_sub_transaction.rb
 lib/ynab/models/save_transaction_with_id_or_import_id.rb
 lib/ynab/models/save_transaction_with_optional_fields.rb
 lib/ynab/models/save_transactions_response.rb
 lib/ynab/models/save_transactions_response_data.rb
 lib/ynab/models/scheduled_sub_transaction.rb
 lib/ynab/models/scheduled_transaction_detail.rb
+lib/ynab/models/scheduled_transaction_frequency.rb
 lib/ynab/models/scheduled_transaction_response.rb
 lib/ynab/models/scheduled_transaction_response_data.rb
 lib/ynab/models/scheduled_transaction_summary.rb

.openapi-generator/VERSION

@@ -1 +1 @@
-7.6.0
+7.7.0

README.md

@@ -77,6 +77,7 @@ The following methods are available in this library.
 |                            | [transactions.import_transactions(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#import_transactions)                                                                      | Imports transactions                       |
 | **Scheduled Transactions** | [scheduled_transactions.get_scheduled_transactions(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/ScheduledTransactionsApi.md#get_scheduled_transactions)                                     | Returns all scheduled transactions                    |
 |                            | [scheduled_transactions.get_scheduled_transaction_by_id(budget_id, scheduled_transaction_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/ScheduledTransactionsApi.md#get_scheduled_transaction_by_id) | Returns a single scheduled transaction                |
+|                            | [scheduled_transactions.create_scheduled_transaction(budget_id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/ScheduledTransactionsApi.md#create_scheduled_transaction)                                                                  | Creates a single scheduled transaction                      |
 
 ## License
 

Rakefile

@@ -12,8 +12,6 @@ end
 
 task :default => [:spec]
 
-REQUIRED_RUBY_VERSION = ">= 3.3"
-
 desc "Run OpenAPI Generator to update the client from the spec"
 task :generate do
   spec_filename = 'open_api_spec.yaml'
@@ -22,7 +20,7 @@ task :generate do
   # Remove existing generated files to ensure old files are not included in the gem
   sh "rm -r docs/ lib/ynab/models/"
   # Generate the client
-  sh "openapi-generator generate -i ./#{spec_filename} -g ruby --additional-properties=gemRequiredRubyVersion='#{REQUIRED_RUBY_VERSION}' -c config.json -t ./templates -o ./"
+  sh "openapi-generator generate -i ./#{spec_filename} -g ruby -c config.yaml -o ./"
 end
 
 task :get_current_version do

config.yaml

@@ -0,0 +1,11 @@
+gemName: ynab
+moduleName: YNAB
+gemSummary: YNAB API Client for Ruby
+gemDescription: Ruby gem wrapper for the YNAB API.
+gemHomepage: https://github.com/ynab/ynab-sdk-ruby
+gemLicense: Apache-2.0
+gemAuthor: YNAB
+gemAuthorEmail: [email protected]
+templateDir: ./templates
+additionalProperties:
+  gemRequiredRubyVersion: ">= 3.3"

docs/ExistingTransaction.md

@@ -7,7 +7,7 @@
 | **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_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 `transfer_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] |

docs/NewTransaction.md

@@ -7,7 +7,7 @@
 | **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_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 `transfer_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] |

docs/PostScheduledTransactionWrapper.md

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

docs/SaveScheduledTransaction.md

@@ -0,0 +1,16 @@
+# YNAB::SaveScheduledTransaction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** |  |  |
+| **date** | **Date** | The scheduled transaction date in ISO format (e.g. 2016-12-01). |  |
+| **amount** | **Integer** | The scheduled transaction amount in milliunits format. | [optional] |
+| **payee_id** | **String** | The payee for the scheduled transaction.  To create a transfer between two accounts, use the account transfer payee pointing to the target account.  Account transfer payees are specified as `transfer_payee_id` on the account resource. | [optional] |
+| **payee_name** | **String** | The payee name for the the scheduled transaction.  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 payee with the same name or (2) creation of a new payee. | [optional] |
+| **category_id** | **String** | The category for the scheduled transaction. Credit Card Payment categories are not permitted. Creating a split scheduled transaction is not currently supported. | [optional] |
+| **memo** | **String** |  | [optional] |
+| **flag_color** | [**TransactionFlagColor**](TransactionFlagColor.md) |  | [optional] |
+| **frequency** | [**ScheduledTransactionFrequency**](ScheduledTransactionFrequency.md) |  | [optional] |
+

docs/SaveTransactionWithIdOrImportId.md

@@ -7,7 +7,7 @@
 | **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_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 `transfer_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] |

docs/SaveTransactionWithOptionalFields.md

@@ -7,7 +7,7 @@
 | **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_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 `transfer_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] |

docs/ScheduledTransactionFrequency.md

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

docs/ScheduledTransactionsApi.md

@@ -4,10 +4,31 @@ 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 |
 | [**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 |
 
 
+## create_scheduled_transaction
+
+> <ScheduledTransactionResponse> create_scheduled_transaction(budget_id, data)
+
+Create a single scheduled transaction
+
+Creates a single scheduled 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). |  |
+| **data** | [**PostScheduledTransactionWrapper**](PostScheduledTransactionWrapper.md) | The scheduled transaction to create |  |
+
+### Return type
+
+[**ScheduledTransactionResponse**](ScheduledTransactionResponse.md)
+
+
 ## get_scheduled_transaction_by_id
 
 > <ScheduledTransactionResponse> get_scheduled_transaction_by_id(budget_id, scheduled_transaction_id)

docs/TransactionsApi.md

@@ -22,7 +22,7 @@ All URIs are relative to *https://api.ynab.com/v1*
 
 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.
+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 (transactions with a future date) cannot be created on this endpoint.
 
 ### Parameters
 

lib/ynab.rb

@@ -70,6 +70,7 @@
 require 'ynab/models/payees_response'
 require 'ynab/models/payees_response_data'
 require 'ynab/models/post_account_wrapper'
+require 'ynab/models/post_scheduled_transaction_wrapper'
 require 'ynab/models/post_transactions_wrapper'
 require 'ynab/models/put_transaction_wrapper'
 require 'ynab/models/save_account'
@@ -80,13 +81,15 @@
 require 'ynab/models/save_payee'
 require 'ynab/models/save_payee_response'
 require 'ynab/models/save_payee_response_data'
+require 'ynab/models/save_scheduled_transaction'
 require 'ynab/models/save_sub_transaction'
 require 'ynab/models/save_transaction_with_id_or_import_id'
 require 'ynab/models/save_transaction_with_optional_fields'
 require 'ynab/models/save_transactions_response'
 require 'ynab/models/save_transactions_response_data'
 require 'ynab/models/scheduled_sub_transaction'
 require 'ynab/models/scheduled_transaction_detail'
+require 'ynab/models/scheduled_transaction_frequency'
 require 'ynab/models/scheduled_transaction_response'
 require 'ynab/models/scheduled_transaction_response_data'
 require 'ynab/models/scheduled_transaction_summary'