ynab 0.1.0

data/lib/ynab/api/categories_api.rb

@@ -0,0 +1,135 @@
+=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.youneedabudget.com
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require "uri"
+
+module YnabApi
+  class CategoriesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # List categories
+    # Returns all categories grouped by category group.
+    # @param budget_id The ID of the Budget.
+    # @param [Hash] opts the optional parameters
+    # @return [CategoriesResponse]
+    def get_categories(budget_id, opts = {})
+      data, _status_code, _headers = get_categories_with_http_info(budget_id, opts)
+      return data
+    end
+
+    # List categories
+    # Returns all categories grouped by category group.
+    # @param budget_id The ID of the Budget.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CategoriesResponse, Fixnum, Hash)>] CategoriesResponse data, response status code and response headers
+    def get_categories_with_http_info(budget_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: CategoriesApi.get_categories ..."
+      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 CategoriesApi.get_categories"
+      end
+      # resource path
+      local_var_path = "/budgets/{budget_id}/categories".sub('{' + 'budget_id' + '}', budget_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['bearer']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CategoriesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CategoriesApi#get_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Single category
+    # Returns a single category
+    # @param budget_id The ID of the Budget.
+    # @param category_id The ID of the Category.
+    # @param [Hash] opts the optional parameters
+    # @return [CategoryResponse]
+    def get_category_by_id(budget_id, category_id, opts = {})
+      data, _status_code, _headers = get_category_by_id_with_http_info(budget_id, category_id, opts)
+      return data
+    end
+
+    # Single category
+    # Returns a single category
+    # @param budget_id The ID of the Budget.
+    # @param category_id The ID of the Category.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CategoryResponse, Fixnum, Hash)>] CategoryResponse data, response status code and response headers
+    def get_category_by_id_with_http_info(budget_id, category_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: CategoriesApi.get_category_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 CategoriesApi.get_category_by_id"
+      end
+      # verify the required parameter 'category_id' is set
+      if @api_client.config.client_side_validation && category_id.nil?
+        fail ArgumentError, "Missing the required parameter 'category_id' when calling CategoriesApi.get_category_by_id"
+      end
+      # resource path
+      local_var_path = "/budgets/{budget_id}/categories/{category_id}".sub('{' + 'budget_id' + '}', budget_id.to_s).sub('{' + 'category_id' + '}', category_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['bearer']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CategoryResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CategoriesApi#get_category_by_id\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

@@ -0,0 +1,135 @@
+=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.youneedabudget.com
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require "uri"
+
+module YnabApi
+  class MonthsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Single budget month
+    # Returns a single budget month
+    # @param budget_id The ID of the Budget.
+    # @param month The Budget Month.  \"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)
+      return data
+    end
+
+    # Single budget month
+    # Returns a single budget month
+    # @param budget_id The ID of the Budget.
+    # @param month The Budget Month.  \"current\" can also be used to specify the current calendar month (UTC).
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MonthDetailResponse, Fixnum, Hash)>] MonthDetailResponse data, response status code and response headers
+    def get_budget_month_with_http_info(budget_id, month, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: MonthsApi.get_budget_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"
+      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"
+      end
+      # resource path
+      local_var_path = "/budgets/{budget_id}/months/{month}".sub('{' + 'budget_id' + '}', budget_id.to_s).sub('{' + 'month' + '}', month.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['bearer']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'MonthDetailResponse')
+      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}"
+      end
+      return data, status_code, headers
+    end
+
+    # List budget months
+    # Returns all budget months
+    # @param budget_id The ID of the Budget.
+    # @param [Hash] opts the optional parameters
+    # @return [MonthSummariesResponse]
+    def get_budget_months(budget_id, opts = {})
+      data, _status_code, _headers = get_budget_months_with_http_info(budget_id, opts)
+      return data
+    end
+
+    # List budget months
+    # Returns all budget months
+    # @param budget_id The ID of the Budget.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MonthSummariesResponse, Fixnum, Hash)>] MonthSummariesResponse data, response status code and response headers
+    def get_budget_months_with_http_info(budget_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: MonthsApi.get_budget_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"
+      end
+      # resource path
+      local_var_path = "/budgets/{budget_id}/months".sub('{' + 'budget_id' + '}', budget_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['bearer']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'MonthSummariesResponse')
+      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}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/ynab/api/payee_locations_api.rb

@@ -0,0 +1,194 @@
+=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.youneedabudget.com
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require "uri"
+
+module YnabApi
+  class PayeeLocationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Single payee location
+    # Returns a single payee location
+    # @param budget_id The ID of the Budget.
+    # @param payee_location_id 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)
+      return data
+    end
+
+    # Single payee location
+    # Returns a single payee location
+    # @param budget_id The ID of the Budget.
+    # @param payee_location_id ID of payee location
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PayeeLocationResponse, Fixnum, Hash)>] PayeeLocationResponse data, response status code and response headers
+    def get_payee_location_by_id_with_http_info(budget_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"
+      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' + '}', budget_id.to_s).sub('{' + 'payee_location_id' + '}', payee_location_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['bearer']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'PayeeLocationResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayeeLocationsApi#get_payee_location_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List payee locations
+    # Returns all payee locations
+    # @param budget_id The ID of the Budget.
+    # @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)
+      return data
+    end
+
+    # List payee locations
+    # Returns all payee locations
+    # @param budget_id The ID of the Budget.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PayeeLocationsResponse, Fixnum, Hash)>] PayeeLocationsResponse data, response status code and response headers
+    def get_payee_locations_with_http_info(budget_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"
+      end
+      # resource path
+      local_var_path = "/budgets/{budget_id}/payee_locations".sub('{' + 'budget_id' + '}', budget_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['bearer']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'PayeeLocationsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayeeLocationsApi#get_payee_locations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List locations for a payee
+    # Returns all payee locations for the specified payee
+    # @param budget_id The ID of the Budget.
+    # @param payee_id 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)
+      return data
+    end
+
+    # List locations for a payee
+    # Returns all payee locations for the specified payee
+    # @param budget_id The ID of the Budget.
+    # @param payee_id ID of payee
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PayeeLocationsResponse, Fixnum, Hash)>] PayeeLocationsResponse data, response status code and response headers
+    def get_payee_locations_by_payee_with_http_info(budget_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"
+      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' + '}', budget_id.to_s).sub('{' + 'payee_id' + '}', payee_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['bearer']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'PayeeLocationsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayeeLocationsApi#get_payee_locations_by_payee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end