ynab 3.9.0 → 4.9.0

data/lib/ynab/api/payees_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
-    # Single payee
+    # Get a payee
     # Returns a single payee
-    # @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 payee_id [String] The id of the payee
     # @param [Hash] opts the optional parameters
     # @return [PayeeResponse]
-    def get_payee_by_id(budget_id, payee_id, opts = {})
-      data, _status_code, _headers = get_payee_by_id_with_http_info(budget_id, payee_id, opts)
+    def get_payee_by_id(plan_id, payee_id, opts = {})
+      data, _status_code, _headers = get_payee_by_id_with_http_info(plan_id, payee_id, opts)
       data
     end
 
-    # Single payee
+    # Get a payee
     # Returns a single payee
-    # @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 payee_id [String] The id of the payee
     # @param [Hash] opts the optional parameters
     # @return [Array<(PayeeResponse, Integer, Hash)>] PayeeResponse data, response status code and response headers
-    def get_payee_by_id_with_http_info(budget_id, payee_id, opts = {})
+    def get_payee_by_id_with_http_info(plan_id, payee_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PayeesApi.get_payee_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 PayeesApi.get_payee_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 PayeesApi.get_payee_by_id"
       end
       # verify the required parameter 'payee_id' is set
       if @api_client.config.client_side_validation && payee_id.nil?
         fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.get_payee_by_id"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}/payees/{payee_id}'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s)).sub('{' + 'payee_id' + '}', CGI.escape(payee_id.to_s))
+      local_var_path = '/budgets/{plan_id}/payees/{payee_id}'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s)).sub('{' + 'payee_id' + '}', CGI.escape(payee_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -85,33 +84,33 @@ module YNAB
       return data, status_code, headers
     end
 
-    # List payees
+    # Get all payees
     # Returns all payees
-    # @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 [PayeesResponse]
-    def get_payees(budget_id, opts = {})
-      data, _status_code, _headers = get_payees_with_http_info(budget_id, opts)
+    def get_payees(plan_id, opts = {})
+      data, _status_code, _headers = get_payees_with_http_info(plan_id, opts)
       data
     end
 
-    # List payees
+    # Get all payees
     # Returns all payees
-    # @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<(PayeesResponse, Integer, Hash)>] PayeesResponse data, response status code and response headers
-    def get_payees_with_http_info(budget_id, opts = {})
+    def get_payees_with_http_info(plan_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PayeesApi.get_payees ...'
       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 PayeesApi.get_payees"
+      # 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 PayeesApi.get_payees"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}/payees'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s))
+      local_var_path = '/budgets/{plan_id}/payees'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -153,30 +152,30 @@ module YNAB
 
     # Update a payee
     # Update a payee
-    # @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 payee_id [String] The id of the payee
     # @param data [PatchPayeeWrapper] The payee to update
     # @param [Hash] opts the optional parameters
     # @return [SavePayeeResponse]
-    def update_payee(budget_id, payee_id, data, opts = {})
-      data, _status_code, _headers = update_payee_with_http_info(budget_id, payee_id, data, opts)
+    def update_payee(plan_id, payee_id, data, opts = {})
+      data, _status_code, _headers = update_payee_with_http_info(plan_id, payee_id, data, opts)
       data
     end
 
     # Update a payee
     # Update a payee
-    # @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 payee_id [String] The id of the payee
     # @param data [PatchPayeeWrapper] The payee to update
     # @param [Hash] opts the optional parameters
     # @return [Array<(SavePayeeResponse, Integer, Hash)>] SavePayeeResponse data, response status code and response headers
-    def update_payee_with_http_info(budget_id, payee_id, data, opts = {})
+    def update_payee_with_http_info(plan_id, payee_id, data, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PayeesApi.update_payee ...'
       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 PayeesApi.update_payee"
+      # 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 PayeesApi.update_payee"
       end
       # verify the required parameter 'payee_id' is set
       if @api_client.config.client_side_validation && payee_id.nil?
@@ -187,7 +186,7 @@ module YNAB
         fail ArgumentError, "Missing the required parameter 'data' when calling PayeesApi.update_payee"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}/payees/{payee_id}'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s)).sub('{' + 'payee_id' + '}', CGI.escape(payee_id.to_s))
+      local_var_path = '/budgets/{plan_id}/payees/{payee_id}'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s)).sub('{' + 'payee_id' + '}', CGI.escape(payee_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}

data/lib/ynab/api/{budgets_api.rb → plans_api.rb}

@@ -4,45 +4,44 @@
 #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'
 
 module YNAB
-  class BudgetsApi
+  class PlansApi
     attr_accessor :api_client
 
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Single budget
-    # Returns a single budget with all related entities.  This resource is effectively a full budget export.
-    # @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).
+    # Get a plan
+    # Returns a single plan with all related entities.  This resource is effectively a full plan export.
+    # @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 [Hash] opts the optional parameters
     # @option opts [Integer] :last_knowledge_of_server The starting server knowledge.  If provided, only entities that have changed since `last_knowledge_of_server` will be included.
-    # @return [BudgetDetailResponse]
-    def get_budget_by_id(budget_id, opts = {})
-      data, _status_code, _headers = get_budget_by_id_with_http_info(budget_id, opts)
+    # @return [PlanDetailResponse]
+    def get_plan_by_id(plan_id, opts = {})
+      data, _status_code, _headers = get_plan_by_id_with_http_info(plan_id, opts)
       data
     end
 
-    # Single budget
-    # Returns a single budget with all related entities.  This resource is effectively a full budget export.
-    # @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).
+    # Get a plan
+    # Returns a single plan with all related entities.  This resource is effectively a full plan export.
+    # @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 [Hash] opts the optional parameters
     # @option opts [Integer] :last_knowledge_of_server The starting server knowledge.  If provided, only entities that have changed since `last_knowledge_of_server` will be included.
-    # @return [Array<(BudgetDetailResponse, Integer, Hash)>] BudgetDetailResponse data, response status code and response headers
-    def get_budget_by_id_with_http_info(budget_id, opts = {})
+    # @return [Array<(PlanDetailResponse, Integer, Hash)>] PlanDetailResponse data, response status code and response headers
+    def get_plan_by_id_with_http_info(plan_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: BudgetsApi.get_budget_by_id ...'
+        @api_client.config.logger.debug 'Calling API: PlansApi.get_plan_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 BudgetsApi.get_budget_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 PlansApi.get_plan_by_id"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s))
+      local_var_path = '/budgets/{plan_id}'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -60,13 +59,13 @@ module YNAB
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'BudgetDetailResponse'
+      return_type = opts[:debug_return_type] || 'PlanDetailResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['bearer']
 
       new_options = opts.merge(
-        :operation => :"BudgetsApi.get_budget_by_id",
+        :operation => :"PlansApi.get_plan_by_id",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -77,36 +76,36 @@ module YNAB
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: BudgetsApi#get_budget_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: PlansApi#get_plan_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Budget Settings
-    # Returns settings for a budget
-    # @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).
+    # Get plan settings
+    # Returns settings for a plan
+    # @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
-    # @return [BudgetSettingsResponse]
-    def get_budget_settings_by_id(budget_id, opts = {})
-      data, _status_code, _headers = get_budget_settings_by_id_with_http_info(budget_id, opts)
+    # @return [PlanSettingsResponse]
+    def get_plan_settings_by_id(plan_id, opts = {})
+      data, _status_code, _headers = get_plan_settings_by_id_with_http_info(plan_id, opts)
       data
     end
 
-    # Budget Settings
-    # Returns settings for a budget
-    # @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).
+    # Get plan settings
+    # Returns settings for a plan
+    # @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
-    # @return [Array<(BudgetSettingsResponse, Integer, Hash)>] BudgetSettingsResponse data, response status code and response headers
-    def get_budget_settings_by_id_with_http_info(budget_id, opts = {})
+    # @return [Array<(PlanSettingsResponse, Integer, Hash)>] PlanSettingsResponse data, response status code and response headers
+    def get_plan_settings_by_id_with_http_info(plan_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: BudgetsApi.get_budget_settings_by_id ...'
+        @api_client.config.logger.debug 'Calling API: PlansApi.get_plan_settings_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 BudgetsApi.get_budget_settings_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 PlansApi.get_plan_settings_by_id"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}/settings'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s))
+      local_var_path = '/budgets/{plan_id}/settings'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -123,13 +122,13 @@ module YNAB
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'BudgetSettingsResponse'
+      return_type = opts[:debug_return_type] || 'PlanSettingsResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['bearer']
 
       new_options = opts.merge(
-        :operation => :"BudgetsApi.get_budget_settings_by_id",
+        :operation => :"PlansApi.get_plan_settings_by_id",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -140,29 +139,29 @@ module YNAB
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: BudgetsApi#get_budget_settings_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: PlansApi#get_plan_settings_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # List budgets
-    # Returns budgets list with summary information
+    # Get all plans
+    # Returns plans list with summary information
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :include_accounts Whether to include the list of budget accounts
-    # @return [BudgetSummaryResponse]
-    def get_budgets(opts = {})
-      data, _status_code, _headers = get_budgets_with_http_info(opts)
+    # @option opts [Boolean] :include_accounts Whether to include the list of plan accounts
+    # @return [PlanSummaryResponse]
+    def get_plans(opts = {})
+      data, _status_code, _headers = get_plans_with_http_info(opts)
       data
     end
 
-    # List budgets
-    # Returns budgets list with summary information
+    # Get all plans
+    # Returns plans list with summary information
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :include_accounts Whether to include the list of budget accounts
-    # @return [Array<(BudgetSummaryResponse, Integer, Hash)>] BudgetSummaryResponse data, response status code and response headers
-    def get_budgets_with_http_info(opts = {})
+    # @option opts [Boolean] :include_accounts Whether to include the list of plan accounts
+    # @return [Array<(PlanSummaryResponse, Integer, Hash)>] PlanSummaryResponse data, response status code and response headers
+    def get_plans_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: BudgetsApi.get_budgets ...'
+        @api_client.config.logger.debug 'Calling API: PlansApi.get_plans ...'
       end
       # resource path
       local_var_path = '/budgets'
@@ -183,13 +182,13 @@ module YNAB
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'BudgetSummaryResponse'
+      return_type = opts[:debug_return_type] || 'PlanSummaryResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['bearer']
 
       new_options = opts.merge(
-        :operation => :"BudgetsApi.get_budgets",
+        :operation => :"PlansApi.get_plans",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -200,7 +199,7 @@ module YNAB
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: BudgetsApi#get_budgets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: PlansApi#get_plans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end