ynab 1.29.0 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 306574eacfc6eb25c6c585e4a58721c97178f821033c723c302726438b80e687
-  data.tar.gz: 733bd356cb7937e5d0431627c9a001d7b6778a6cd2d3cdde5e6d7f77445440a8
+  metadata.gz: b9d748b2240c0fd89db37f5b2c4b0ddde93305d40f6f7b6671858cf92f9a1953
+  data.tar.gz: 4779f85e097034853bae07f72e464198d96ea4aa83fa8b19cc1edae4fd0be9a2
 SHA512:
-  metadata.gz: '0490e176ddfe56696c600dd9ce3d76106a77500784f8e5098c5c2e03a302ca78eb14379a35a8708116344c7962749fd5a15a2947b639b312690817a84fb67090'
-  data.tar.gz: 30fdc6295db42b1c26a8da02ca1d3dade17d594cd2a343a179f6db866e6a70c3f9a2309afd3cdd6060ca8a1ec04329cc90172f815c5c6419799564e0d7a4dcfa
+  metadata.gz: e9c8cd0b451e406b52ed58e2762f55e389c3875aa9f23defbf777c4afa15650beb0cef56e54c7eba9b7e19a9c71fa05559b613d2adde9ce580b16fe6a4d5c390
+  data.tar.gz: 1ee8edb4021e5b12e97dd927f1f1281520f58a5ce222c01a1ca6e63a52b9e34af37bef6c5efcbcd9ec057ab575a1adea36a453326eaf770c72ddb6ca52dc714d

data/DEVELOPMENT.md

@@ -0,0 +1,11 @@
+# Development
+
+## Setup
+
+- Install dependencies: `bundle`
+- Generate latest client based on swagger spec: `rake generate`
+- Run tests: `rake spec` or `rspec`
+
+## Publishing
+
+Run the "Publish" GitHub Actions workflow

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem "rake", ">= 12.3.3"
+  gem "vcr", ">=3.0.3"
+end

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    ynab (1.31.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.5)
+    rake (13.0.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    vcr (6.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (>= 12.3.3)
+  rspec (~> 3.6, >= 3.6.0)
+  vcr (>= 3.0.3)
+  ynab!
+
+BUNDLED WITH
+   2.3.24

data/README.md

@@ -1,11 +1,11 @@
 # 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)
+[![Continuous Integration](https://github.com/ynab/ynab-sdk-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/ynab/ynab-sdk-ruby/actions/workflows/ci.yml)
 [![Gem Version](https://badge.fury.io/rb/ynab.svg)](https://rubygems.org/gems/ynab)
 
 This is the Ruby client for the YNAB API.
 
-Please read the [YNAB API documentation](https://api.youneedabudget.com) for an
+Please read the [YNAB API documentation](https://api.ynab.com) for an
 overview of using the API and a complete list of available resources.
 
 This client is generated using the [Swagger Code Generator](https://github.com/swagger-api/swagger-codegen).
@@ -18,8 +18,8 @@ gem install ynab
 
 ## Usage
 To use this client you must
-[obtain an access token](https://api.youneedabudget.com/#authentication-overview) from
-your [Account Settings](https://app.youneedabudget.com/settings) page of the YNAB web
+[obtain an access token](https://api.ynab.com/#authentication-overview) from
+your [Account Settings](https://app.ynab.com/settings) page of the YNAB web
 app.
 
 ```ruby
@@ -71,8 +71,8 @@ The following methods are available in this library.
 |                            | [transactions.create_transactions(budget_id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#create_transaction)                                                                 | Creates multiple transactions                         |
 |                            | [transactions.update_transaction(budget_id, id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#update_transaction)                                                              | Updates a single transaction                          |
 |                            | [transactions.update_transactions(budget_id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#update_transactions)                                                                | Updates multiple transactions                         |
-|                            | [transactions.delete_transaction(budget_id, transaction_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#delete_transaction)                                                        | Imports transactions                                  |
-|                            | [transactions.import_transactions(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#import_transactions)                                                                      | Deletes a single transaction                          |
+|                            | [transactions.delete_transaction(budget_id, transaction_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#delete_transaction)                                                        | Deletes a single transaction                                     |
+|                            | [transactions.import_transactions(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#import_transactions)                                                                      | Imports 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, scheduled_transaction_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/ScheduledTransactionsApi.md#get_scheduled_transaction_by_id) | Returns a single scheduled transaction                |
 

data/Rakefile

@@ -0,0 +1,58 @@
+begin
+  require 'rspec/core/rake_task'
+  require 'bundler/gem_tasks'
+  require 'lib/ynab/version'
+
+  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 = 'open_api_spec.yaml'
+  sh "wget https://api.ynab.com/papi/#{spec_filename} -O ./#{spec_filename}"
+  sh "openapi-generator generate -i ./#{spec_filename} -g ruby -c config.json -t ./templates -o ./"
+end
+
+task :get_current_version do
+  puts YNAB::VERSION
+end
+
+task :bump_version_number, [:version_type] do |t, args|
+  current_version = YNAB::VERSION
+  new_version = current_version
+
+  # Increment version number
+  case args[:version_type]
+  when 'major'
+    new_version = current_version.split('.').tap { |v| v[0] = v[0].to_i + 1 }.join('.')
+  when 'minor'
+    new_version = current_version.split('.').tap { |v| v[1] = v[1].to_i + 1 }.join('.')
+  when 'patch'
+    new_version = current_version.split('.').tap { |v| v[2] = v[2].to_i + 1 }.join('.')
+  else
+    puts "Invalid version type: #{args[:version_type]}"
+    exit 1
+  end
+
+  version_file_path = 'lib/ynab/version.rb'
+  current_version_file_text = File.read(version_file_path)
+  new_version_file_text = current_version_file_text.gsub(current_version, new_version)
+  File.open(version_file_path, "w") {|file| file.puts new_version_file_text }
+
+  puts new_version
+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 => ['spec', 'commit_version_bump', 'clobber', 'release']
+

data/config.json

@@ -0,0 +1,9 @@
+{
+  "gemName": "ynab",
+  "moduleName": "YNAB",
+  "gemDescription": "Ruby gem wrapper for the YNAB API. Read the documentation at https://api.ynab.com",
+  "gemHomepage": "https://github.com/ynab/ynab-sdk-ruby",
+  "gemLicense": "Apache-2.0",
+  "gemAuthor": "YNAB",
+  "gemAuthorEmail": "api@ynab.com"
+}

data/docs/Account.md

@@ -0,0 +1,25 @@
+# YNAB::Account
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **type** | [**AccountType**](AccountType.md) |  |  |
+| **on_budget** | **Boolean** | Whether this account is on budget or not |  |
+| **closed** | **Boolean** | Whether this account is closed or not |  |
+| **note** | **String** |  | [optional] |
+| **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 |  |
+| **direct_import_linked** | **Boolean** | Whether or not the account is linked to a financial institution for automatic transaction import. | [optional] |
+| **direct_import_in_error** | **Boolean** | If an account linked to a financial institution (direct_import_linked=true) and the linked connection is not in a healthy state, this will be true. | [optional] |
+| **last_reconciled_at** | **Time** | A date/time specifying when the account was last reconciled. | [optional] |
+| **debt_original_balance** | **Integer** | The original debt/loan account balance, specified in milliunits format. | [optional] |
+| **debt_interest_rates** | **Hash<String, Integer>** |  | [optional] |
+| **debt_minimum_payments** | **Hash<String, Integer>** |  | [optional] |
+| **debt_escrow_amounts** | **Hash<String, Integer>** |  | [optional] |
+| **deleted** | **Boolean** | Whether or not the account has been deleted.  Deleted accounts will only be included in delta requests. |  |
+

data/docs/AccountResponse.md

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

data/docs/AccountResponseData.md

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

data/docs/AccountType.md

@@ -0,0 +1,7 @@
+# YNAB::AccountType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+

data/docs/AccountWrapper.md

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

data/docs/AccountsApi.md

@@ -0,0 +1,70 @@
+# YNAB::AccountsApi
+
+All URIs are relative to *https://api.ynab.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_account**](AccountsApi.md#create_account) | **POST** /budgets/{budget_id}/accounts | Create a new account |
+| [**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 |
+
+
+## create_account
+
+> <AccountResponse> create_account(budget_id, data)
+
+Create a new account
+
+Creates a new account
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget (\&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget) |  |
+| **data** | [**PostAccountWrapper**](PostAccountWrapper.md) | The account to create. |  |
+
+### Return type
+
+[**AccountResponse**](AccountResponse.md)
+
+
+## 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** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **account_id** | **String** | The id of the account |  |
+
+### Return type
+
+[**AccountResponse**](AccountResponse.md)
+
+
+## get_accounts
+
+> <AccountsResponse> get_accounts(budget_id, opts)
+
+Account list
+
+Returns all accounts
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **last_knowledge_of_server** | **Integer** | The starting server knowledge.  If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included. | [optional] |
+
+### Return type
+
+[**AccountsResponse**](AccountsResponse.md)
+

data/docs/AccountsResponse.md

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

data/docs/AccountsResponseData.md

@@ -0,0 +1,9 @@
+# YNAB::AccountsResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **accounts** | [**Array<Account>**](Account.md) |  |  |
+| **server_knowledge** | **Integer** | The knowledge of the server |  |
+

data/docs/AccountsWrapper.md

@@ -0,0 +1,9 @@
+# YNAB::AccountsWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accounts** | [**Array<Account>**](Account.md) |  | 
+**server_knowledge** | **Integer** | The knowledge of the server | 
+
+

data/docs/BudgetDetail.md

@@ -0,0 +1,24 @@
+# YNAB::BudgetDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **last_modified_on** | **Time** | The last time any changes were made to the budget from either a web or mobile client | [optional] |
+| **first_month** | **Date** | The earliest budget month | [optional] |
+| **last_month** | **Date** | The latest budget month | [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/BudgetDetailAllOf.md

@@ -0,0 +1,17 @@
+# YNAB::BudgetDetailAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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

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

data/docs/BudgetDetailResponseData.md

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

data/docs/BudgetDetailWrapper.md

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

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** | [**BudgetSettingsResponseData**](BudgetSettingsResponseData.md) |  |  |
+

data/docs/BudgetSettingsResponseData.md

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

data/docs/BudgetSettingsWrapper.md

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

data/docs/BudgetSummary.md

@@ -0,0 +1,15 @@
+# YNAB::BudgetSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **last_modified_on** | **Time** | The last time any changes were made to the budget from either a web or mobile client | [optional] |
+| **first_month** | **Date** | The earliest budget month | [optional] |
+| **last_month** | **Date** | The latest budget month | [optional] |
+| **date_format** | [**DateFormat**](DateFormat.md) |  | [optional] |
+| **currency_format** | [**CurrencyFormat**](CurrencyFormat.md) |  | [optional] |
+| **accounts** | [**Array<Account>**](Account.md) | The budget accounts (only included if `include_accounts=true` specified as query parameter) | [optional] |
+

data/docs/BudgetSummaryResponse.md

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

data/docs/BudgetSummaryResponseData.md

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

data/docs/BudgetSummaryWrapper.md

@@ -0,0 +1,9 @@
+# YNAB::BudgetSummaryWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**budgets** | [**Array<BudgetSummary>**](BudgetSummary.md) |  | 
+**default_budget** | [**BudgetSummary**](BudgetSummary.md) | The default budget, if the associated application is configured to support specifying it | 
+
+

data/docs/BudgetsApi.md

@@ -0,0 +1,68 @@
+# YNAB::BudgetsApi
+
+All URIs are relative to *https://api.ynab.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** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+| **last_knowledge_of_server** | **Integer** | The starting server knowledge.  If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; 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** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |  |
+
+### Return type
+
+[**BudgetSettingsResponse**](BudgetSettingsResponse.md)
+
+
+## get_budgets
+
+> <BudgetSummaryResponse> get_budgets(opts)
+
+List budgets
+
+Returns budgets list with summary information
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **include_accounts** | **Boolean** | Whether to include the list of budget accounts | [optional] |
+
+### Return type
+
+[**BudgetSummaryResponse**](BudgetSummaryResponse.md)
+

data/docs/BulkIdWrapper.md

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

data/docs/BulkIds.md

@@ -0,0 +1,9 @@
+# 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

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

data/docs/BulkResponseData.md

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

data/docs/BulkResponseDataBulk.md

@@ -0,0 +1,9 @@
+# YNAB::BulkResponseDataBulk
+
+## 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/BulkTransactionCreateResponse.md

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