ynab 0.1.0

data/docs/TransactionsResponse.md

@@ -0,0 +1,8 @@
+# YnabApi::TransactionsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**TransactionsWrapper**](TransactionsWrapper.md) |  | 
+
+

data/docs/TransactionsWrapper.md

@@ -0,0 +1,8 @@
+# YnabApi::TransactionsWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transactions** | [**Array<TransactionDetail>**](TransactionDetail.md) |  | 
+
+

data/examples/budget-list.rb

@@ -0,0 +1,25 @@
+$:.unshift('../lib')
+require 'ynab'
+
+def print_budget_list
+  access_token = 'bf0cbb14b4330-not-real-3de12e66a389eaafe2'
+  ynab = YnabApi::Client.new(access_token)
+
+  puts "Fetching budgets..."
+  begin
+    budget_response = ynab.budgets.get_budgets
+    budgets = budget_response.data.budgets
+
+    puts "==========="
+    puts "BUDGET LIST"
+    puts "==========="
+
+    budgets.each do |budget|
+      puts "[id: #{budget.id}, name: #{budget.name}]"
+    end
+  rescue => e
+    puts "ERROR: #{e}"
+  end
+end
+
+print_budget_list()

data/examples/budget-month.rb

@@ -0,0 +1,36 @@
+$:.unshift('../lib')
+require 'ynab'
+require 'date'
+
+def print_budget_month
+  access_token = 'bf0cbb14b4330-not-real-3de12e66a389eaafe2'
+  ynab = YnabApi::Client.new(access_token)
+
+  budget_id = "f968197b-2863-not-real-c2406dbe7f0d"
+  first_day_of_month_iso = Date.new(Date.today.year, Date.today.month, 1).iso8601
+
+  begin
+    puts "Fetching month..."
+    current_date = Date.today
+    first_day_of_month = Date.new(current_date.year, current_date.month, 1)
+    month_response = ynab.months.get_budget_month(budget_id, first_day_of_month_iso)
+    budget_month = month_response.data.month
+
+    puts "============"
+    puts "BUDGET MONTH"
+    puts "============"
+    puts "         Month: #{budget_month.month}"
+    puts "          Note: #{budget_month.note}"
+    puts "To Be Budgeted: #{budget_month.to_be_budgeted}"
+    puts "  Age of Money: #{budget_month.age_of_money}"
+    puts "    Categories: "
+
+    budget_month.categories.each do |category|
+      puts "                #{category.name} - $#{category.balance}"
+    end
+  rescue => e
+    puts "ERROR: #{e}"
+  end
+end
+
+print_budget_month()

data/examples/category-balance.rb

@@ -0,0 +1,27 @@
+$:.unshift('../lib')
+require 'ynab'
+
+def print_category_info
+  access_token = 'bf0cbb14b4330-not-real-3de12e66a389eaafe2'
+  ynab = YnabApi::Client.new(access_token)
+
+  budget_id = "f968197b-2863-not-real-c2406dbe7f0d"
+  category_id = "a191ac84-de09-not-real-6c5ed8cfdabe"
+
+  begin
+    puts "Fetching category..."
+    category_response = ynab.categories.get_category_by_id(budget_id, category_id)
+    category = category_response.data.category
+
+    puts "==========="
+    puts "CATEGORY"
+    puts "==========="
+    puts "      Name: #{category.name}"
+    puts "  Budgeted: #{category.budgeted}"
+    puts "   Balance: #{category.balance}"
+  rescue => e
+    puts "ERROR: #{e}"
+  end
+end
+
+print_category_info()

data/lib/ynab.rb

@@ -0,0 +1,136 @@
+=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.0-SNAPSHOT
+
+=end
+
+# Common files
+require 'ynab/api_client'
+require 'ynab/api_error'
+require 'ynab/version'
+require 'ynab/configuration'
+
+# Models
+require 'ynab/models/account'
+require 'ynab/models/account_response'
+require 'ynab/models/account_wrapper'
+require 'ynab/models/accounts_response'
+require 'ynab/models/accounts_wrapper'
+require 'ynab/models/budget_detail_response'
+require 'ynab/models/budget_detail_wrapper'
+require 'ynab/models/budget_summary'
+require 'ynab/models/budget_summary_response'
+require 'ynab/models/budget_summary_wrapper'
+require 'ynab/models/categories_response'
+require 'ynab/models/category'
+require 'ynab/models/category_group'
+require 'ynab/models/category_groups_wrapper'
+require 'ynab/models/category_response'
+require 'ynab/models/category_wrapper'
+require 'ynab/models/currency_format'
+require 'ynab/models/date_format'
+require 'ynab/models/error_detail'
+require 'ynab/models/error_response'
+require 'ynab/models/month_detail_response'
+require 'ynab/models/month_detail_wrapper'
+require 'ynab/models/month_summaries_response'
+require 'ynab/models/month_summaries_wrapper'
+require 'ynab/models/month_summary'
+require 'ynab/models/payee'
+require 'ynab/models/payee_location'
+require 'ynab/models/payee_location_response'
+require 'ynab/models/payee_location_wrapper'
+require 'ynab/models/payee_locations_response'
+require 'ynab/models/payee_locations_wrapper'
+require 'ynab/models/payee_response'
+require 'ynab/models/payee_wrapper'
+require 'ynab/models/payees_response'
+require 'ynab/models/payees_wrapper'
+require 'ynab/models/scheduled_sub_transaction'
+require 'ynab/models/scheduled_transaction_response'
+require 'ynab/models/scheduled_transaction_wrapper'
+require 'ynab/models/scheduled_transactions_response'
+require 'ynab/models/scheduled_transactions_wrapper'
+require 'ynab/models/scheduled_transaction_summary'
+require 'ynab/models/sub_transaction'
+require 'ynab/models/transaction_response'
+require 'ynab/models/transaction_wrapper'
+require 'ynab/models/transactions_response'
+require 'ynab/models/transactions_wrapper'
+require 'ynab/models/transaction_summary'
+require 'ynab/models/budget_detail'
+require 'ynab/models/category_group_with_categories'
+require 'ynab/models/month_detail'
+require 'ynab/models/scheduled_transaction_detail'
+require 'ynab/models/transaction_detail'
+require 'ynab/models/transaction_detail'
+require 'ynab/models/bulk_id_wrapper'
+require 'ynab/models/bulk_ids'
+require 'ynab/models/bulk_response'
+
+# APIs
+require 'ynab/api/accounts_api'
+require 'ynab/api/budgets_api'
+require 'ynab/api/categories_api'
+require 'ynab/api/months_api'
+require 'ynab/api/payee_locations_api'
+require 'ynab/api/payees_api'
+require 'ynab/api/scheduled_transactions_api'
+require 'ynab/api/transactions_api'
+
+module YnabApi
+  class Client
+    def initialize(access_token, host = 'api.youneedabudget.com', useHttps = true)
+      config = Configuration.default
+      config.api_key['Authorization'] = access_token
+      config.api_key_prefix['Authorization'] = 'Bearer'
+      config.scheme = useHttps ? 'https' : 'http'
+      config.host = host
+      config.base_path = '/v1'
+
+      @client = ApiClient.new(config)
+    end
+
+    def budgets
+      BudgetsApi.new(@client)
+    end
+
+    def accounts
+      AccountsApi.new(@client)
+    end
+
+    def categories
+      CategoriesApi.new(@client)
+    end
+
+    def months
+      MonthsApi.new(@client)
+    end
+
+    def payees
+      PayeesApi.new(@client)
+    end
+
+    def payee_locations
+      PayeeLocationsApi.new(@client)
+    end
+
+    def transactions
+      TransactionsApi.new(@client)
+    end
+
+    def scheduled_transactions
+      ScheduledTransactionsApi.new(@client)
+    end
+
+    def last_request
+      @client.last_request
+    end
+  end
+end

data/lib/ynab/api/accounts_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 AccountsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Single account
+    # Returns a single account
+    # @param budget_id The ID of the Budget.
+    # @param account_id 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)
+      return data
+    end
+
+    # Single account
+    # Returns a single account
+    # @param budget_id The ID of the Budget.
+    # @param account_id The ID of the Account.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountResponse, Fixnum, Hash)>] AccountResponse data, response status code and response headers
+    def get_account_by_id_with_http_info(budget_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"
+      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' + '}', budget_id.to_s).sub('{' + 'account_id' + '}', account_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 => 'AccountResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountsApi#get_account_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Account list
+    # Returns all accounts
+    # @param budget_id The ID of the Budget.
+    # @param [Hash] opts the optional parameters
+    # @return [AccountsResponse]
+    def get_accounts(budget_id, opts = {})
+      data, _status_code, _headers = get_accounts_with_http_info(budget_id, opts)
+      return data
+    end
+
+    # Account list
+    # Returns all accounts
+    # @param budget_id The ID of the Budget.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountsResponse, Fixnum, Hash)>] AccountsResponse data, response status code and response headers
+    def get_accounts_with_http_info(budget_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"
+      end
+      # resource path
+      local_var_path = "/budgets/{budget_id}/accounts".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 => 'AccountsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountsApi#get_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/ynab/api/budgets_api.rb

@@ -0,0 +1,126 @@
+=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 BudgetsApi
+    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 The ID of the Budget.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :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 data
+    end
+
+    # Single budget
+    # Returns a single budget with all related entities.  This resource is effectively a full budget export.
+    # @param budget_id The ID of the Budget.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :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, Fixnum, Hash)>] BudgetDetailResponse data, response status code and response headers
+    def get_budget_by_id_with_http_info(budget_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: BudgetsApi.get_budget_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"
+      end
+      # resource path
+      local_var_path = "/budgets/{budget_id}".sub('{' + 'budget_id' + '}', budget_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'last_knowledge_of_server'] = opts[:'last_knowledge_of_server'] if !opts[:'last_knowledge_of_server'].nil?
+
+      # 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 => 'BudgetDetailResponse')
+      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}"
+      end
+      return data, status_code, headers
+    end
+
+    # List budgets
+    # Returns budgets list with summary information.
+    # @param [Hash] opts the optional parameters
+    # @return [BudgetSummaryResponse]
+    def get_budgets(opts = {})
+      data, _status_code, _headers = get_budgets_with_http_info(opts)
+      return data
+    end
+
+    # List budgets
+    # Returns budgets list with summary information.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BudgetSummaryResponse, Fixnum, Hash)>] BudgetSummaryResponse data, response status code and response headers
+    def get_budgets_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: BudgetsApi.get_budgets ..."
+      end
+      # resource path
+      local_var_path = "/budgets"
+
+      # 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 => 'BudgetSummaryResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BudgetsApi#get_budgets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end