ynab 3.9.0 → 4.9.0

data/lib/ynab/api/scheduled_transactions_api.rb

@@ -4,7 +4,6 @@
 #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
 
 Generated by: OpenAPI Generator (https://openapi-generator.tech)
-
 =end
 
 require 'cgi'
@@ -16,37 +15,37 @@ module YNAB
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Create a single scheduled transaction
+    # Create a scheduled transaction
     # Creates a single scheduled transaction (a transaction with a future date).
-    # @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 plan_id [String] The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).
     # @param data [PostScheduledTransactionWrapper] The scheduled transaction to create
     # @param [Hash] opts the optional parameters
     # @return [ScheduledTransactionResponse]
-    def create_scheduled_transaction(budget_id, data, opts = {})
-      data, _status_code, _headers = create_scheduled_transaction_with_http_info(budget_id, data, opts)
+    def create_scheduled_transaction(plan_id, data, opts = {})
+      data, _status_code, _headers = create_scheduled_transaction_with_http_info(plan_id, data, opts)
       data
     end
 
-    # Create a single scheduled transaction
+    # Create a scheduled transaction
     # Creates a single scheduled transaction (a transaction with a future date).
-    # @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 plan_id [String] The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).
     # @param data [PostScheduledTransactionWrapper] The scheduled transaction to create
     # @param [Hash] opts the optional parameters
     # @return [Array<(ScheduledTransactionResponse, Integer, Hash)>] ScheduledTransactionResponse data, response status code and response headers
-    def create_scheduled_transaction_with_http_info(budget_id, data, opts = {})
+    def create_scheduled_transaction_with_http_info(plan_id, data, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ScheduledTransactionsApi.create_scheduled_transaction ...'
       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 ScheduledTransactionsApi.create_scheduled_transaction"
+      # verify the required parameter 'plan_id' is set
+      if @api_client.config.client_side_validation && plan_id.nil?
+        fail ArgumentError, "Missing the required parameter 'plan_id' when calling ScheduledTransactionsApi.create_scheduled_transaction"
       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 ScheduledTransactionsApi.create_scheduled_transaction"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}/scheduled_transactions'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s))
+      local_var_path = '/budgets/{plan_id}/scheduled_transactions'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -90,37 +89,37 @@ module YNAB
       return data, status_code, headers
     end
 
-    # Deletes an existing scheduled transaction
+    # Delete a scheduled transaction
     # Deletes a scheduled transaction
-    # @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).
+    # @param 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).
     # @param scheduled_transaction_id [String] The id of the scheduled transaction
     # @param [Hash] opts the optional parameters
     # @return [ScheduledTransactionResponse]
-    def delete_scheduled_transaction(budget_id, scheduled_transaction_id, opts = {})
-      data, _status_code, _headers = delete_scheduled_transaction_with_http_info(budget_id, scheduled_transaction_id, opts)
+    def delete_scheduled_transaction(plan_id, scheduled_transaction_id, opts = {})
+      data, _status_code, _headers = delete_scheduled_transaction_with_http_info(plan_id, scheduled_transaction_id, opts)
       data
     end
 
-    # Deletes an existing scheduled transaction
+    # Delete a scheduled transaction
     # Deletes a scheduled transaction
-    # @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).
+    # @param 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).
     # @param scheduled_transaction_id [String] The id of the scheduled transaction
     # @param [Hash] opts the optional parameters
     # @return [Array<(ScheduledTransactionResponse, Integer, Hash)>] ScheduledTransactionResponse data, response status code and response headers
-    def delete_scheduled_transaction_with_http_info(budget_id, scheduled_transaction_id, opts = {})
+    def delete_scheduled_transaction_with_http_info(plan_id, scheduled_transaction_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ScheduledTransactionsApi.delete_scheduled_transaction ...'
       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 ScheduledTransactionsApi.delete_scheduled_transaction"
+      # verify the required parameter 'plan_id' is set
+      if @api_client.config.client_side_validation && plan_id.nil?
+        fail ArgumentError, "Missing the required parameter 'plan_id' when calling ScheduledTransactionsApi.delete_scheduled_transaction"
       end
       # verify the required parameter 'scheduled_transaction_id' is set
       if @api_client.config.client_side_validation && scheduled_transaction_id.nil?
         fail ArgumentError, "Missing the required parameter 'scheduled_transaction_id' when calling ScheduledTransactionsApi.delete_scheduled_transaction"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id}'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s)).sub('{' + 'scheduled_transaction_id' + '}', CGI.escape(scheduled_transaction_id.to_s))
+      local_var_path = '/budgets/{plan_id}/scheduled_transactions/{scheduled_transaction_id}'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s)).sub('{' + 'scheduled_transaction_id' + '}', CGI.escape(scheduled_transaction_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -159,37 +158,37 @@ module YNAB
       return data, status_code, headers
     end
 
-    # Single scheduled transaction
+    # Get a scheduled transaction
     # Returns a single scheduled transaction
-    # @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).
+    # @param 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).
     # @param scheduled_transaction_id [String] The id of the scheduled transaction
     # @param [Hash] opts the optional parameters
     # @return [ScheduledTransactionResponse]
-    def get_scheduled_transaction_by_id(budget_id, scheduled_transaction_id, opts = {})
-      data, _status_code, _headers = get_scheduled_transaction_by_id_with_http_info(budget_id, scheduled_transaction_id, opts)
+    def get_scheduled_transaction_by_id(plan_id, scheduled_transaction_id, opts = {})
+      data, _status_code, _headers = get_scheduled_transaction_by_id_with_http_info(plan_id, scheduled_transaction_id, opts)
       data
     end
 
-    # Single scheduled transaction
+    # Get a scheduled transaction
     # Returns a single scheduled transaction
-    # @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).
+    # @param 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).
     # @param scheduled_transaction_id [String] The id of the scheduled transaction
     # @param [Hash] opts the optional parameters
     # @return [Array<(ScheduledTransactionResponse, Integer, Hash)>] ScheduledTransactionResponse data, response status code and response headers
-    def get_scheduled_transaction_by_id_with_http_info(budget_id, scheduled_transaction_id, opts = {})
+    def get_scheduled_transaction_by_id_with_http_info(plan_id, scheduled_transaction_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ScheduledTransactionsApi.get_scheduled_transaction_by_id ...'
       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 ScheduledTransactionsApi.get_scheduled_transaction_by_id"
+      # verify the required parameter 'plan_id' is set
+      if @api_client.config.client_side_validation && plan_id.nil?
+        fail ArgumentError, "Missing the required parameter 'plan_id' when calling ScheduledTransactionsApi.get_scheduled_transaction_by_id"
       end
       # verify the required parameter 'scheduled_transaction_id' is set
       if @api_client.config.client_side_validation && scheduled_transaction_id.nil?
         fail ArgumentError, "Missing the required parameter 'scheduled_transaction_id' when calling ScheduledTransactionsApi.get_scheduled_transaction_by_id"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id}'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s)).sub('{' + 'scheduled_transaction_id' + '}', CGI.escape(scheduled_transaction_id.to_s))
+      local_var_path = '/budgets/{plan_id}/scheduled_transactions/{scheduled_transaction_id}'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s)).sub('{' + 'scheduled_transaction_id' + '}', CGI.escape(scheduled_transaction_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -228,33 +227,33 @@ module YNAB
       return data, status_code, headers
     end
 
-    # List scheduled transactions
+    # Get all scheduled transactions
     # Returns all scheduled transactions
-    # @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).
+    # @param 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).
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :last_knowledge_of_server The starting server knowledge.  If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included.
     # @return [ScheduledTransactionsResponse]
-    def get_scheduled_transactions(budget_id, opts = {})
-      data, _status_code, _headers = get_scheduled_transactions_with_http_info(budget_id, opts)
+    def get_scheduled_transactions(plan_id, opts = {})
+      data, _status_code, _headers = get_scheduled_transactions_with_http_info(plan_id, opts)
       data
     end
 
-    # List scheduled transactions
+    # Get all scheduled transactions
     # Returns all scheduled transactions
-    # @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).
+    # @param 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).
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :last_knowledge_of_server The starting server knowledge.  If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included.
     # @return [Array<(ScheduledTransactionsResponse, Integer, Hash)>] ScheduledTransactionsResponse data, response status code and response headers
-    def get_scheduled_transactions_with_http_info(budget_id, opts = {})
+    def get_scheduled_transactions_with_http_info(plan_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ScheduledTransactionsApi.get_scheduled_transactions ...'
       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 ScheduledTransactionsApi.get_scheduled_transactions"
+      # verify the required parameter 'plan_id' is set
+      if @api_client.config.client_side_validation && plan_id.nil?
+        fail ArgumentError, "Missing the required parameter 'plan_id' when calling ScheduledTransactionsApi.get_scheduled_transactions"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}/scheduled_transactions'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s))
+      local_var_path = '/budgets/{plan_id}/scheduled_transactions'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -294,32 +293,32 @@ module YNAB
       return data, status_code, headers
     end
 
-    # Updates an existing scheduled transaction
+    # Update a scheduled transaction
     # Updates a single scheduled transaction
-    # @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).
+    # @param 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).
     # @param scheduled_transaction_id [String] The id of the scheduled transaction
     # @param put_scheduled_transaction_wrapper [PutScheduledTransactionWrapper] The scheduled transaction to update
     # @param [Hash] opts the optional parameters
     # @return [ScheduledTransactionResponse]
-    def update_scheduled_transaction(budget_id, scheduled_transaction_id, put_scheduled_transaction_wrapper, opts = {})
-      data, _status_code, _headers = update_scheduled_transaction_with_http_info(budget_id, scheduled_transaction_id, put_scheduled_transaction_wrapper, opts)
+    def update_scheduled_transaction(plan_id, scheduled_transaction_id, put_scheduled_transaction_wrapper, opts = {})
+      data, _status_code, _headers = update_scheduled_transaction_with_http_info(plan_id, scheduled_transaction_id, put_scheduled_transaction_wrapper, opts)
       data
     end
 
-    # Updates an existing scheduled transaction
+    # Update a scheduled transaction
     # Updates a single scheduled transaction
-    # @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).
+    # @param 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).
     # @param scheduled_transaction_id [String] The id of the scheduled transaction
     # @param put_scheduled_transaction_wrapper [PutScheduledTransactionWrapper] The scheduled transaction to update
     # @param [Hash] opts the optional parameters
     # @return [Array<(ScheduledTransactionResponse, Integer, Hash)>] ScheduledTransactionResponse data, response status code and response headers
-    def update_scheduled_transaction_with_http_info(budget_id, scheduled_transaction_id, put_scheduled_transaction_wrapper, opts = {})
+    def update_scheduled_transaction_with_http_info(plan_id, scheduled_transaction_id, put_scheduled_transaction_wrapper, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ScheduledTransactionsApi.update_scheduled_transaction ...'
       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 ScheduledTransactionsApi.update_scheduled_transaction"
+      # verify the required parameter 'plan_id' is set
+      if @api_client.config.client_side_validation && plan_id.nil?
+        fail ArgumentError, "Missing the required parameter 'plan_id' when calling ScheduledTransactionsApi.update_scheduled_transaction"
       end
       # verify the required parameter 'scheduled_transaction_id' is set
       if @api_client.config.client_side_validation && scheduled_transaction_id.nil?
@@ -330,7 +329,7 @@ module YNAB
         fail ArgumentError, "Missing the required parameter 'put_scheduled_transaction_wrapper' when calling ScheduledTransactionsApi.update_scheduled_transaction"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id}'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s)).sub('{' + 'scheduled_transaction_id' + '}', CGI.escape(scheduled_transaction_id.to_s))
+      local_var_path = '/budgets/{plan_id}/scheduled_transactions/{scheduled_transaction_id}'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s)).sub('{' + 'scheduled_transaction_id' + '}', CGI.escape(scheduled_transaction_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}