ynab 3.9.0 → 4.9.0

data/lib/ynab/api/accounts_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 new account
+    # Create an account
     # Creates a new account
-    # @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 [PostAccountWrapper] The account to create.
     # @param [Hash] opts the optional parameters
     # @return [AccountResponse]
-    def create_account(budget_id, data, opts = {})
-      data, _status_code, _headers = create_account_with_http_info(budget_id, data, opts)
+    def create_account(plan_id, data, opts = {})
+      data, _status_code, _headers = create_account_with_http_info(plan_id, data, opts)
       data
     end
 
-    # Create a new account
+    # Create an account
     # Creates a new account
-    # @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 [PostAccountWrapper] The account to create.
     # @param [Hash] opts the optional parameters
     # @return [Array<(AccountResponse, Integer, Hash)>] AccountResponse data, response status code and response headers
-    def create_account_with_http_info(budget_id, data, opts = {})
+    def create_account_with_http_info(plan_id, data, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AccountsApi.create_account ...'
       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 AccountsApi.create_account"
+      # 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 AccountsApi.create_account"
       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 AccountsApi.create_account"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}/accounts'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s))
+      local_var_path = '/budgets/{plan_id}/accounts'.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
 
-    # Single account
+    # Get an account
     # Returns a single account
-    # @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 account_id [String] The id of the account
     # @param [Hash] opts the optional parameters
     # @return [AccountResponse]
-    def get_account_by_id(budget_id, account_id, opts = {})
-      data, _status_code, _headers = get_account_by_id_with_http_info(budget_id, account_id, opts)
+    def get_account_by_id(plan_id, account_id, opts = {})
+      data, _status_code, _headers = get_account_by_id_with_http_info(plan_id, account_id, opts)
       data
     end
 
-    # Single account
+    # Get an account
     # Returns a single account
-    # @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 account_id [String] The id of the account
     # @param [Hash] opts the optional parameters
     # @return [Array<(AccountResponse, Integer, Hash)>] AccountResponse data, response status code and response headers
-    def get_account_by_id_with_http_info(budget_id, account_id, opts = {})
+    def get_account_by_id_with_http_info(plan_id, account_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AccountsApi.get_account_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 AccountsApi.get_account_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 AccountsApi.get_account_by_id"
       end
       # verify the required parameter 'account_id' is set
       if @api_client.config.client_side_validation && account_id.nil?
         fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_by_id"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}/accounts/{account_id}'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s)).sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s))
+      local_var_path = '/budgets/{plan_id}/accounts/{account_id}'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s)).sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -159,33 +158,33 @@ module YNAB
       return data, status_code, headers
     end
 
-    # Account list
+    # Get all accounts
     # Returns all accounts
-    # @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 [AccountsResponse]
-    def get_accounts(budget_id, opts = {})
-      data, _status_code, _headers = get_accounts_with_http_info(budget_id, opts)
+    def get_accounts(plan_id, opts = {})
+      data, _status_code, _headers = get_accounts_with_http_info(plan_id, opts)
       data
     end
 
-    # Account list
+    # Get all accounts
     # Returns all accounts
-    # @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<(AccountsResponse, Integer, Hash)>] AccountsResponse data, response status code and response headers
-    def get_accounts_with_http_info(budget_id, opts = {})
+    def get_accounts_with_http_info(plan_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AccountsApi.get_accounts ...'
       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 AccountsApi.get_accounts"
+      # 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 AccountsApi.get_accounts"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}/accounts'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s))
+      local_var_path = '/budgets/{plan_id}/accounts'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}