ynab 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 544ab7cc74a4009daffb2af9406312fb344e7fe2
-  data.tar.gz: 26cb2562cdd186372478ddaf5703ae1530c8f41a
+  metadata.gz: 9234cd3a793053cfa67ca0cffd6d08c638989742
+  data.tar.gz: 955cc21173d5c86526d57d53bef16c46fc9cb59e
 SHA512:
-  metadata.gz: 1ed32df6c4d6efd0bae29bf2d028aca82cbaeb5be3a33550290243963d243bafbb6342a2cdb51cbde66a52af47b03c9da247c43416d93d368c9f8da1b5ed51e7
-  data.tar.gz: ee5ce1269201903e408019e01f713ec1c186735823ee28436e77199e1915d003b00bf07e3628b0e415bfb599998440e15b2804119ff6a50f765b4d33465bf81b
+  metadata.gz: 699bf0e03df428ddef46ad497a07dfae2c4e7059f293fc301859724731db22e0e6fef5dd5f390ed051b344241b90cd40932635191fa05c053165bef6aabbdb39
+  data.tar.gz: fc3b48d22d5a3ed98d387710c498d470c53947186f9c76e98d5a766b72739859d6fd22204c9ab3564c7972969d90f239badcec797fd681d7dccb39c91c9730d8

data/Gemfile.lock

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

data/README.md

@@ -28,7 +28,7 @@ require 'ynab'
 
 access_token = 'bf0cbb14b4330-not-real-3de12e66a389eaafe2'
 
-ynab = YnabApi::Client.new(access_token)
+ynab = YNAB::API.new(access_token)
 
 budget_response = ynab.budgets.get_budgets
 budgets = budget_response.data.budgets
@@ -77,7 +77,7 @@ The following methods are available in this library.
 - Install dependencies: `bundle`
 - Generate latest client based on swagger spec: `rake generate`
 - Run tests: `rake spec` or `rspec`
-- Publish: Update `gemVersion` in config.json and then `rake generate && rspec && gem build ynab && gem push ynab-0.0.0.gem`
+- Publish: Bump `gemVersion` in config.json and then run `rake publish`
 
 ## License
 

data/Rakefile

@@ -8,6 +8,7 @@ begin
 rescue LoadError
   # no rspec available
 end
+
 task :default => [:spec]
 
 desc "Run Swagger Code Generator to update the client from the Swagger spec"
@@ -29,3 +30,11 @@ task :generate do
      " -c /local/config.json -o /local"\
      " -t /local/swagger-templates"
 end
+
+task :commit_version_bump do
+  sh "git add lib/ynab/version.rb Gemfile.lock && git diff-index --quiet HEAD || git commit -m 'Bumping version for release'"
+end
+
+desc "Bump version, run specs build a gem and release on RubyGems"
+task :publish => ['generate', 'commit_version_bump', 'spec', 'release']
+

data/config.json

@@ -1,7 +1,7 @@
 {
   "gemName": "ynab",
-  "moduleName": "YnabApi",
-  "gemVersion": "1.0.0",
+  "moduleName": "YNAB",
+  "gemVersion": "1.1.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/Account.md

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

data/docs/AccountResponse.md

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

data/docs/AccountWrapper.md

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

data/docs/AccountsApi.md

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

data/docs/AccountsResponse.md

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

data/docs/AccountsWrapper.md

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

data/docs/BudgetDetail.md

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

data/docs/BudgetDetailResponse.md

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

data/docs/BudgetDetailWrapper.md

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

data/docs/BudgetSettings.md

@@ -0,0 +1,9 @@
+# YNAB::BudgetSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date_format** | [**DateFormat**](DateFormat.md) |  | 
+**currency_format** | [**CurrencyFormat**](CurrencyFormat.md) |  | 
+
+

data/docs/BudgetSettingsResponse.md

@@ -0,0 +1,8 @@
+# YNAB::BudgetSettingsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**BudgetSettingsWrapper**](BudgetSettingsWrapper.md) |  | 
+
+

data/docs/BudgetSettingsWrapper.md

@@ -0,0 +1,8 @@
+# YNAB::BudgetSettingsWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**settings** | [**BudgetSettings**](BudgetSettings.md) |  | 
+
+

data/docs/BudgetSummary.md

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

data/docs/BudgetSummaryResponse.md

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

data/docs/BudgetSummaryWrapper.md

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

data/docs/BudgetsApi.md

@@ -1,10 +1,11 @@
-# YnabApi::BudgetsApi
+# YNAB::BudgetsApi
 
 All URIs are relative to *https://api.youneedabudget.com/v1*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_budget_by_id**](BudgetsApi.md#get_budget_by_id) | **GET** /budgets/{budget_id} | Single budget
+[**get_budget_settings_by_id**](BudgetsApi.md#get_budget_settings_by_id) | **GET** /budgets/{budget_id}/settings | Budget Settings
 [**get_budgets**](BudgetsApi.md#get_budgets) | **GET** /budgets | List budgets
 
 
@@ -26,6 +27,23 @@ Name | Type | Description  | Notes
 
 [**BudgetDetailResponse**](BudgetDetailResponse.md)
 
+# **get_budget_settings_by_id**
+> BudgetSettingsResponse get_budget_settings_by_id(budget_id)
+
+Budget Settings
+
+Returns settings for a budget.
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget_id** | [**String**](.md)| The ID of the Budget. | 
+
+### Return type
+
+[**BudgetSettingsResponse**](BudgetSettingsResponse.md)
+
 # **get_budgets**
 > BudgetSummaryResponse get_budgets
 

data/docs/BulkIdWrapper.md

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

data/docs/BulkIds.md

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

data/docs/BulkResponse.md

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

data/docs/BulkTransactionCreateResponse.md

@@ -1,8 +1,8 @@
-# YnabApi::BulkTransactionCreateResponse
+# YNAB::BulkTransactionCreateResponse
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data** | [**BulkTransactionIds**](BulkTransactionIds.md) |  | 
+**data** | [**BulkTransactionIds**](BulkTransactionIds.md) |  |
 
 

data/docs/BulkTransactionIds.md

@@ -1,8 +1,8 @@
-# YnabApi::BulkTransactionIds
+# YNAB::BulkTransactionIds
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**transaction_ids** | **Array<String>** |  | 
+**transaction_ids** | **Array<String>** |  |
 
 

data/docs/BulkTransactions.md

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

data/docs/CategoriesApi.md

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

data/docs/CategoriesResponse.md

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

data/docs/Category.md

@@ -1,4 +1,4 @@
-# YnabApi::Category
+# YNAB::Category
 
 ## Properties
 Name | Type | Description | Notes
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **category_group_id** | **String** |  | 
 **name** | **String** |  | 
 **hidden** | **BOOLEAN** | Whether or not the category is hidden | 
+**original_category_group_id** | **String** | If category is hidden this is the id of the category group it originally belonged to before it was hidden. | [optional] 
 **note** | **String** |  | 
 **budgeted** | **Float** | Budgeted amount in current month in milliunits format | 
 **activity** | **Float** | Activity amount in current month in milliunits format | 

data/docs/CategoryGroup.md

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

data/docs/CategoryGroupWithCategories.md

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

data/docs/CategoryGroupsWrapper.md

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

data/docs/CategoryResponse.md

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

data/docs/CategoryWrapper.md

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

data/docs/CurrencyFormat.md

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

data/docs/DateFormat.md

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

data/docs/ErrorDetail.md

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

data/docs/ErrorResponse.md

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

data/docs/HybridTransaction.md

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

data/docs/HybridTransactionsResponse.md

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

data/docs/HybridTransactionsWrapper.md

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

data/docs/MonthDetail.md

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

data/docs/MonthDetailResponse.md

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

data/docs/MonthDetailWrapper.md

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

data/docs/MonthSummariesResponse.md

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

data/docs/MonthSummariesWrapper.md

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

data/docs/MonthSummary.md

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

data/docs/MonthsApi.md

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

data/docs/Payee.md

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

data/docs/PayeeLocation.md

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