ynab 1.5.0 → 1.6.0

data/Rakefile

@@ -1,34 +0,0 @@
-begin
-  require 'rspec/core/rake_task'
-  require 'bundler/gem_tasks'
-
-  RSpec::Core::RakeTask.new(:spec) do |t|
-    t.rspec_opts = "-fd"
-  end
-rescue LoadError
-  # no rspec available
-end
-
-task :default => [:spec]
-
-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}"
-
-  # Use Docker to codegen ruby based on the swagger spec
-  sh "docker run --rm -v ${PWD}:/local swaggerapi/swagger-codegen-cli generate"\
-     " -i /local/spec-v1-swagger.json"\
-     " -l ruby"\
-     " -c /local/config.json -o /local"\
-     " -t /local/swagger-templates"
-end
-
-task :commit_version_bump do
-  sh "git add config.json 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,10 +0,0 @@
-{
-  "gemName": "ynab",
-  "moduleName": "YNAB",
-  "gemVersion": "1.5.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",
-  "gemAuthor": "You Need A Budget, LLC",
-  "gemAuthorEmail": "help@youneedabudget.com"
-}

data/docs/Account.md

@@ -1,18 +0,0 @@
-# YNAB::Account
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | 
-**name** | **String** |  | 
-**type** | **String** | The type of account. Note: payPal, merchantAccount, investmentAccount, and mortgage types have been deprecated and will be removed in the future. | 
-**on_budget** | **BOOLEAN** | Whether this account is on budget or not | 
-**closed** | **BOOLEAN** | Whether this account is closed or not | 
-**note** | **String** |  | 
-**balance** | **Integer** | The current balance of the account in milliunits format | 
-**cleared_balance** | **Integer** | The current cleared balance of the account in milliunits format | 
-**uncleared_balance** | **Integer** | The current uncleared balance of the account in milliunits format | 
-**transfer_payee_id** | **String** | The payee id which should be used when transferring to this account | 
-**deleted** | **BOOLEAN** | Whether or not the account has been deleted.  Deleted accounts will only be included in delta requests. | 
-
-

data/docs/AccountResponse.md

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

data/docs/AccountWrapper.md

@@ -1,8 +0,0 @@
-# YNAB::AccountWrapper
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**account** | [**Account**](Account.md) |  | 
-
-

data/docs/AccountsApi.md

@@ -1,45 +0,0 @@
-# YNAB::AccountsApi
-
-All URIs are relative to *https://api.youneedabudget.com/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_account_by_id**](AccountsApi.md#get_account_by_id) | **GET** /budgets/{budget_id}/accounts/{account_id} | Single account
-[**get_accounts**](AccountsApi.md#get_accounts) | **GET** /budgets/{budget_id}/accounts | Account list
-
-
-# **get_account_by_id**
-> AccountResponse get_account_by_id(budget_id, account_id)
-
-Single account
-
-Returns a single account
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) | 
- **account_id** | [**String**](.md)| The id of the account | 
-
-### Return type
-
-[**AccountResponse**](AccountResponse.md)
-
-# **get_accounts**
-> AccountsResponse get_accounts(budget_id)
-
-Account list
-
-Returns all accounts
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) | 
-
-### Return type
-
-[**AccountsResponse**](AccountsResponse.md)
-

data/docs/AccountsResponse.md

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

data/docs/AccountsWrapper.md

@@ -1,8 +0,0 @@
-# YNAB::AccountsWrapper
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accounts** | [**Array<Account>**](Account.md) |  | 
-
-

data/docs/BudgetDetail.md

@@ -1,22 +0,0 @@
-# YNAB::BudgetDetail
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | 
-**name** | **String** |  | 
-**last_modified_on** | **DateTime** | The last time any changes were made to the budget from either a web or mobile client. | [optional] 
-**date_format** | [**DateFormat**](DateFormat.md) |  | [optional] 
-**currency_format** | [**CurrencyFormat**](CurrencyFormat.md) |  | [optional] 
-**accounts** | [**Array<Account>**](Account.md) |  | [optional] 
-**payees** | [**Array<Payee>**](Payee.md) |  | [optional] 
-**payee_locations** | [**Array<PayeeLocation>**](PayeeLocation.md) |  | [optional] 
-**category_groups** | [**Array<CategoryGroup>**](CategoryGroup.md) |  | [optional] 
-**categories** | [**Array<Category>**](Category.md) |  | [optional] 
-**months** | [**Array<MonthDetail>**](MonthDetail.md) |  | [optional] 
-**transactions** | [**Array<TransactionSummary>**](TransactionSummary.md) |  | [optional] 
-**subtransactions** | [**Array<SubTransaction>**](SubTransaction.md) |  | [optional] 
-**scheduled_transactions** | [**Array<ScheduledTransactionSummary>**](ScheduledTransactionSummary.md) |  | [optional] 
-**scheduled_subtransactions** | [**Array<ScheduledSubTransaction>**](ScheduledSubTransaction.md) |  | [optional] 
-
-

data/docs/BudgetDetailResponse.md

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

data/docs/BudgetDetailWrapper.md

@@ -1,9 +0,0 @@
-# YNAB::BudgetDetailWrapper
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**budget** | [**BudgetDetail**](BudgetDetail.md) |  | 
-**server_knowledge** | **Integer** | The knowledge of the server | 
-
-

data/docs/BudgetSettings.md

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

data/docs/BudgetSettingsResponse.md

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

data/docs/BudgetSettingsWrapper.md

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

data/docs/BudgetSummary.md

@@ -1,12 +0,0 @@
-# YNAB::BudgetSummary
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | 
-**name** | **String** |  | 
-**last_modified_on** | **DateTime** | The last time any changes were made to the budget from either a web or mobile client. | [optional] 
-**date_format** | [**DateFormat**](DateFormat.md) |  | [optional] 
-**currency_format** | [**CurrencyFormat**](CurrencyFormat.md) |  | [optional] 
-
-

data/docs/BudgetSummaryResponse.md

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

data/docs/BudgetSummaryWrapper.md

@@ -1,8 +0,0 @@
-# YNAB::BudgetSummaryWrapper
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**budgets** | [**Array<BudgetSummary>**](BudgetSummary.md) |  | 
-
-

data/docs/BudgetsApi.md

@@ -1,60 +0,0 @@
-# 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
-
-
-# **get_budget_by_id**
-> BudgetDetailResponse get_budget_by_id(budget_id, opts)
-
-Single budget
-
-Returns a single budget with all related entities.  This resource is effectively a full budget export.
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) | 
- **last_knowledge_of_server** | **Integer**| The starting server knowledge.  If provided, only entities that have changed since last_knowledge_of_server will be included. | [optional] 
-
-### Return type
-
-[**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 (\"last-used\" can also be used to specify the last used budget) | 
-
-### Return type
-
-[**BudgetSettingsResponse**](BudgetSettingsResponse.md)
-
-# **get_budgets**
-> BudgetSummaryResponse get_budgets
-
-List budgets
-
-Returns budgets list with summary information
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**BudgetSummaryResponse**](BudgetSummaryResponse.md)
-

data/docs/BulkIdWrapper.md

@@ -1,8 +0,0 @@
-# YNAB::BulkIdWrapper
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**bulk** | [**BulkIds**](BulkIds.md) |  | 
-
-

data/docs/BulkIds.md

@@ -1,9 +0,0 @@
-# YNAB::BulkIds
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**transaction_ids** | **Array<String>** | The list of Transaction IDs that were created. | 
-**duplicate_import_ids** | **Array<String>** | If any Transactions were not created because they had an import_id matching a transaction already on the same account, the specified import_id(s) will be included in this list. | 
-
-

data/docs/BulkResponse.md

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

data/docs/BulkTransactionCreateResponse.md

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

data/docs/BulkTransactionIds.md

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

data/docs/BulkTransactions.md

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

data/docs/CategoriesApi.md

@@ -1,86 +0,0 @@
-# YNAB::CategoriesApi
-
-All URIs are relative to *https://api.youneedabudget.com/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_categories**](CategoriesApi.md#get_categories) | **GET** /budgets/{budget_id}/categories | List categories
-[**get_category_by_id**](CategoriesApi.md#get_category_by_id) | **GET** /budgets/{budget_id}/categories/{category_id} | Single category
-[**get_month_category_by_id**](CategoriesApi.md#get_month_category_by_id) | **GET** /budgets/{budget_id}/months/{month}/categories/{category_id} | Single category for a specific budget month
-[**update_month_category**](CategoriesApi.md#update_month_category) | **PATCH** /budgets/{budget_id}/months/{month}/categories/{category_id} | Update an existing month category
-
-
-# **get_categories**
-> CategoriesResponse get_categories(budget_id)
-
-List categories
-
-Returns all categories grouped by category group
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) | 
-
-### Return type
-
-[**CategoriesResponse**](CategoriesResponse.md)
-
-# **get_category_by_id**
-> CategoryResponse get_category_by_id(budget_id, category_id)
-
-Single category
-
-Returns a single category
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) | 
- **category_id** | [**String**](.md)| The id of the category | 
-
-### Return type
-
-[**CategoryResponse**](CategoryResponse.md)
-
-# **get_month_category_by_id**
-> CategoryResponse get_month_category_by_id(budget_id, month, category_id)
-
-Single category for a specific budget month
-
-Returns a single category for a specific budget month
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) | 
- **month** | **Date**| the budget month in ISO format (e.g. 2016-12-30). (\"current\" can also be used to specify the current calendar month (UTC)) | 
- **category_id** | [**String**](.md)| The id of the category | 
-
-### Return type
-
-[**CategoryResponse**](CategoryResponse.md)
-
-# **update_month_category**
-> CategoryResponse update_month_category(budget_id, month, category_id, month_category)
-
-Update an existing month category
-
-Update an existing month category
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) | 
- **month** | **Date**| the budget month in ISO format (e.g. 2016-12-01).  \"current\" can also be used to specify the current calendar month (UTC). | 
- **category_id** | [**String**](.md)| The id of the category | 
- **month_category** | [**SaveMonthCategoryWrapper**](SaveMonthCategoryWrapper.md)| The month category to update | 
-
-### Return type
-
-[**CategoryResponse**](CategoryResponse.md)
-