ynab 1.0.0 → 1.1.0

data/docs/PayeeLocationResponse.md

@@ -1,4 +1,4 @@
-# YnabApi::PayeeLocationResponse
+# YNAB::PayeeLocationResponse
 
 ## Properties
 Name | Type | Description | Notes

data/docs/PayeeLocationWrapper.md

@@ -1,4 +1,4 @@
-# YnabApi::PayeeLocationWrapper
+# YNAB::PayeeLocationWrapper
 
 ## Properties
 Name | Type | Description | Notes

data/docs/PayeeLocationsApi.md

@@ -1,4 +1,4 @@
-# YnabApi::PayeeLocationsApi
+# YNAB::PayeeLocationsApi
 
 All URIs are relative to *https://api.youneedabudget.com/v1*
 

data/docs/PayeeLocationsResponse.md

@@ -1,4 +1,4 @@
-# YnabApi::PayeeLocationsResponse
+# YNAB::PayeeLocationsResponse
 
 ## Properties
 Name | Type | Description | Notes

data/docs/PayeeLocationsWrapper.md

@@ -1,4 +1,4 @@
-# YnabApi::PayeeLocationsWrapper
+# YNAB::PayeeLocationsWrapper
 
 ## Properties
 Name | Type | Description | Notes

data/docs/PayeeResponse.md

@@ -1,4 +1,4 @@
-# YnabApi::PayeeResponse
+# YNAB::PayeeResponse
 
 ## Properties
 Name | Type | Description | Notes

data/docs/PayeeWrapper.md

@@ -1,4 +1,4 @@
-# YnabApi::PayeeWrapper
+# YNAB::PayeeWrapper
 
 ## Properties
 Name | Type | Description | Notes

data/docs/PayeesApi.md

@@ -1,4 +1,4 @@
-# YnabApi::PayeesApi
+# YNAB::PayeesApi
 
 All URIs are relative to *https://api.youneedabudget.com/v1*
 

data/docs/PayeesResponse.md

@@ -1,4 +1,4 @@
-# YnabApi::PayeesResponse
+# YNAB::PayeesResponse
 
 ## Properties
 Name | Type | Description | Notes

data/docs/PayeesWrapper.md

@@ -1,4 +1,4 @@
-# YnabApi::PayeesWrapper
+# YNAB::PayeesWrapper
 
 ## Properties
 Name | Type | Description | Notes

data/docs/SaveTransaction.md

@@ -1,4 +1,4 @@
-# YnabApi::SaveTransaction
+# YNAB::SaveTransaction
 
 ## Properties
 Name | Type | Description | Notes
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **date** | **Date** |  | 
 **amount** | **Float** | The transaction amount in milliunits format | 
 **payee_id** | **String** | The payee for the transaction.  Transfer payees are not permitted and will be ignored if supplied. | [optional] 
-**payee_name** | **String** | The payee name.  If a payee_name value is provided and payee_id is not included or has a null value, payee_name will be used to create or use an existing payee. | [optional] 
+**payee_name** | **String** | The payee name.  If a payee_name value is provided and payee_id has a null value, the payee_name value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified) or (2) a payee with the same name or (3) creation of a new payee. | [optional] 
 **category_id** | **String** | The category for the transaction.  Split and Credit Card Payment categories are not permitted and will be ignored if supplied. | [optional] 
 **memo** | **String** |  | [optional] 
 **cleared** | **String** | The cleared status of the transaction | [optional] 

data/docs/SaveTransactionWrapper.md

@@ -1,4 +1,4 @@
-# YnabApi::SaveTransactionWrapper
+# YNAB::SaveTransactionWrapper
 
 ## Properties
 Name | Type | Description | Notes

data/docs/ScheduledSubTransaction.md

@@ -1,4 +1,4 @@
-# YnabApi::ScheduledSubTransaction
+# YNAB::ScheduledSubTransaction
 
 ## Properties
 Name | Type | Description | Notes

data/docs/ScheduledTransactionDetail.md

@@ -1,4 +1,4 @@
-# YnabApi::ScheduledTransactionDetail
+# YNAB::ScheduledTransactionDetail
 
 ## Properties
 Name | Type | Description | Notes

data/docs/ScheduledTransactionResponse.md

@@ -1,4 +1,4 @@
-# YnabApi::ScheduledTransactionResponse
+# YNAB::ScheduledTransactionResponse
 
 ## Properties
 Name | Type | Description | Notes

data/docs/ScheduledTransactionSummary.md

@@ -1,4 +1,4 @@
-# YnabApi::ScheduledTransactionSummary
+# YNAB::ScheduledTransactionSummary
 
 ## Properties
 Name | Type | Description | Notes

data/docs/ScheduledTransactionWrapper.md

@@ -1,4 +1,4 @@
-# YnabApi::ScheduledTransactionWrapper
+# YNAB::ScheduledTransactionWrapper
 
 ## Properties
 Name | Type | Description | Notes

data/docs/ScheduledTransactionsApi.md

@@ -1,4 +1,4 @@
-# YnabApi::ScheduledTransactionsApi
+# YNAB::ScheduledTransactionsApi
 
 All URIs are relative to *https://api.youneedabudget.com/v1*
 

data/docs/ScheduledTransactionsResponse.md

@@ -1,4 +1,4 @@
-# YnabApi::ScheduledTransactionsResponse
+# YNAB::ScheduledTransactionsResponse
 
 ## Properties
 Name | Type | Description | Notes

data/docs/ScheduledTransactionsWrapper.md

@@ -1,4 +1,4 @@
-# YnabApi::ScheduledTransactionsWrapper
+# YNAB::ScheduledTransactionsWrapper
 
 ## Properties
 Name | Type | Description | Notes

data/docs/SubTransaction.md

@@ -1,4 +1,4 @@
-# YnabApi::SubTransaction
+# YNAB::SubTransaction
 
 ## Properties
 Name | Type | Description | Notes

data/docs/TransactionDetail.md

@@ -1,4 +1,4 @@
-# YnabApi::TransactionDetail
+# YNAB::TransactionDetail
 
 ## Properties
 Name | Type | Description | Notes

data/docs/TransactionResponse.md

@@ -1,4 +1,4 @@
-# YnabApi::TransactionResponse
+# YNAB::TransactionResponse
 
 ## Properties
 Name | Type | Description | Notes

data/docs/TransactionSummary.md

@@ -1,4 +1,4 @@
-# YnabApi::TransactionSummary
+# YNAB::TransactionSummary
 
 ## Properties
 Name | Type | Description | Notes

data/docs/TransactionWrapper.md

@@ -1,4 +1,4 @@
-# YnabApi::TransactionWrapper
+# YNAB::TransactionWrapper
 
 ## Properties
 Name | Type | Description | Notes

data/docs/TransactionsApi.md

@@ -1,4 +1,4 @@
-# YnabApi::TransactionsApi
+# YNAB::TransactionsApi
 
 All URIs are relative to *https://api.youneedabudget.com/v1*
 
@@ -63,7 +63,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **budget_id** | [**String**](.md)| The ID of the Budget. | 
  **since_date** | **Date**| Only return transactions on or after this date. | [optional] 
- **type** | **String**| Only return transactions of a certain type (i.e. 'uncategorized', 'unapproved') | [optional] 
+ **type** | **String**| Only return transactions of a certain type ('uncategorized' and 'unapproved' are currently supported) | [optional] 
 
 ### Return type
 
@@ -83,6 +83,7 @@ Name | Type | Description  | Notes
  **budget_id** | [**String**](.md)| The ID of the Budget. | 
  **account_id** | [**String**](.md)| The ID of the Account. | 
  **since_date** | **Date**| Only return transactions on or after this date. | [optional] 
+ **type** | **String**| Only return transactions of a certain type (i.e. 'uncategorized', 'unapproved') | [optional] 
 
 ### Return type
 
@@ -102,6 +103,7 @@ Name | Type | Description  | Notes
  **budget_id** | [**String**](.md)| The ID of the Budget. | 
  **category_id** | [**String**](.md)| The ID of the Category. | 
  **since_date** | **Date**| Only return transactions on or after this date. | [optional] 
+ **type** | **String**| Only return transactions of a certain type (i.e. 'uncategorized', 'unapproved') | [optional] 
 
 ### Return type
 
@@ -139,6 +141,7 @@ Name | Type | Description  | Notes
  **budget_id** | [**String**](.md)| The ID of the Budget. | 
  **payee_id** | [**String**](.md)| The ID of the Payee. | 
  **since_date** | **Date**| Only return transactions on or after this date. | [optional] 
+ **type** | **String**| Only return transactions of a certain type (i.e. 'uncategorized', 'unapproved') | [optional] 
 
 ### Return type
 

data/docs/TransactionsResponse.md

@@ -1,4 +1,4 @@
-# YnabApi::TransactionsResponse
+# YNAB::TransactionsResponse
 
 ## Properties
 Name | Type | Description | Notes

data/docs/TransactionsWrapper.md

@@ -1,4 +1,4 @@
-# YnabApi::TransactionsWrapper
+# YNAB::TransactionsWrapper
 
 ## Properties
 Name | Type | Description | Notes

data/docs/User.md

@@ -1,4 +1,4 @@
-# YnabApi::User
+# YNAB::User
 
 ## Properties
 Name | Type | Description | Notes

data/docs/UserApi.md

@@ -1,4 +1,4 @@
-# YnabApi::UserApi
+# YNAB::UserApi
 
 All URIs are relative to *https://api.youneedabudget.com/v1*
 

data/docs/UserResponse.md

@@ -1,4 +1,4 @@
-# YnabApi::UserResponse
+# YNAB::UserResponse
 
 ## Properties
 Name | Type | Description | Notes

data/docs/UserWrapper.md

@@ -1,4 +1,4 @@
-# YnabApi::UserWrapper
+# YNAB::UserWrapper
 
 ## Properties
 Name | Type | Description | Notes

data/examples/budget-list.rb

@@ -3,7 +3,7 @@ require 'ynab'
 
 def print_budget_list
   access_token = 'bf0cbb14b4330-not-real-3de12e66a389eaafe2'
-  ynab = YnabApi::Client.new(access_token)
+  ynab = YNAB::API.new(access_token)
 
   puts "Fetching budgets..."
   begin

data/examples/budget-month.rb

@@ -4,7 +4,7 @@ require 'date'
 
 def print_budget_month
   access_token = 'bf0cbb14b4330-not-real-3de12e66a389eaafe2'
-  ynab = YnabApi::Client.new(access_token)
+  ynab = YNAB::API.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

data/examples/category-balance.rb

@@ -3,7 +3,7 @@ require 'ynab'
 
 def print_category_info
   access_token = 'bf0cbb14b4330-not-real-3de12e66a389eaafe2'
-  ynab = YnabApi::Client.new(access_token)
+  ynab = YNAB::API.new(access_token)
 
   budget_id = "f968197b-2863-not-real-c2406dbe7f0d"
   category_id = "a191ac84-de09-not-real-6c5ed8cfdabe"

data/lib/ynab.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1.0.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.0-SNAPSHOT
+Swagger Codegen version: 2.4.0-SNAPSHOT
 
 =end
 
@@ -17,7 +17,6 @@ require 'ynab/version'
 require 'ynab/configuration'
 
 # Models
-require 'ynab/models/user'
 require 'ynab/models/account'
 require 'ynab/models/account_response'
 require 'ynab/models/account_wrapper'
@@ -25,9 +24,16 @@ 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_settings'
+require 'ynab/models/budget_settings_response'
+require 'ynab/models/budget_settings_wrapper'
 require 'ynab/models/budget_summary'
 require 'ynab/models/budget_summary_response'
 require 'ynab/models/budget_summary_wrapper'
+require 'ynab/models/bulk_id_wrapper'
+require 'ynab/models/bulk_ids'
+require 'ynab/models/bulk_response'
+require 'ynab/models/bulk_transactions'
 require 'ynab/models/categories_response'
 require 'ynab/models/category'
 require 'ynab/models/category_group'
@@ -38,6 +44,8 @@ require 'ynab/models/currency_format'
 require 'ynab/models/date_format'
 require 'ynab/models/error_detail'
 require 'ynab/models/error_response'
+require 'ynab/models/hybrid_transactions_response'
+require 'ynab/models/hybrid_transactions_wrapper'
 require 'ynab/models/month_detail_response'
 require 'ynab/models/month_detail_wrapper'
 require 'ynab/models/month_summaries_response'
@@ -53,34 +61,31 @@ require 'ynab/models/payee_response'
 require 'ynab/models/payee_wrapper'
 require 'ynab/models/payees_response'
 require 'ynab/models/payees_wrapper'
+require 'ynab/models/save_transaction'
+require 'ynab/models/save_transaction_wrapper'
 require 'ynab/models/scheduled_sub_transaction'
 require 'ynab/models/scheduled_transaction_response'
+require 'ynab/models/scheduled_transaction_summary'
 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_summary'
 require 'ynab/models/transaction_wrapper'
 require 'ynab/models/transactions_response'
 require 'ynab/models/transactions_wrapper'
-require 'ynab/models/transaction_summary'
+require 'ynab/models/user'
+require 'ynab/models/user_response'
+require 'ynab/models/user_wrapper'
 require 'ynab/models/budget_detail'
 require 'ynab/models/category_group_with_categories'
+require 'ynab/models/hybrid_transaction'
 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'
-require 'ynab/models/hybrid_transactions_response'
-require 'ynab/models/hybrid_transactions_wrapper'
-require 'ynab/models/hybrid_transaction'
-
 
 # APIs
-require 'ynab/api/user_api'
 require 'ynab/api/accounts_api'
 require 'ynab/api/budgets_api'
 require 'ynab/api/categories_api'
@@ -89,9 +94,10 @@ require 'ynab/api/payee_locations_api'
 require 'ynab/api/payees_api'
 require 'ynab/api/scheduled_transactions_api'
 require 'ynab/api/transactions_api'
+require 'ynab/api/user_api'
 
-module YnabApi
-  class Client
+module YNAB
+  class API
     def initialize(access_token, host = 'api.youneedabudget.com', useHttps = true)
       config = Configuration.default
       config.api_key['Authorization'] = access_token
@@ -144,3 +150,9 @@ module YnabApi
     end
   end
 end
+
+# Support old interface: YnabApi::Client
+module YnabApi
+  class Client < YNAB::API
+  end
+end

data/lib/ynab/api/accounts_api.rb

@@ -12,7 +12,7 @@ Swagger Codegen version: 2.4.0-SNAPSHOT
 
 require 'uri'
 
-module YnabApi
+module YNAB
   class AccountsApi
     attr_accessor :api_client
 

data/lib/ynab/api/budgets_api.rb

@@ -12,7 +12,7 @@ Swagger Codegen version: 2.4.0-SNAPSHOT
 
 require 'uri'
 
-module YnabApi
+module YNAB
   class BudgetsApi
     attr_accessor :api_client
 
@@ -74,6 +74,58 @@ module YnabApi
       end
       return data, status_code, headers
     end
+    # Budget Settings
+    # Returns settings for a budget.
+    # @param budget_id The ID of the Budget.
+    # @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)
+      data
+    end
+
+    # Budget Settings
+    # Returns settings for a budget.
+    # @param budget_id The ID of the Budget.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BudgetSettingsResponse, Fixnum, Hash)>] BudgetSettingsResponse data, response status code and response headers
+    def get_budget_settings_by_id_with_http_info(budget_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BudgetsApi.get_budget_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"
+      end
+      # resource path
+      local_var_path = '/budgets/{budget_id}/settings'.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 => 'BudgetSettingsResponse')
+      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}"
+      end
+      return data, status_code, headers
+    end
     # List budgets
     # Returns budgets list with summary information.
     # @param [Hash] opts the optional parameters