ynab 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7d7da4f24baccaa3813fd7579e074138cf03410
-  data.tar.gz: d60194b11d71357bd19ad03786cc162064e43dbe
+  metadata.gz: 311e29f4028a2e5f62f1063d1f4ab93f80b7a84c
+  data.tar.gz: bf1f7c152d6fd1b47f6d5579d3db4d4382c427d9
 SHA512:
-  metadata.gz: c59b23d133e8b97acb3dc0b7eb6f7c2e3c64cb6dc0970d3020f590273766142a3ef3999b48e4c36cdaa3c0243000425f678f26e9194cfa11db86ddac3caccd17
-  data.tar.gz: 9df41334d96ca6bfadc98dd1277b86396a52ff847f048dda358a105205a660c4c19ff203bf2b1dfc8dca5571bdd066e4063fb3dad8894e1c2179e07fde6f9e4e
+  metadata.gz: ef7959d67c285d6f7afceed65bc2b44e3dcb8fa8fd730033142a8b1f08447579bc9b415779a43adff38b34f772b1a37b1f10f8c4d70373e3a6c9afb60473528c
+  data.tar.gz: b7454f90ce3c7a7e5b81f9403983d7bf81a8d42c8a26f311502734f849c83a1fdf17ca71634cd0f45dc8017437cf497a0826d418e7233bde8a6036912cf56414

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ynab (0.6.0)
+    ynab (0.7.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 

data/README.md

@@ -1,7 +1,7 @@
 # YNAB API Ruby Library
 
 [![Build Status](https://travis-ci.org/ynab/ynab-sdk-ruby.svg?branch=master)](https://travis-ci.org/ynab/ynab-sdk-ruby)
-[![RubyGem](https://img.shields.io/gem/v/ynab.svg)](https://rubygems.org/gems/ynab)
+[![Gem Version](https://badge.fury.io/rb/ynab.svg)](https://rubygems.org/gems/ynab)
 
 **NOTE: The YNAB API is currently only available to Early Access users.  If you are interested in requesting access before the API is generally available, please fill out [this form](https://docs.google.com/forms/d/17plY-CE39Xl3pe2GqyVH1Unre8TjYKs-tkI6jVC4ko4/edit).**
 
@@ -50,29 +50,29 @@ The following methods are available in this library.
 
 |                       | Method                                                | Description                                                                                            |
 |------------------------|-------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
-| **User**                | `budgets.get_user()`                                  | Returns authenticated user information
-| **Budgets**                | `budgets.get_budgets()`                                  | Returns budgets list with summary information                                                          |
-|                        | `budgets.get_budget_by_id(id)`                             | Returns a single budget with all related entities |
-| **Accounts**               | `accounts.get_accounts(budget_id)`                                | Returns all accounts                                                                                   |
-|                        | `accounts.get_account_by_id(budget_id, id)`                           | Returns a single account                                                                               |
-| **Categories**             | `categories.get_categories(budget_id)`                            | Returns all categories grouped by category group.                                                      |
-|                        | `categories.get_category_by_id(budget_id, id)`                        | Returns a single category                                                                              |
-| **Payees**                 | `payees.get_payees(budget_id)`                                    | Returns all payees                                                                                     |
-|                        | `payees.get_payee_by_id(budget_id, id)`                               | Returns single payee                                                                                   |
-| **Payee Locations**        | `payee_locations.get_payee_locations(budget_id)`                    | Returns all payee locations                                                                            |
-|                        | `payee_locations.get_payee_location_by_id(budget_id, id)`               | Returns a single payee location                                                                        |
-|                        | `payee_locations.get_payee_locations_by_payee(budget_id, id)`           | Returns all payee locations for the specified payee                                                    |
-| **Months**                 | `months.get_budget_months(budget_id)`                              | Returns all budget months                                                                              |
-|                        | `months.get_budget_month(budget_id, month)`                             | Returns a single budget month                                                                          |
-| **Transactions**           | `transactions.get_transactions(budget_id)`                        | Returns budget transactions                                                                            |
-|                        | `transactions.get_transactions_by_account(budget_id, id)`               | Returns all transactions for a specified account                                                       |
-|                        | `transactions.get_transactions_by_category(budget_id, id)`              | Returns all transactions for a specified category                                                      |
-|                        | `transactions.get_transactions_by_id(budget_id, id)`                  | Returns a single transaction                                                                           |
-|                        | `transactions.update_transaction(budget_id, id, transaction)`                      | Updates a transaction                                                                                   |
-|                        | `transactions.create_transaction(budget_id, transaction)`                      | Creates a new transaction                                                                              |
-|                        | `transactions.bulk_create_transactions(budget_id, transactions)`                 | Creates multiple transactions                                                                          |
-| **Scheduled Transactions** | `scheduled_transactions.get_scheduled_transactions(budget_id)`      | Returns all scheduled transactions                                                                     |
-|                        | `scheduled_transactions.get_scheduled_transaction_by_id(budget_id, id)` | Returns a single scheduled transaction                                                                 |
+| **User**                | [budgets.get_user()](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/UserApi.md#get_user)                                  | Returns authenticated user information
+| **Budgets**                | [budgets.get_budgets()](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/BudgetsApi.md#get_budgets)                                  | Returns budgets list with summary information                                                          |
+|                        | [budgets.get_budget_by_id(id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/BudgetsApi.md#get_budget_by_id)                             | Returns a single budget with all related entities |
+| **Accounts**               | [accounts.get_accounts(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/AccountsApi.md#get_accounts)                               | Returns all accounts                                                                                   |
+|                        | [accounts.get_account_by_id(budget_id, id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/AccountsApi.md#get_account_by_id)                           | Returns a single account                                                                               |
+| **Categories**             | [categories.get_categories(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/CategoriesApi.md#get_categories)                            | Returns all categories grouped by category group.                                                      |
+|                        | [categories.get_category_by_id(budget_id, id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/CategoriesApi.md#get_category_by_id)                        | Returns a single category                                                                              |
+| **Payees**                 | [payees.get_payees(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeesApi.md#get_payees)                                    | Returns all payees                                                                                     |
+|                        | [payees.get_payee_by_id(budget_id, id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeesApi.md#get_payee_by_id)                               | Returns single payee                                                                                   |
+| **Payee Locations**        | [payee_locations.get_payee_locations(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeeLocationsApi.md#get_payee_locations)                    | Returns all payee locations                                                                            |
+|                        | [payee_locations.get_payee_location_by_id(budget_id, id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeeLocationsApi.md#get_payee_location_by_id)               | Returns a single payee location                                                                        |
+|                        | [payee_locations.get_payee_locations_by_payee(budget_id, id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeeLocationsApi.md#get_payee_locations_by_payee)           | Returns all payee locations for the specified payee                                                    |
+| **Months**                 | [months.get_budget_months(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/MonthsApi.md#get_budget_months)                              | Returns all budget months                                                                              |
+|                        | [months.get_budget_month(budget_id, month)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/MonthsApi.md#get_budget_month)                             | Returns a single budget month                                                                          |
+| **Transactions**           | [transactions.get_transactions(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#get_transactions)                        | Returns budget transactions                                                                            |
+|                        | [transactions.get_transactions_by_account(budget_id, id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#get_transactions_by_account)              | Returns all transactions for a specified account                                                       |
+|                        | [transactions.get_transactions_by_category(budget_id, id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#get_transactions_by_category)              | Returns all transactions for a specified category                                                      |
+|                        | [transactions.get_transactions_by_id(budget_id, id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#get_transactions_by_id)                  | Returns a single transaction                                                                           |
+|                        | [transactions.update_transaction(budget_id, id, transaction)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#update_transaction)                      | Updates a transaction                                                                                   |
+|                        | [transactions.create_transaction(budget_id, transaction)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#create_transaction)                    | Creates a new transaction                                                                              |
+|                        | [transactions.bulk_create_transactions(budget_id, transactions)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#bulk_create_transactions)                 | Creates multiple transactions                                                                          |
+| **Scheduled Transactions** | [scheduled_transactions.get_scheduled_transactions(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/ScheduledTransactionsApi.md#get_scheduled_transactions)      | Returns all scheduled transactions                                                                     |
+|                        | [scheduled_transactions.get_scheduled_transaction_by_id(budget_id, id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/ScheduledTransactionsApi.md#get_scheduled_transaction_by_id) | Returns a single scheduled transaction                                                                 |
 
 ## Development
 

data/Rakefile

@@ -14,7 +14,7 @@ desc "Run Swagger Code Generator to update the client from the Swagger spec"
 task :generate do
   # Download latest swagger spec
   spec_filename = 'spec-v1-swagger.json'
-  sh "rm #{spec_filename} && wget https://api.youneedabudget.com/papi/#{spec_filename}"
+  #sh "rm #{spec_filename} && wget https://api.youneedabudget.com/papi/#{spec_filename}"
 
   # Replace nullable types defined as i.e. ["string", "null"] in the spec to simply "string" as the generator does not understand the nullable format.
   # Examples:

data/config.json

@@ -1,7 +1,7 @@
 {
   "gemName": "ynab",
   "moduleName": "YnabApi",
-  "gemVersion": "0.6.0",
+  "gemVersion": "0.7.0",
   "gemDescription": "Ruby gem wrapper for the YNAB API. Read the documentation at https://api.youneedabudget.com",
   "gemHomepage": "https://github.com/ynab/ynab-sdk-ruby",
   "gemLicense": "Apache-2.0",

data/docs/AccountsApi.md

@@ -15,34 +15,6 @@ Single account
 
 Returns a single account
 
-### Example
-```ruby
-# load the gem
-require 'ynab'
-# setup authorization
-YnabApi.configure do |config|
-  # Configure API key authorization: bearer
-  config.api_key['Authorization'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Authorization'] = 'Bearer'
-end
-
-api_instance = YnabApi::AccountsApi.new
-
-budget_id = "budget_id_example" # String | The ID of the Budget.
-
-account_id = "account_id_example" # String | The ID of the Account.
-
-
-begin
-  #Single account
-  result = api_instance.get_account_by_id(budget_id, account_id)
-  p result
-rescue YnabApi::ApiError => e
-  puts "Exception when calling AccountsApi->get_account_by_id: #{e}"
-end
-```
-
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -54,17 +26,6 @@ Name | Type | Description  | Notes
 
 [**AccountResponse**](AccountResponse.md)
 
-### Authorization
-
-[bearer](../README.md#bearer)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
 # **get_accounts**
 > AccountsResponse get_accounts(budget_id)
 
@@ -72,32 +33,6 @@ Account list
 
 Returns all accounts
 
-### Example
-```ruby
-# load the gem
-require 'ynab'
-# setup authorization
-YnabApi.configure do |config|
-  # Configure API key authorization: bearer
-  config.api_key['Authorization'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Authorization'] = 'Bearer'
-end
-
-api_instance = YnabApi::AccountsApi.new
-
-budget_id = "budget_id_example" # String | The ID of the Budget.
-
-
-begin
-  #Account list
-  result = api_instance.get_accounts(budget_id)
-  p result
-rescue YnabApi::ApiError => e
-  puts "Exception when calling AccountsApi->get_accounts: #{e}"
-end
-```
-
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -108,14 +43,3 @@ Name | Type | Description  | Notes
 
 [**AccountsResponse**](AccountsResponse.md)
 
-### Authorization
-
-[bearer](../README.md#bearer)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-

data/docs/BudgetsApi.md

@@ -15,35 +15,6 @@ Single budget
 
 Returns a single budget with all related entities.  This resource is effectively a full budget export.
 
-### Example
-```ruby
-# load the gem
-require 'ynab'
-# setup authorization
-YnabApi.configure do |config|
-  # Configure API key authorization: bearer
-  config.api_key['Authorization'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Authorization'] = 'Bearer'
-end
-
-api_instance = YnabApi::BudgetsApi.new
-
-budget_id = "budget_id_example" # String | The ID of the Budget.
-
-opts = { 
-  last_knowledge_of_server: 8.14 # Float | The starting server knowledge.  If provided, only entities that have changed since last_knowledge_of_server will be included.
-}
-
-begin
-  #Single budget
-  result = api_instance.get_budget_by_id(budget_id, opts)
-  p result
-rescue YnabApi::ApiError => e
-  puts "Exception when calling BudgetsApi->get_budget_by_id: #{e}"
-end
-```
-
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -55,17 +26,6 @@ Name | Type | Description  | Notes
 
 [**BudgetDetailResponse**](BudgetDetailResponse.md)
 
-### Authorization
-
-[bearer](../README.md#bearer)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
 # **get_budgets**
 > BudgetSummaryResponse get_budgets
 
@@ -73,29 +33,6 @@ List budgets
 
 Returns budgets list with summary information.
 
-### Example
-```ruby
-# load the gem
-require 'ynab'
-# setup authorization
-YnabApi.configure do |config|
-  # Configure API key authorization: bearer
-  config.api_key['Authorization'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Authorization'] = 'Bearer'
-end
-
-api_instance = YnabApi::BudgetsApi.new
-
-begin
-  #List budgets
-  result = api_instance.get_budgets
-  p result
-rescue YnabApi::ApiError => e
-  puts "Exception when calling BudgetsApi->get_budgets: #{e}"
-end
-```
-
 ### Parameters
 This endpoint does not need any parameter.
 
@@ -103,14 +40,3 @@ This endpoint does not need any parameter.
 
 [**BudgetSummaryResponse**](BudgetSummaryResponse.md)
 
-### Authorization
-
-[bearer](../README.md#bearer)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-

data/docs/CategoriesApi.md

@@ -15,32 +15,6 @@ List categories
 
 Returns all categories grouped by category group.
 
-### Example
-```ruby
-# load the gem
-require 'ynab'
-# setup authorization
-YnabApi.configure do |config|
-  # Configure API key authorization: bearer
-  config.api_key['Authorization'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Authorization'] = 'Bearer'
-end
-
-api_instance = YnabApi::CategoriesApi.new
-
-budget_id = "budget_id_example" # String | The ID of the Budget.
-
-
-begin
-  #List categories
-  result = api_instance.get_categories(budget_id)
-  p result
-rescue YnabApi::ApiError => e
-  puts "Exception when calling CategoriesApi->get_categories: #{e}"
-end
-```
-
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -51,17 +25,6 @@ Name | Type | Description  | Notes
 
 [**CategoriesResponse**](CategoriesResponse.md)
 
-### Authorization
-
-[bearer](../README.md#bearer)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
 # **get_category_by_id**
 > CategoryResponse get_category_by_id(budget_id, category_id)
 
@@ -69,34 +32,6 @@ Single category
 
 Returns a single category
 
-### Example
-```ruby
-# load the gem
-require 'ynab'
-# setup authorization
-YnabApi.configure do |config|
-  # Configure API key authorization: bearer
-  config.api_key['Authorization'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Authorization'] = 'Bearer'
-end
-
-api_instance = YnabApi::CategoriesApi.new
-
-budget_id = "budget_id_example" # String | The ID of the Budget.
-
-category_id = "category_id_example" # String | The ID of the Category.
-
-
-begin
-  #Single category
-  result = api_instance.get_category_by_id(budget_id, category_id)
-  p result
-rescue YnabApi::ApiError => e
-  puts "Exception when calling CategoriesApi->get_category_by_id: #{e}"
-end
-```
-
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -108,14 +43,3 @@ Name | Type | Description  | Notes
 
 [**CategoryResponse**](CategoryResponse.md)
 
-### Authorization
-
-[bearer](../README.md#bearer)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-

data/docs/CurrencyFormat.md

@@ -3,6 +3,13 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**locale** | **String** |  | 
+**iso_code** | **String** |  | 
+**example_format** | **String** |  | 
+**decimal_digits** | **String** |  | 
+**decimal_separator** | **String** |  | 
+**symbol_first** | **BOOLEAN** |  | 
+**group_separator** | **String** |  | 
+**currency_symbol** | **String** |  | 
+**display_symbol** | **BOOLEAN** |  | 
 
 

data/docs/DateFormat.md

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**locale** | **String** |  | 
+**format** | **String** |  | 
 
 

data/docs/HybridTransaction.md

@@ -17,5 +17,8 @@ Name | Type | Description | Notes
 **import_id** | **String** | If the Transaction was imported, this field is a unique (by account) import identifier.  If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'.  For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'.  If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. | 
 **type** | **String** | Whether the hybrid transaction represents a regular transaction or a subtransaction | 
 **parent_transaction_id** | **String** | For subtransaction types, this is the id of the pararent transaction.  For transaction types, this id will be always be null. | 
+**account_name** | **String** |  | 
+**payee_name** | **String** |  | 
+**category_name** | **String** |  | 
 
 

data/docs/MonthsApi.md

@@ -15,34 +15,6 @@ Single budget month
 
 Returns a single budget month
 
-### Example
-```ruby
-# load the gem
-require 'ynab'
-# setup authorization
-YnabApi.configure do |config|
-  # Configure API key authorization: bearer
-  config.api_key['Authorization'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Authorization'] = 'Bearer'
-end
-
-api_instance = YnabApi::MonthsApi.new
-
-budget_id = "budget_id_example" # String | The ID of the Budget.
-
-month = Date.parse("2013-10-20") # Date | The Budget Month.  \"current\" can also be used to specify the current calendar month (UTC).
-
-
-begin
-  #Single budget month
-  result = api_instance.get_budget_month(budget_id, month)
-  p result
-rescue YnabApi::ApiError => e
-  puts "Exception when calling MonthsApi->get_budget_month: #{e}"
-end
-```
-
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -54,17 +26,6 @@ Name | Type | Description  | Notes
 
 [**MonthDetailResponse**](MonthDetailResponse.md)
 
-### Authorization
-
-[bearer](../README.md#bearer)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
 # **get_budget_months**
 > MonthSummariesResponse get_budget_months(budget_id)
 
@@ -72,32 +33,6 @@ List budget months
 
 Returns all budget months
 
-### Example
-```ruby
-# load the gem
-require 'ynab'
-# setup authorization
-YnabApi.configure do |config|
-  # Configure API key authorization: bearer
-  config.api_key['Authorization'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Authorization'] = 'Bearer'
-end
-
-api_instance = YnabApi::MonthsApi.new
-
-budget_id = "budget_id_example" # String | The ID of the Budget.
-
-
-begin
-  #List budget months
-  result = api_instance.get_budget_months(budget_id)
-  p result
-rescue YnabApi::ApiError => e
-  puts "Exception when calling MonthsApi->get_budget_months: #{e}"
-end
-```
-
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -108,14 +43,3 @@ Name | Type | Description  | Notes
 
 [**MonthSummariesResponse**](MonthSummariesResponse.md)
 
-### Authorization
-
-[bearer](../README.md#bearer)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-