ynab 1.5.0 → 1.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +31 -30
- data/lib/ynab.rb +4 -1
- data/lib/ynab/api/categories_api.rb +10 -10
- data/lib/ynab/api/deprecated_api.rb +81 -0
- data/lib/ynab/api/months_api.rb +2 -2
- data/lib/ynab/api/payee_locations_api.rb +2 -2
- data/lib/ynab/api/transactions_api.rb +12 -58
- data/lib/ynab/models/bulk_ids.rb +1 -1
- data/lib/ynab/models/category.rb +3 -3
- data/lib/ynab/models/category_group_with_categories.rb +1 -1
- data/lib/ynab/models/month_detail.rb +1 -1
- data/lib/ynab/models/transactions_wrapper.rb +19 -4
- data/lib/ynab/overrides/transactions_api.rb +44 -0
- data/lib/ynab/version.rb +1 -1
- data/spec/api/transactions_spec.rb +23 -1
- data/spec/fixtures/vcr_cassettes/create_transactions.yml +46 -0
- metadata +6 -105
- data/Gemfile +0 -7
- data/Gemfile.lock +0 -44
- data/Rakefile +0 -34
- data/config.json +0 -10
- data/docs/Account.md +0 -18
- data/docs/AccountResponse.md +0 -8
- data/docs/AccountWrapper.md +0 -8
- data/docs/AccountsApi.md +0 -45
- data/docs/AccountsResponse.md +0 -8
- data/docs/AccountsWrapper.md +0 -8
- data/docs/BudgetDetail.md +0 -22
- data/docs/BudgetDetailResponse.md +0 -8
- data/docs/BudgetDetailWrapper.md +0 -9
- data/docs/BudgetSettings.md +0 -9
- data/docs/BudgetSettingsResponse.md +0 -8
- data/docs/BudgetSettingsWrapper.md +0 -8
- data/docs/BudgetSummary.md +0 -12
- data/docs/BudgetSummaryResponse.md +0 -8
- data/docs/BudgetSummaryWrapper.md +0 -8
- data/docs/BudgetsApi.md +0 -60
- data/docs/BulkIdWrapper.md +0 -8
- data/docs/BulkIds.md +0 -9
- data/docs/BulkResponse.md +0 -8
- data/docs/BulkTransactionCreateResponse.md +0 -8
- data/docs/BulkTransactionIds.md +0 -8
- data/docs/BulkTransactions.md +0 -8
- data/docs/CategoriesApi.md +0 -86
- data/docs/CategoriesResponse.md +0 -8
- data/docs/Category.md +0 -22
- data/docs/CategoryGroup.md +0 -11
- data/docs/CategoryGroupWithCategories.md +0 -12
- data/docs/CategoryGroupsWrapper.md +0 -8
- data/docs/CategoryResponse.md +0 -8
- data/docs/CategoryWrapper.md +0 -8
- data/docs/CurrencyFormat.md +0 -15
- data/docs/DateFormat.md +0 -8
- data/docs/ErrorDetail.md +0 -10
- data/docs/ErrorResponse.md +0 -8
- data/docs/HybridTransaction.md +0 -26
- data/docs/HybridTransactionsResponse.md +0 -8
- data/docs/HybridTransactionsWrapper.md +0 -8
- data/docs/MonthDetail.md +0 -15
- data/docs/MonthDetailResponse.md +0 -8
- data/docs/MonthDetailWrapper.md +0 -8
- data/docs/MonthSummariesResponse.md +0 -8
- data/docs/MonthSummariesWrapper.md +0 -8
- data/docs/MonthSummary.md +0 -14
- data/docs/MonthsApi.md +0 -45
- data/docs/Payee.md +0 -11
- data/docs/PayeeLocation.md +0 -12
- data/docs/PayeeLocationResponse.md +0 -8
- data/docs/PayeeLocationWrapper.md +0 -8
- data/docs/PayeeLocationsApi.md +0 -64
- data/docs/PayeeLocationsResponse.md +0 -8
- data/docs/PayeeLocationsWrapper.md +0 -8
- data/docs/PayeeResponse.md +0 -8
- data/docs/PayeeWrapper.md +0 -8
- data/docs/PayeesApi.md +0 -45
- data/docs/PayeesResponse.md +0 -8
- data/docs/PayeesWrapper.md +0 -8
- data/docs/SaveMonthCategory.md +0 -8
- data/docs/SaveMonthCategoryWrapper.md +0 -8
- data/docs/SaveTransaction.md +0 -18
- data/docs/SaveTransactionWrapper.md +0 -8
- data/docs/SaveTransactionsResponse.md +0 -8
- data/docs/SaveTransactionsResponseData.md +0 -11
- data/docs/SaveTransactionsWrapper.md +0 -9
- data/docs/ScheduledSubTransaction.md +0 -15
- data/docs/ScheduledTransactionDetail.md +0 -23
- data/docs/ScheduledTransactionResponse.md +0 -8
- data/docs/ScheduledTransactionSummary.md +0 -19
- data/docs/ScheduledTransactionWrapper.md +0 -8
- data/docs/ScheduledTransactionsApi.md +0 -45
- data/docs/ScheduledTransactionsResponse.md +0 -8
- data/docs/ScheduledTransactionsWrapper.md +0 -8
- data/docs/SubTransaction.md +0 -15
- data/docs/TransactionDetail.md +0 -25
- data/docs/TransactionResponse.md +0 -8
- data/docs/TransactionSummary.md +0 -21
- data/docs/TransactionWrapper.md +0 -8
- data/docs/TransactionsApi.md +0 -168
- data/docs/TransactionsResponse.md +0 -8
- data/docs/TransactionsWrapper.md +0 -8
- data/docs/User.md +0 -8
- data/docs/UserApi.md +0 -23
- data/docs/UserResponse.md +0 -8
- data/docs/UserWrapper.md +0 -8
- data/examples/budget-list.rb +0 -24
- data/examples/budget-month.rb +0 -35
- data/examples/category-balance.rb +0 -26
- data/examples/create-multiple-transactions.rb +0 -44
- data/examples/create-transaction.rb +0 -31
- data/examples/update-category-budgeted.rb +0 -23
- data/pkg/ynab-1.0.0.gem +0 -0
- data/pkg/ynab-1.1.0.gem +0 -0
- data/pkg/ynab-1.3.0.gem +0 -0
- data/pkg/ynab-1.4.0.gem +0 -0
- data/spec-v1-swagger.json +0 -2729
- data/swagger-templates/api_client.mustache +0 -386
- data/swagger-templates/api_doc.mustache +0 -32
- data/swagger-templates/gem.mustache +0 -83
- data/swagger-templates/gemspec.mustache +0 -37
- data/ynab.gemspec +0 -40
data/docs/CategoriesResponse.md
DELETED
data/docs/Category.md
DELETED
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# YNAB::Category
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**id** | **String** | |
|
|
7
|
-
**category_group_id** | **String** | |
|
|
8
|
-
**name** | **String** | |
|
|
9
|
-
**hidden** | **BOOLEAN** | Whether or not the category is hidden |
|
|
10
|
-
**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]
|
|
11
|
-
**note** | **String** | |
|
|
12
|
-
**budgeted** | **Integer** | Budgeted amount in current month in milliunits format |
|
|
13
|
-
**activity** | **Integer** | Activity amount in current month in milliunits format |
|
|
14
|
-
**balance** | **Integer** | Balance in current month in milliunits format |
|
|
15
|
-
**goal_type** | **String** | The type of goal, if the cagegory has a goal (TB=Target Category Balance, TBD=Target Category Balance by Date, MF=Monthly Funding) |
|
|
16
|
-
**goal_creation_month** | **Date** | The month a goal was created |
|
|
17
|
-
**goal_target** | **Integer** | The goal target amount in milliunits |
|
|
18
|
-
**goal_target_month** | **Date** | If the goal type is 'TBD' (Target Category Balance by Date), this is the target month for the goal to be completed |
|
|
19
|
-
**goal_percentage_complete** | **Integer** | The percentage completion of the goal |
|
|
20
|
-
**deleted** | **BOOLEAN** | Whether or not the category has been deleted. Deleted categories will only be included in delta requests. |
|
|
21
|
-
|
|
22
|
-
|
data/docs/CategoryGroup.md
DELETED
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
# YNAB::CategoryGroup
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**id** | **String** | |
|
|
7
|
-
**name** | **String** | |
|
|
8
|
-
**hidden** | **BOOLEAN** | Whether or not the category group is hidden |
|
|
9
|
-
**deleted** | **BOOLEAN** | Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests. |
|
|
10
|
-
|
|
11
|
-
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
# YNAB::CategoryGroupWithCategories
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**id** | **String** | |
|
|
7
|
-
**name** | **String** | |
|
|
8
|
-
**hidden** | **BOOLEAN** | Whether or not the category group is hidden |
|
|
9
|
-
**deleted** | **BOOLEAN** | Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests. |
|
|
10
|
-
**categories** | [**Array<Category>**](Category.md) | Category group categories |
|
|
11
|
-
|
|
12
|
-
|
data/docs/CategoryResponse.md
DELETED
data/docs/CategoryWrapper.md
DELETED
data/docs/CurrencyFormat.md
DELETED
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# YNAB::CurrencyFormat
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**iso_code** | **String** | |
|
|
7
|
-
**example_format** | **String** | |
|
|
8
|
-
**decimal_digits** | **Integer** | |
|
|
9
|
-
**decimal_separator** | **String** | |
|
|
10
|
-
**symbol_first** | **BOOLEAN** | |
|
|
11
|
-
**group_separator** | **String** | |
|
|
12
|
-
**currency_symbol** | **String** | |
|
|
13
|
-
**display_symbol** | **BOOLEAN** | |
|
|
14
|
-
|
|
15
|
-
|
data/docs/DateFormat.md
DELETED
data/docs/ErrorDetail.md
DELETED
data/docs/ErrorResponse.md
DELETED
data/docs/HybridTransaction.md
DELETED
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# YNAB::HybridTransaction
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**id** | **String** | |
|
|
7
|
-
**date** | **Date** | |
|
|
8
|
-
**amount** | **Integer** | The transaction amount in milliunits format |
|
|
9
|
-
**memo** | **String** | |
|
|
10
|
-
**cleared** | **String** | The cleared status of the transaction |
|
|
11
|
-
**approved** | **BOOLEAN** | Whether or not the transaction is approved |
|
|
12
|
-
**flag_color** | **String** | The transaction flag |
|
|
13
|
-
**account_id** | **String** | |
|
|
14
|
-
**payee_id** | **String** | |
|
|
15
|
-
**category_id** | **String** | |
|
|
16
|
-
**transfer_account_id** | **String** | If a transfer transaction, the account to which it transfers |
|
|
17
|
-
**transfer_transaction_id** | **String** | If a transfer transaction, the id of transaction on the other side of the transfer |
|
|
18
|
-
**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'. |
|
|
19
|
-
**deleted** | **BOOLEAN** | Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests. |
|
|
20
|
-
**type** | **String** | Whether the hybrid transaction represents a regular transaction or a subtransaction |
|
|
21
|
-
**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. |
|
|
22
|
-
**account_name** | **String** | |
|
|
23
|
-
**payee_name** | **String** | |
|
|
24
|
-
**category_name** | **String** | |
|
|
25
|
-
|
|
26
|
-
|
data/docs/MonthDetail.md
DELETED
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# YNAB::MonthDetail
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**month** | **Date** | |
|
|
7
|
-
**note** | **String** | |
|
|
8
|
-
**income** | **Integer** | The total amount in transactions categorized to 'Inflow: To be Budgeted' in the month |
|
|
9
|
-
**budgeted** | **Integer** | The total amount budgeted in the month |
|
|
10
|
-
**activity** | **Integer** | The total amount in transactions in the month, excluding those categorized to 'Inflow: To be Budgeted' |
|
|
11
|
-
**to_be_budgeted** | **Integer** | The available amount for 'To be Budgeted' |
|
|
12
|
-
**age_of_money** | **Integer** | The Age of Money as of the month |
|
|
13
|
-
**categories** | [**Array<Category>**](Category.md) | the budget month categories |
|
|
14
|
-
|
|
15
|
-
|
data/docs/MonthDetailResponse.md
DELETED
data/docs/MonthDetailWrapper.md
DELETED
data/docs/MonthSummary.md
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
# YNAB::MonthSummary
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**month** | **Date** | |
|
|
7
|
-
**note** | **String** | |
|
|
8
|
-
**income** | **Integer** | The total amount in transactions categorized to 'Inflow: To be Budgeted' in the month |
|
|
9
|
-
**budgeted** | **Integer** | The total amount budgeted in the month |
|
|
10
|
-
**activity** | **Integer** | The total amount in transactions in the month, excluding those categorized to 'Inflow: To be Budgeted' |
|
|
11
|
-
**to_be_budgeted** | **Integer** | The available amount for 'To be Budgeted' |
|
|
12
|
-
**age_of_money** | **Integer** | The Age of Money as of the month |
|
|
13
|
-
|
|
14
|
-
|
data/docs/MonthsApi.md
DELETED
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
# YNAB::MonthsApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *https://api.youneedabudget.com/v1*
|
|
4
|
-
|
|
5
|
-
Method | HTTP request | Description
|
|
6
|
-
------------- | ------------- | -------------
|
|
7
|
-
[**get_budget_month**](MonthsApi.md#get_budget_month) | **GET** /budgets/{budget_id}/months/{month} | Single budget month
|
|
8
|
-
[**get_budget_months**](MonthsApi.md#get_budget_months) | **GET** /budgets/{budget_id}/months | List budget months
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
# **get_budget_month**
|
|
12
|
-
> MonthDetailResponse get_budget_month(budget_id, month)
|
|
13
|
-
|
|
14
|
-
Single budget month
|
|
15
|
-
|
|
16
|
-
Returns a single budget month
|
|
17
|
-
|
|
18
|
-
### Parameters
|
|
19
|
-
|
|
20
|
-
Name | Type | Description | Notes
|
|
21
|
-
------------- | ------------- | ------------- | -------------
|
|
22
|
-
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
23
|
-
**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). |
|
|
24
|
-
|
|
25
|
-
### Return type
|
|
26
|
-
|
|
27
|
-
[**MonthDetailResponse**](MonthDetailResponse.md)
|
|
28
|
-
|
|
29
|
-
# **get_budget_months**
|
|
30
|
-
> MonthSummariesResponse get_budget_months(budget_id)
|
|
31
|
-
|
|
32
|
-
List budget months
|
|
33
|
-
|
|
34
|
-
Returns all budget months
|
|
35
|
-
|
|
36
|
-
### Parameters
|
|
37
|
-
|
|
38
|
-
Name | Type | Description | Notes
|
|
39
|
-
------------- | ------------- | ------------- | -------------
|
|
40
|
-
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
41
|
-
|
|
42
|
-
### Return type
|
|
43
|
-
|
|
44
|
-
[**MonthSummariesResponse**](MonthSummariesResponse.md)
|
|
45
|
-
|
data/docs/Payee.md
DELETED
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
# YNAB::Payee
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**id** | **String** | |
|
|
7
|
-
**name** | **String** | |
|
|
8
|
-
**transfer_account_id** | **String** | If a transfer payee, the account_id to which this payee transfers to |
|
|
9
|
-
**deleted** | **BOOLEAN** | Whether or not the payee has been deleted. Deleted payees will only be included in delta requests. |
|
|
10
|
-
|
|
11
|
-
|
data/docs/PayeeLocation.md
DELETED
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
# YNAB::PayeeLocation
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
Name | Type | Description | Notes
|
|
5
|
-
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**id** | **String** | |
|
|
7
|
-
**payee_id** | **String** | |
|
|
8
|
-
**latitude** | **String** | |
|
|
9
|
-
**longitude** | **String** | |
|
|
10
|
-
**deleted** | **BOOLEAN** | Whether or not the payee location has been deleted. Deleted payee locations will only be included in delta requests. |
|
|
11
|
-
|
|
12
|
-
|
data/docs/PayeeLocationsApi.md
DELETED
|
@@ -1,64 +0,0 @@
|
|
|
1
|
-
# YNAB::PayeeLocationsApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *https://api.youneedabudget.com/v1*
|
|
4
|
-
|
|
5
|
-
Method | HTTP request | Description
|
|
6
|
-
------------- | ------------- | -------------
|
|
7
|
-
[**get_payee_location_by_id**](PayeeLocationsApi.md#get_payee_location_by_id) | **GET** /budgets/{budget_id}/payee_locations/{payee_location_id} | Single payee location
|
|
8
|
-
[**get_payee_locations**](PayeeLocationsApi.md#get_payee_locations) | **GET** /budgets/{budget_id}/payee_locations | List payee locations
|
|
9
|
-
[**get_payee_locations_by_payee**](PayeeLocationsApi.md#get_payee_locations_by_payee) | **GET** /budgets/{budget_id}/payees/{payee_id}/payee_locations | List locations for a payee
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
# **get_payee_location_by_id**
|
|
13
|
-
> PayeeLocationResponse get_payee_location_by_id(budget_id, payee_location_id)
|
|
14
|
-
|
|
15
|
-
Single payee location
|
|
16
|
-
|
|
17
|
-
Returns a single payee location
|
|
18
|
-
|
|
19
|
-
### Parameters
|
|
20
|
-
|
|
21
|
-
Name | Type | Description | Notes
|
|
22
|
-
------------- | ------------- | ------------- | -------------
|
|
23
|
-
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
24
|
-
**payee_location_id** | [**String**](.md)| ID of payee location |
|
|
25
|
-
|
|
26
|
-
### Return type
|
|
27
|
-
|
|
28
|
-
[**PayeeLocationResponse**](PayeeLocationResponse.md)
|
|
29
|
-
|
|
30
|
-
# **get_payee_locations**
|
|
31
|
-
> PayeeLocationsResponse get_payee_locations(budget_id)
|
|
32
|
-
|
|
33
|
-
List payee locations
|
|
34
|
-
|
|
35
|
-
Returns all payee locations
|
|
36
|
-
|
|
37
|
-
### Parameters
|
|
38
|
-
|
|
39
|
-
Name | Type | Description | Notes
|
|
40
|
-
------------- | ------------- | ------------- | -------------
|
|
41
|
-
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
42
|
-
|
|
43
|
-
### Return type
|
|
44
|
-
|
|
45
|
-
[**PayeeLocationsResponse**](PayeeLocationsResponse.md)
|
|
46
|
-
|
|
47
|
-
# **get_payee_locations_by_payee**
|
|
48
|
-
> PayeeLocationsResponse get_payee_locations_by_payee(budget_id, payee_id)
|
|
49
|
-
|
|
50
|
-
List locations for a payee
|
|
51
|
-
|
|
52
|
-
Returns all payee locations for the specified payee
|
|
53
|
-
|
|
54
|
-
### Parameters
|
|
55
|
-
|
|
56
|
-
Name | Type | Description | Notes
|
|
57
|
-
------------- | ------------- | ------------- | -------------
|
|
58
|
-
**budget_id** | [**String**](.md)| The id of the budget (\"last-used\" can also be used to specify the last used budget) |
|
|
59
|
-
**payee_id** | [**String**](.md)| id of payee |
|
|
60
|
-
|
|
61
|
-
### Return type
|
|
62
|
-
|
|
63
|
-
[**PayeeLocationsResponse**](PayeeLocationsResponse.md)
|
|
64
|
-
|
data/docs/PayeeResponse.md
DELETED