ynab 3.8.0 → 4.9.0

data/lib/ynab/api/money_movements_api.rb

@@ -0,0 +1,282 @@
+=begin
+#YNAB API Endpoints
+
+#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 MoneyMovementsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get all money movement groups
+    # Returns all money movement groups
+    # @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
+    # @return [MoneyMovementGroupsResponse]
+    def get_money_movement_groups(plan_id, opts = {})
+      data, _status_code, _headers = get_money_movement_groups_with_http_info(plan_id, opts)
+      data
+    end
+
+    # Get all money movement groups
+    # Returns all money movement groups
+    # @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
+    # @return [Array<(MoneyMovementGroupsResponse, Integer, Hash)>] MoneyMovementGroupsResponse data, response status code and response headers
+    def get_money_movement_groups_with_http_info(plan_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MoneyMovementsApi.get_money_movement_groups ...'
+      end
+      # 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 MoneyMovementsApi.get_money_movement_groups"
+      end
+      # resource path
+      local_var_path = '/budgets/{plan_id}/money_movement_groups'.sub('{' + 'plan_id' + '}', CGI.escape(plan_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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MoneyMovementGroupsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"MoneyMovementsApi.get_money_movement_groups",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MoneyMovementsApi#get_money_movement_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get money movement groups for a plan month
+    # Returns all money movement groups for a specific month
+    # @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 month [Date] The plan month in ISO format (e.g. 2016-12-01) (\&quot;current\&quot; can also be used to specify the current calendar month (UTC))
+    # @param [Hash] opts the optional parameters
+    # @return [MoneyMovementGroupsResponse]
+    def get_money_movement_groups_by_month(plan_id, month, opts = {})
+      data, _status_code, _headers = get_money_movement_groups_by_month_with_http_info(plan_id, month, opts)
+      data
+    end
+
+    # Get money movement groups for a plan month
+    # Returns all money movement groups for a specific month
+    # @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 month [Date] The plan month in ISO format (e.g. 2016-12-01) (\&quot;current\&quot; can also be used to specify the current calendar month (UTC))
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MoneyMovementGroupsResponse, Integer, Hash)>] MoneyMovementGroupsResponse data, response status code and response headers
+    def get_money_movement_groups_by_month_with_http_info(plan_id, month, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MoneyMovementsApi.get_money_movement_groups_by_month ...'
+      end
+      # 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 MoneyMovementsApi.get_money_movement_groups_by_month"
+      end
+      # verify the required parameter 'month' is set
+      if @api_client.config.client_side_validation && month.nil?
+        fail ArgumentError, "Missing the required parameter 'month' when calling MoneyMovementsApi.get_money_movement_groups_by_month"
+      end
+      # resource path
+      local_var_path = '/budgets/{plan_id}/months/{month}/money_movement_groups'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s)).sub('{' + 'month' + '}', CGI.escape(month.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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MoneyMovementGroupsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"MoneyMovementsApi.get_money_movement_groups_by_month",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MoneyMovementsApi#get_money_movement_groups_by_month\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get all money movements
+    # Returns all money movements
+    # @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 [MoneyMovementsResponse]
+    def get_money_movements(plan_id, opts = {})
+      data, _status_code, _headers = get_money_movements_with_http_info(plan_id, opts)
+      data
+    end
+
+    # Get all money movements
+    # Returns all money movements
+    # @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<(MoneyMovementsResponse, Integer, Hash)>] MoneyMovementsResponse data, response status code and response headers
+    def get_money_movements_with_http_info(plan_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MoneyMovementsApi.get_money_movements ...'
+      end
+      # 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 MoneyMovementsApi.get_money_movements"
+      end
+      # resource path
+      local_var_path = '/budgets/{plan_id}/money_movements'.sub('{' + 'plan_id' + '}', CGI.escape(plan_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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MoneyMovementsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"MoneyMovementsApi.get_money_movements",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MoneyMovementsApi#get_money_movements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get money movements for a plan month
+    # Returns all money movements for a specific month
+    # @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 month [Date] The plan month in ISO format (e.g. 2016-12-01) (\&quot;current\&quot; can also be used to specify the current calendar month (UTC))
+    # @param [Hash] opts the optional parameters
+    # @return [MoneyMovementsResponse]
+    def get_money_movements_by_month(plan_id, month, opts = {})
+      data, _status_code, _headers = get_money_movements_by_month_with_http_info(plan_id, month, opts)
+      data
+    end
+
+    # Get money movements for a plan month
+    # Returns all money movements for a specific month
+    # @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 month [Date] The plan month in ISO format (e.g. 2016-12-01) (\&quot;current\&quot; can also be used to specify the current calendar month (UTC))
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MoneyMovementsResponse, Integer, Hash)>] MoneyMovementsResponse data, response status code and response headers
+    def get_money_movements_by_month_with_http_info(plan_id, month, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MoneyMovementsApi.get_money_movements_by_month ...'
+      end
+      # 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 MoneyMovementsApi.get_money_movements_by_month"
+      end
+      # verify the required parameter 'month' is set
+      if @api_client.config.client_side_validation && month.nil?
+        fail ArgumentError, "Missing the required parameter 'month' when calling MoneyMovementsApi.get_money_movements_by_month"
+      end
+      # resource path
+      local_var_path = '/budgets/{plan_id}/months/{month}/money_movements'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s)).sub('{' + 'month' + '}', CGI.escape(month.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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MoneyMovementsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"MoneyMovementsApi.get_money_movements_by_month",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MoneyMovementsApi#get_money_movements_by_month\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/ynab/api/months_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 budget month
-    # Returns a single budget month
-    # @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 month [Date] The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
+    # Get a plan month
+    # Returns a single plan month
+    # @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 month [Date] The plan month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
     # @param [Hash] opts the optional parameters
     # @return [MonthDetailResponse]
-    def get_budget_month(budget_id, month, opts = {})
-      data, _status_code, _headers = get_budget_month_with_http_info(budget_id, month, opts)
+    def get_plan_month(plan_id, month, opts = {})
+      data, _status_code, _headers = get_plan_month_with_http_info(plan_id, month, opts)
       data
     end
 
-    # Single budget month
-    # Returns a single budget month
-    # @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 month [Date] The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
+    # Get a plan month
+    # Returns a single plan month
+    # @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 month [Date] The plan month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
     # @param [Hash] opts the optional parameters
     # @return [Array<(MonthDetailResponse, Integer, Hash)>] MonthDetailResponse data, response status code and response headers
-    def get_budget_month_with_http_info(budget_id, month, opts = {})
+    def get_plan_month_with_http_info(plan_id, month, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: MonthsApi.get_budget_month ...'
+        @api_client.config.logger.debug 'Calling API: MonthsApi.get_plan_month ...'
       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 MonthsApi.get_budget_month"
+      # 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 MonthsApi.get_plan_month"
       end
       # verify the required parameter 'month' is set
       if @api_client.config.client_side_validation && month.nil?
-        fail ArgumentError, "Missing the required parameter 'month' when calling MonthsApi.get_budget_month"
+        fail ArgumentError, "Missing the required parameter 'month' when calling MonthsApi.get_plan_month"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}/months/{month}'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s)).sub('{' + 'month' + '}', CGI.escape(month.to_s))
+      local_var_path = '/budgets/{plan_id}/months/{month}'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s)).sub('{' + 'month' + '}', CGI.escape(month.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -69,7 +68,7 @@ module YNAB
       auth_names = opts[:debug_auth_names] || ['bearer']
 
       new_options = opts.merge(
-        :operation => :"MonthsApi.get_budget_month",
+        :operation => :"MonthsApi.get_plan_month",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -80,38 +79,38 @@ 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: MonthsApi#get_budget_month\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: MonthsApi#get_plan_month\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # List budget months
-    # Returns all budget months
-    # @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 all plan months
+    # Returns all plan months
+    # @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 [MonthSummariesResponse]
-    def get_budget_months(budget_id, opts = {})
-      data, _status_code, _headers = get_budget_months_with_http_info(budget_id, opts)
+    def get_plan_months(plan_id, opts = {})
+      data, _status_code, _headers = get_plan_months_with_http_info(plan_id, opts)
       data
     end
 
-    # List budget months
-    # Returns all budget months
-    # @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 all plan months
+    # Returns all plan months
+    # @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<(MonthSummariesResponse, Integer, Hash)>] MonthSummariesResponse data, response status code and response headers
-    def get_budget_months_with_http_info(budget_id, opts = {})
+    def get_plan_months_with_http_info(plan_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: MonthsApi.get_budget_months ...'
+        @api_client.config.logger.debug 'Calling API: MonthsApi.get_plan_months ...'
       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 MonthsApi.get_budget_months"
+      # 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 MonthsApi.get_plan_months"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}/months'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s))
+      local_var_path = '/budgets/{plan_id}/months'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -135,7 +134,7 @@ module YNAB
       auth_names = opts[:debug_auth_names] || ['bearer']
 
       new_options = opts.merge(
-        :operation => :"MonthsApi.get_budget_months",
+        :operation => :"MonthsApi.get_plan_months",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -146,7 +145,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: MonthsApi#get_budget_months\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: MonthsApi#get_plan_months\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end

data/lib/ynab/api/payee_locations_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 location
+    # Get a payee location
     # Returns a single payee location
-    # @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_location_id [String] id of payee location
     # @param [Hash] opts the optional parameters
     # @return [PayeeLocationResponse]
-    def get_payee_location_by_id(budget_id, payee_location_id, opts = {})
-      data, _status_code, _headers = get_payee_location_by_id_with_http_info(budget_id, payee_location_id, opts)
+    def get_payee_location_by_id(plan_id, payee_location_id, opts = {})
+      data, _status_code, _headers = get_payee_location_by_id_with_http_info(plan_id, payee_location_id, opts)
       data
     end
 
-    # Single payee location
+    # Get a payee location
     # Returns a single payee location
-    # @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_location_id [String] id of payee location
     # @param [Hash] opts the optional parameters
     # @return [Array<(PayeeLocationResponse, Integer, Hash)>] PayeeLocationResponse data, response status code and response headers
-    def get_payee_location_by_id_with_http_info(budget_id, payee_location_id, opts = {})
+    def get_payee_location_by_id_with_http_info(plan_id, payee_location_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PayeeLocationsApi.get_payee_location_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 PayeeLocationsApi.get_payee_location_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 PayeeLocationsApi.get_payee_location_by_id"
       end
       # verify the required parameter 'payee_location_id' is set
       if @api_client.config.client_side_validation && payee_location_id.nil?
         fail ArgumentError, "Missing the required parameter 'payee_location_id' when calling PayeeLocationsApi.get_payee_location_by_id"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}/payee_locations/{payee_location_id}'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s)).sub('{' + 'payee_location_id' + '}', CGI.escape(payee_location_id.to_s))
+      local_var_path = '/budgets/{plan_id}/payee_locations/{payee_location_id}'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s)).sub('{' + 'payee_location_id' + '}', CGI.escape(payee_location_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -85,31 +84,31 @@ module YNAB
       return data, status_code, headers
     end
 
-    # List payee locations
+    # Get all payee locations
     # Returns all payee locations
-    # @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
     # @return [PayeeLocationsResponse]
-    def get_payee_locations(budget_id, opts = {})
-      data, _status_code, _headers = get_payee_locations_with_http_info(budget_id, opts)
+    def get_payee_locations(plan_id, opts = {})
+      data, _status_code, _headers = get_payee_locations_with_http_info(plan_id, opts)
       data
     end
 
-    # List payee locations
+    # Get all payee locations
     # Returns all payee locations
-    # @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
     # @return [Array<(PayeeLocationsResponse, Integer, Hash)>] PayeeLocationsResponse data, response status code and response headers
-    def get_payee_locations_with_http_info(budget_id, opts = {})
+    def get_payee_locations_with_http_info(plan_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PayeeLocationsApi.get_payee_locations ...'
       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 PayeeLocationsApi.get_payee_locations"
+      # 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 PayeeLocationsApi.get_payee_locations"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}/payee_locations'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s))
+      local_var_path = '/budgets/{plan_id}/payee_locations'.sub('{' + 'plan_id' + '}', CGI.escape(plan_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -148,37 +147,37 @@ module YNAB
       return data, status_code, headers
     end
 
-    # List locations for a payee
+    # Get all locations for a payee
     # Returns all payee locations for a specified 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] id of payee
     # @param [Hash] opts the optional parameters
     # @return [PayeeLocationsResponse]
-    def get_payee_locations_by_payee(budget_id, payee_id, opts = {})
-      data, _status_code, _headers = get_payee_locations_by_payee_with_http_info(budget_id, payee_id, opts)
+    def get_payee_locations_by_payee(plan_id, payee_id, opts = {})
+      data, _status_code, _headers = get_payee_locations_by_payee_with_http_info(plan_id, payee_id, opts)
       data
     end
 
-    # List locations for a payee
+    # Get all locations for a payee
     # Returns all payee locations for a specified 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] id of payee
     # @param [Hash] opts the optional parameters
     # @return [Array<(PayeeLocationsResponse, Integer, Hash)>] PayeeLocationsResponse data, response status code and response headers
-    def get_payee_locations_by_payee_with_http_info(budget_id, payee_id, opts = {})
+    def get_payee_locations_by_payee_with_http_info(plan_id, payee_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PayeeLocationsApi.get_payee_locations_by_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 PayeeLocationsApi.get_payee_locations_by_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 PayeeLocationsApi.get_payee_locations_by_payee"
       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 PayeeLocationsApi.get_payee_locations_by_payee"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}/payees/{payee_id}/payee_locations'.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}/payee_locations'.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] || {}