ynab 5.1.0 → 5.2.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 176de7d09ec90d7defd49ae9ff687dc80c34d1c86b26c66fb6757f09061d745e
4
- data.tar.gz: d6786245768c2075538fb946c6805ffd90ad550597a70d07aa2a263792b7a6d3
3
+ metadata.gz: 8f8eb3003dda34ba7c9269b35452dd0d0bec02ddee8bef688f8e52e2503943b2
4
+ data.tar.gz: '0197df1eeddea055b045788c268801986ea6887c31d657e8c85c852dd5ccdf90'
5
5
  SHA512:
6
- metadata.gz: 4b63b0a402ad7952e3991685ae5f74179c9f41df73b6f43bdfb7d94575067cfff9110a352db98a9ce2523c98bb69925c3265a7309717f7ea2f7d567a9d1e5377
7
- data.tar.gz: ce834fb610f9b0a44197d2b515dbad5af00ad895c30b0caa025f9f3a5b7afea754fb73bf3c2f9858cbad48a57c4f76c720d153ee6274195193fd08508d277065
6
+ metadata.gz: ed5479594b0ddd569194cfe466a8dd8c66d28dfee79a949a5e2706f1ebb38aefb9801bc2629cc36ac6129105a05733592c624759e49e80dc4b60cc9331d497ee
7
+ data.tar.gz: 020c79b873bff0825173718cebab3025fcb22f06e19e0456cc3444c80e7944a0e77a96b659146411980f7fd3a4c4cb1e96ffc81ad1e955d66ee6abca5f77aaa2
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- ynab (5.0.0)
4
+ ynab (5.1.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
data/README.md CHANGED
@@ -64,6 +64,7 @@ The following methods are available in this library.
64
64
  | | [categories.update_month_category(plan_id, month, category_id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/CategoriesApi.md#update_month_category) | Updates a category for a specific month |
65
65
  | **Payees** | [payees.get_payees(plan_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeesApi.md#get_payees) | Returns all payees |
66
66
  | | [payees.get_payee_by_id(plan_id, payee_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeesApi.md#get_payee_by_id) | Returns a single payee |
67
+ | | [payees.create_payee(plan_id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeesApi.md#create_payee) | Creates a new payee |
67
68
  | | [payees.update_payee(plan_id, payee_id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeesApi.md#update_payee) | Updates a payee |
68
69
  | **Payee Locations** | [payee_locations.get_payee_locations(plan_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeeLocationsApi.md#get_payee_locations) | Returns all payee locations |
69
70
  | | [payee_locations.get_payee_location_by_id(plan_id, payee_location_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeeLocationsApi.md#get_payee_location_by_id) | Returns a single payee location |
data/docs/Category.md CHANGED
@@ -9,6 +9,7 @@
9
9
  | **category_group_name** | **String** | | [optional] |
10
10
  | **name** | **String** | | |
11
11
  | **hidden** | **Boolean** | Whether or not the category is hidden | |
12
+ | **internal** | **Boolean** | Whether or not the category is internal | |
12
13
  | **original_category_group_id** | **String** | DEPRECATED: No longer used. Value will always be null. | [optional] |
13
14
  | **note** | **String** | | [optional] |
14
15
  | **budgeted** | **Integer** | Assigned (budgeted) amount in milliunits format | |
data/docs/CategoryBase.md CHANGED
@@ -9,6 +9,7 @@
9
9
  | **category_group_name** | **String** | | [optional] |
10
10
  | **name** | **String** | | |
11
11
  | **hidden** | **Boolean** | Whether or not the category is hidden | |
12
+ | **internal** | **Boolean** | Whether or not the category is internal | |
12
13
  | **original_category_group_id** | **String** | DEPRECATED: No longer used. Value will always be null. | [optional] |
13
14
  | **note** | **String** | | [optional] |
14
15
  | **budgeted** | **Integer** | Assigned (budgeted) amount in milliunits format | |
@@ -7,5 +7,6 @@
7
7
  | **id** | **String** | | |
8
8
  | **name** | **String** | | |
9
9
  | **hidden** | **Boolean** | Whether or not the category group is hidden | |
10
+ | **internal** | **Boolean** | Whether or not the category group is internal | |
10
11
  | **deleted** | **Boolean** | Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests. | |
11
12
 
@@ -7,6 +7,7 @@
7
7
  | **id** | **String** | | |
8
8
  | **name** | **String** | | |
9
9
  | **hidden** | **Boolean** | Whether or not the category group is hidden | |
10
+ | **internal** | **Boolean** | Whether or not the category group is internal | |
10
11
  | **deleted** | **Boolean** | Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests. | |
11
12
  | **categories** | [**Array<Category>**](Category.md) | Category group categories. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC). | |
12
13
 
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **name** | **String** | | [optional] |
8
8
  | **note** | **String** | | [optional] |
9
- | **category_group_id** | **String** | | [optional] |
9
+ | **category_group_id** | **String** | The id of the category group to which this category belongs. An internal category group may not be specified. | [optional] |
10
10
  | **goal_target** | **Integer** | The goal target amount in milliunits format. If value is specified and goal has not already been configured for category, a monthly goal will be created for the category with this target amount. If goal_type is not specified, it will default to 'NEED' or 'MF' for Credit Card Payment categories. | [optional] |
11
11
  | **goal_target_date** | **Date** | The goal target date in ISO format (e.g. 2016-12-01). | [optional] |
12
12
  | **goal_needs_whole_amount** | **Boolean** | Whether the goal requires the full target amount each period. Only supported for 'NEED' goals. When true, the goal is configured as 'Set aside another...'. When false, the goal is configured as 'Refill up to...'. | [optional] |
data/docs/NewCategory.md CHANGED
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **name** | **String** | | [optional] |
8
8
  | **note** | **String** | | [optional] |
9
- | **category_group_id** | **String** | | [optional] |
9
+ | **category_group_id** | **String** | The id of the category group to which this category belongs. An internal category group may not be specified. | [optional] |
10
10
  | **goal_target** | **Integer** | The goal target amount in milliunits format. If value is specified and goal has not already been configured for category, a monthly goal will be created for the category with this target amount. If goal_type is not specified, it will default to 'NEED' or 'MF' for Credit Card Payment categories. | [optional] |
11
11
  | **goal_target_date** | **Date** | The goal target date in ISO format (e.g. 2016-12-01). | [optional] |
12
12
  | **goal_needs_whole_amount** | **Boolean** | Whether the goal requires the full target amount each period. Only supported for 'NEED' goals. When true, the goal is configured as 'Set aside another...'. When false, the goal is configured as 'Refill up to...'. | [optional] |
data/docs/SaveCategory.md CHANGED
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **name** | **String** | | [optional] |
8
8
  | **note** | **String** | | [optional] |
9
- | **category_group_id** | **String** | | [optional] |
9
+ | **category_group_id** | **String** | The id of the category group to which this category belongs. An internal category group may not be specified. | [optional] |
10
10
  | **goal_target** | **Integer** | The goal target amount in milliunits format. If value is specified and goal has not already been configured for category, a monthly goal will be created for the category with this target amount. If goal_type is not specified, it will default to 'NEED' or 'MF' for Credit Card Payment categories. | [optional] |
11
11
  | **goal_target_date** | **Date** | The goal target date in ISO format (e.g. 2016-12-01). | [optional] |
12
12
  | **goal_needs_whole_amount** | **Boolean** | Whether the goal requires the full target amount each period. Only supported for 'NEED' goals. When true, the goal is configured as 'Set aside another...'. When false, the goal is configured as 'Refill up to...'. | [optional] |
@@ -7,11 +7,11 @@ All URIs are relative to *https://api.ynab.com/v1*
7
7
  | [**create_transaction**](TransactionsApi.md#create_transaction) | **POST** /plans/{plan_id}/transactions | Create a single transaction or multiple transactions |
8
8
  | [**delete_transaction**](TransactionsApi.md#delete_transaction) | **DELETE** /plans/{plan_id}/transactions/{transaction_id} | Delete a transaction |
9
9
  | [**get_transaction_by_id**](TransactionsApi.md#get_transaction_by_id) | **GET** /plans/{plan_id}/transactions/{transaction_id} | Get a transaction |
10
- | [**get_transactions**](TransactionsApi.md#get_transactions) | **GET** /plans/{plan_id}/transactions | Get all transactions |
11
- | [**get_transactions_by_account**](TransactionsApi.md#get_transactions_by_account) | **GET** /plans/{plan_id}/accounts/{account_id}/transactions | Get all account transactions |
12
- | [**get_transactions_by_category**](TransactionsApi.md#get_transactions_by_category) | **GET** /plans/{plan_id}/categories/{category_id}/transactions | Get all category transactions |
13
- | [**get_transactions_by_month**](TransactionsApi.md#get_transactions_by_month) | **GET** /plans/{plan_id}/months/{month}/transactions | Get all plan month transactions |
14
- | [**get_transactions_by_payee**](TransactionsApi.md#get_transactions_by_payee) | **GET** /plans/{plan_id}/payees/{payee_id}/transactions | Get all payee transactions |
10
+ | [**get_transactions**](TransactionsApi.md#get_transactions) | **GET** /plans/{plan_id}/transactions | Get transactions |
11
+ | [**get_transactions_by_account**](TransactionsApi.md#get_transactions_by_account) | **GET** /plans/{plan_id}/accounts/{account_id}/transactions | Get account transactions |
12
+ | [**get_transactions_by_category**](TransactionsApi.md#get_transactions_by_category) | **GET** /plans/{plan_id}/categories/{category_id}/transactions | Get category transactions |
13
+ | [**get_transactions_by_month**](TransactionsApi.md#get_transactions_by_month) | **GET** /plans/{plan_id}/months/{month}/transactions | Get plan month transactions |
14
+ | [**get_transactions_by_payee**](TransactionsApi.md#get_transactions_by_payee) | **GET** /plans/{plan_id}/payees/{payee_id}/transactions | Get payee transactions |
15
15
  | [**import_transactions**](TransactionsApi.md#import_transactions) | **POST** /plans/{plan_id}/transactions/import | Import transactions |
16
16
  | [**update_transaction**](TransactionsApi.md#update_transaction) | **PUT** /plans/{plan_id}/transactions/{transaction_id} | Update a transaction |
17
17
  | [**update_transactions**](TransactionsApi.md#update_transactions) | **PATCH** /plans/{plan_id}/transactions | Update multiple transactions |
@@ -81,7 +81,7 @@ Returns a single transaction
81
81
 
82
82
  > <TransactionsResponse> get_transactions(plan_id, opts)
83
83
 
84
- Get all transactions
84
+ Get transactions
85
85
 
86
86
  Returns plan transactions, excluding any pending transactions
87
87
 
@@ -90,7 +90,8 @@ Returns plan transactions, excluding any pending transactions
90
90
  | Name | Type | Description | Notes |
91
91
  | ---- | ---- | ----------- | ----- |
92
92
  | **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). | |
93
- | **since_date** | **Date** | If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | [optional] |
93
+ | **since_date** | **Date** | If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). Defaults to one year ago when not specified. | [optional] |
94
+ | **until_date** | **Date** | If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | [optional] |
94
95
  | **type** | **String** | If specified, only transactions of the specified type will be included. \&quot;uncategorized\&quot; and \&quot;unapproved\&quot; are currently supported. | [optional] |
95
96
  | **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] |
96
97
 
@@ -103,7 +104,7 @@ Returns plan transactions, excluding any pending transactions
103
104
 
104
105
  > <TransactionsResponse> get_transactions_by_account(plan_id, account_id, opts)
105
106
 
106
- Get all account transactions
107
+ Get account transactions
107
108
 
108
109
  Returns all transactions for a specified account, excluding any pending transactions
109
110
 
@@ -113,7 +114,8 @@ Returns all transactions for a specified account, excluding any pending transact
113
114
  | ---- | ---- | ----------- | ----- |
114
115
  | **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). | |
115
116
  | **account_id** | **String** | The id of the account | |
116
- | **since_date** | **Date** | If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | [optional] |
117
+ | **since_date** | **Date** | If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). Defaults to one year ago when not specified. | [optional] |
118
+ | **until_date** | **Date** | If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | [optional] |
117
119
  | **type** | **String** | If specified, only transactions of the specified type will be included. \&quot;uncategorized\&quot; and \&quot;unapproved\&quot; are currently supported. | [optional] |
118
120
  | **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] |
119
121
 
@@ -126,7 +128,7 @@ Returns all transactions for a specified account, excluding any pending transact
126
128
 
127
129
  > <HybridTransactionsResponse> get_transactions_by_category(plan_id, category_id, opts)
128
130
 
129
- Get all category transactions
131
+ Get category transactions
130
132
 
131
133
  Returns all transactions for a specified category, excluding any pending transactions
132
134
 
@@ -136,7 +138,8 @@ Returns all transactions for a specified category, excluding any pending transac
136
138
  | ---- | ---- | ----------- | ----- |
137
139
  | **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). | |
138
140
  | **category_id** | **String** | The id of the category | |
139
- | **since_date** | **Date** | If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | [optional] |
141
+ | **since_date** | **Date** | If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). Defaults to one year ago when not specified. | [optional] |
142
+ | **until_date** | **Date** | If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | [optional] |
140
143
  | **type** | **String** | If specified, only transactions of the specified type will be included. \&quot;uncategorized\&quot; and \&quot;unapproved\&quot; are currently supported. | [optional] |
141
144
  | **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] |
142
145
 
@@ -149,7 +152,7 @@ Returns all transactions for a specified category, excluding any pending transac
149
152
 
150
153
  > <TransactionsResponse> get_transactions_by_month(plan_id, month, opts)
151
154
 
152
- Get all plan month transactions
155
+ Get plan month transactions
153
156
 
154
157
  Returns all transactions for a specified month, excluding any pending transactions
155
158
 
@@ -160,6 +163,7 @@ Returns all transactions for a specified month, excluding any pending transactio
160
163
  | **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). | |
161
164
  | **month** | **String** | The plan month in ISO format (e.g. 2016-12-01) (\&quot;current\&quot; can also be used to specify the current calendar month (UTC)) | |
162
165
  | **since_date** | **Date** | If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | [optional] |
166
+ | **until_date** | **Date** | If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | [optional] |
163
167
  | **type** | **String** | If specified, only transactions of the specified type will be included. \&quot;uncategorized\&quot; and \&quot;unapproved\&quot; are currently supported. | [optional] |
164
168
  | **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] |
165
169
 
@@ -172,7 +176,7 @@ Returns all transactions for a specified month, excluding any pending transactio
172
176
 
173
177
  > <HybridTransactionsResponse> get_transactions_by_payee(plan_id, payee_id, opts)
174
178
 
175
- Get all payee transactions
179
+ Get payee transactions
176
180
 
177
181
  Returns all transactions for a specified payee, excluding any pending transactions
178
182
 
@@ -182,7 +186,8 @@ Returns all transactions for a specified payee, excluding any pending transactio
182
186
  | ---- | ---- | ----------- | ----- |
183
187
  | **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). | |
184
188
  | **payee_id** | **String** | The id of the payee | |
185
- | **since_date** | **Date** | If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | [optional] |
189
+ | **since_date** | **Date** | If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). Defaults to one year ago when not specified. | [optional] |
190
+ | **until_date** | **Date** | If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30). | [optional] |
186
191
  | **type** | **String** | If specified, only transactions of the specified type will be included. \&quot;uncategorized\&quot; and \&quot;unapproved\&quot; are currently supported. | [optional] |
187
192
  | **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] |
188
193
 
@@ -227,11 +227,12 @@ module YNAB
227
227
  return data, status_code, headers
228
228
  end
229
229
 
230
- # Get all transactions
230
+ # Get transactions
231
231
  # Returns plan transactions, excluding any pending transactions
232
232
  # @param plan_id [String] The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).
233
233
  # @param [Hash] opts the optional parameters
234
- # @option opts [Date] :since_date If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
234
+ # @option opts [Date] :since_date If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). Defaults to one year ago when not specified.
235
+ # @option opts [Date] :until_date If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
235
236
  # @option opts [String] :type If specified, only transactions of the specified type will be included. \&quot;uncategorized\&quot; and \&quot;unapproved\&quot; are currently supported.
236
237
  # @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included.
237
238
  # @return [TransactionsResponse]
@@ -240,11 +241,12 @@ module YNAB
240
241
  data
241
242
  end
242
243
 
243
- # Get all transactions
244
+ # Get transactions
244
245
  # Returns plan transactions, excluding any pending transactions
245
246
  # @param plan_id [String] The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).
246
247
  # @param [Hash] opts the optional parameters
247
- # @option opts [Date] :since_date If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
248
+ # @option opts [Date] :since_date If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). Defaults to one year ago when not specified.
249
+ # @option opts [Date] :until_date If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
248
250
  # @option opts [String] :type If specified, only transactions of the specified type will be included. \&quot;uncategorized\&quot; and \&quot;unapproved\&quot; are currently supported.
249
251
  # @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included.
250
252
  # @return [Array<(TransactionsResponse, Integer, Hash)>] TransactionsResponse data, response status code and response headers
@@ -262,6 +264,7 @@ module YNAB
262
264
  # query parameters
263
265
  query_params = opts[:query_params] || {}
264
266
  query_params[:'since_date'] = opts[:'since_date'] if !opts[:'since_date'].nil?
267
+ query_params[:'until_date'] = opts[:'until_date'] if !opts[:'until_date'].nil?
265
268
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
266
269
  query_params[:'last_knowledge_of_server'] = opts[:'last_knowledge_of_server'] if !opts[:'last_knowledge_of_server'].nil?
267
270
 
@@ -299,12 +302,13 @@ module YNAB
299
302
  return data, status_code, headers
300
303
  end
301
304
 
302
- # Get all account transactions
305
+ # Get account transactions
303
306
  # Returns all transactions for a specified account, excluding any pending transactions
304
307
  # @param plan_id [String] The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).
305
308
  # @param account_id [String] The id of the account
306
309
  # @param [Hash] opts the optional parameters
307
- # @option opts [Date] :since_date If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
310
+ # @option opts [Date] :since_date If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). Defaults to one year ago when not specified.
311
+ # @option opts [Date] :until_date If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
308
312
  # @option opts [String] :type If specified, only transactions of the specified type will be included. \&quot;uncategorized\&quot; and \&quot;unapproved\&quot; are currently supported.
309
313
  # @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included.
310
314
  # @return [TransactionsResponse]
@@ -313,12 +317,13 @@ module YNAB
313
317
  data
314
318
  end
315
319
 
316
- # Get all account transactions
320
+ # Get account transactions
317
321
  # Returns all transactions for a specified account, excluding any pending transactions
318
322
  # @param plan_id [String] The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).
319
323
  # @param account_id [String] The id of the account
320
324
  # @param [Hash] opts the optional parameters
321
- # @option opts [Date] :since_date If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
325
+ # @option opts [Date] :since_date If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). Defaults to one year ago when not specified.
326
+ # @option opts [Date] :until_date If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
322
327
  # @option opts [String] :type If specified, only transactions of the specified type will be included. \&quot;uncategorized\&quot; and \&quot;unapproved\&quot; are currently supported.
323
328
  # @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included.
324
329
  # @return [Array<(TransactionsResponse, Integer, Hash)>] TransactionsResponse data, response status code and response headers
@@ -340,6 +345,7 @@ module YNAB
340
345
  # query parameters
341
346
  query_params = opts[:query_params] || {}
342
347
  query_params[:'since_date'] = opts[:'since_date'] if !opts[:'since_date'].nil?
348
+ query_params[:'until_date'] = opts[:'until_date'] if !opts[:'until_date'].nil?
343
349
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
344
350
  query_params[:'last_knowledge_of_server'] = opts[:'last_knowledge_of_server'] if !opts[:'last_knowledge_of_server'].nil?
345
351
 
@@ -377,12 +383,13 @@ module YNAB
377
383
  return data, status_code, headers
378
384
  end
379
385
 
380
- # Get all category transactions
386
+ # Get category transactions
381
387
  # Returns all transactions for a specified category, excluding any pending transactions
382
388
  # @param plan_id [String] The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).
383
389
  # @param category_id [String] The id of the category
384
390
  # @param [Hash] opts the optional parameters
385
- # @option opts [Date] :since_date If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
391
+ # @option opts [Date] :since_date If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). Defaults to one year ago when not specified.
392
+ # @option opts [Date] :until_date If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
386
393
  # @option opts [String] :type If specified, only transactions of the specified type will be included. \&quot;uncategorized\&quot; and \&quot;unapproved\&quot; are currently supported.
387
394
  # @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included.
388
395
  # @return [HybridTransactionsResponse]
@@ -391,12 +398,13 @@ module YNAB
391
398
  data
392
399
  end
393
400
 
394
- # Get all category transactions
401
+ # Get category transactions
395
402
  # Returns all transactions for a specified category, excluding any pending transactions
396
403
  # @param plan_id [String] The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).
397
404
  # @param category_id [String] The id of the category
398
405
  # @param [Hash] opts the optional parameters
399
- # @option opts [Date] :since_date If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
406
+ # @option opts [Date] :since_date If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). Defaults to one year ago when not specified.
407
+ # @option opts [Date] :until_date If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
400
408
  # @option opts [String] :type If specified, only transactions of the specified type will be included. \&quot;uncategorized\&quot; and \&quot;unapproved\&quot; are currently supported.
401
409
  # @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included.
402
410
  # @return [Array<(HybridTransactionsResponse, Integer, Hash)>] HybridTransactionsResponse data, response status code and response headers
@@ -418,6 +426,7 @@ module YNAB
418
426
  # query parameters
419
427
  query_params = opts[:query_params] || {}
420
428
  query_params[:'since_date'] = opts[:'since_date'] if !opts[:'since_date'].nil?
429
+ query_params[:'until_date'] = opts[:'until_date'] if !opts[:'until_date'].nil?
421
430
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
422
431
  query_params[:'last_knowledge_of_server'] = opts[:'last_knowledge_of_server'] if !opts[:'last_knowledge_of_server'].nil?
423
432
 
@@ -455,12 +464,13 @@ module YNAB
455
464
  return data, status_code, headers
456
465
  end
457
466
 
458
- # Get all plan month transactions
467
+ # Get plan month transactions
459
468
  # Returns all transactions for a specified month, excluding any pending transactions
460
469
  # @param plan_id [String] The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).
461
470
  # @param month [String] The plan month in ISO format (e.g. 2016-12-01) (\&quot;current\&quot; can also be used to specify the current calendar month (UTC))
462
471
  # @param [Hash] opts the optional parameters
463
472
  # @option opts [Date] :since_date If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
473
+ # @option opts [Date] :until_date If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
464
474
  # @option opts [String] :type If specified, only transactions of the specified type will be included. \&quot;uncategorized\&quot; and \&quot;unapproved\&quot; are currently supported.
465
475
  # @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included.
466
476
  # @return [TransactionsResponse]
@@ -469,12 +479,13 @@ module YNAB
469
479
  data
470
480
  end
471
481
 
472
- # Get all plan month transactions
482
+ # Get plan month transactions
473
483
  # Returns all transactions for a specified month, excluding any pending transactions
474
484
  # @param plan_id [String] The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).
475
485
  # @param month [String] The plan month in ISO format (e.g. 2016-12-01) (\&quot;current\&quot; can also be used to specify the current calendar month (UTC))
476
486
  # @param [Hash] opts the optional parameters
477
487
  # @option opts [Date] :since_date If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
488
+ # @option opts [Date] :until_date If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
478
489
  # @option opts [String] :type If specified, only transactions of the specified type will be included. \&quot;uncategorized\&quot; and \&quot;unapproved\&quot; are currently supported.
479
490
  # @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included.
480
491
  # @return [Array<(TransactionsResponse, Integer, Hash)>] TransactionsResponse data, response status code and response headers
@@ -496,6 +507,7 @@ module YNAB
496
507
  # query parameters
497
508
  query_params = opts[:query_params] || {}
498
509
  query_params[:'since_date'] = opts[:'since_date'] if !opts[:'since_date'].nil?
510
+ query_params[:'until_date'] = opts[:'until_date'] if !opts[:'until_date'].nil?
499
511
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
500
512
  query_params[:'last_knowledge_of_server'] = opts[:'last_knowledge_of_server'] if !opts[:'last_knowledge_of_server'].nil?
501
513
 
@@ -533,12 +545,13 @@ module YNAB
533
545
  return data, status_code, headers
534
546
  end
535
547
 
536
- # Get all payee transactions
548
+ # Get payee transactions
537
549
  # Returns all transactions for a specified payee, excluding any pending transactions
538
550
  # @param plan_id [String] The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).
539
551
  # @param payee_id [String] The id of the payee
540
552
  # @param [Hash] opts the optional parameters
541
- # @option opts [Date] :since_date If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
553
+ # @option opts [Date] :since_date If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). Defaults to one year ago when not specified.
554
+ # @option opts [Date] :until_date If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
542
555
  # @option opts [String] :type If specified, only transactions of the specified type will be included. \&quot;uncategorized\&quot; and \&quot;unapproved\&quot; are currently supported.
543
556
  # @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included.
544
557
  # @return [HybridTransactionsResponse]
@@ -547,12 +560,13 @@ module YNAB
547
560
  data
548
561
  end
549
562
 
550
- # Get all payee transactions
563
+ # Get payee transactions
551
564
  # Returns all transactions for a specified payee, excluding any pending transactions
552
565
  # @param plan_id [String] The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).
553
566
  # @param payee_id [String] The id of the payee
554
567
  # @param [Hash] opts the optional parameters
555
- # @option opts [Date] :since_date If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
568
+ # @option opts [Date] :since_date If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). Defaults to one year ago when not specified.
569
+ # @option opts [Date] :until_date If specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
556
570
  # @option opts [String] :type If specified, only transactions of the specified type will be included. \&quot;uncategorized\&quot; and \&quot;unapproved\&quot; are currently supported.
557
571
  # @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included.
558
572
  # @return [Array<(HybridTransactionsResponse, Integer, Hash)>] HybridTransactionsResponse data, response status code and response headers
@@ -574,6 +588,7 @@ module YNAB
574
588
  # query parameters
575
589
  query_params = opts[:query_params] || {}
576
590
  query_params[:'since_date'] = opts[:'since_date'] if !opts[:'since_date'].nil?
591
+ query_params[:'until_date'] = opts[:'until_date'] if !opts[:'until_date'].nil?
577
592
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
578
593
  query_params[:'last_knowledge_of_server'] = opts[:'last_knowledge_of_server'] if !opts[:'last_knowledge_of_server'].nil?
579
594
 
@@ -23,6 +23,9 @@ module YNAB
23
23
  # Whether or not the category is hidden
24
24
  attr_accessor :hidden
25
25
 
26
+ # Whether or not the category is internal
27
+ attr_accessor :internal
28
+
26
29
  # DEPRECATED: No longer used. Value will always be null.
27
30
  attr_accessor :original_category_group_id
28
31
 
@@ -157,6 +160,7 @@ module YNAB
157
160
  :'category_group_name' => :'category_group_name',
158
161
  :'name' => :'name',
159
162
  :'hidden' => :'hidden',
163
+ :'internal' => :'internal',
160
164
  :'original_category_group_id' => :'original_category_group_id',
161
165
  :'note' => :'note',
162
166
  :'budgeted' => :'budgeted',
@@ -208,6 +212,7 @@ module YNAB
208
212
  :'category_group_name' => :'String',
209
213
  :'name' => :'String',
210
214
  :'hidden' => :'Boolean',
215
+ :'internal' => :'Boolean',
211
216
  :'original_category_group_id' => :'String',
212
217
  :'note' => :'String',
213
218
  :'budgeted' => :'Integer',
@@ -303,6 +308,10 @@ module YNAB
303
308
  self.hidden = attributes[:'hidden']
304
309
  end
305
310
 
311
+ if attributes.key?(:'internal')
312
+ self.internal = attributes[:'internal']
313
+ end
314
+
306
315
  if attributes.key?(:'original_category_group_id')
307
316
  self.original_category_group_id = attributes[:'original_category_group_id']
308
317
  end
@@ -458,6 +467,7 @@ module YNAB
458
467
  return false if @category_group_id.nil?
459
468
  return false if @name.nil?
460
469
  return false if @hidden.nil?
470
+ return false if @internal.nil?
461
471
  return false if @budgeted.nil?
462
472
  return false if @activity.nil?
463
473
  return false if @balance.nil?
@@ -483,6 +493,7 @@ module YNAB
483
493
  category_group_name == o.category_group_name &&
484
494
  name == o.name &&
485
495
  hidden == o.hidden &&
496
+ internal == o.internal &&
486
497
  original_category_group_id == o.original_category_group_id &&
487
498
  note == o.note &&
488
499
  budgeted == o.budgeted &&
@@ -529,7 +540,7 @@ module YNAB
529
540
  # Calculates hash code according to all attributes.
530
541
  # @return [Integer] Hash code
531
542
  def hash
532
- [id, category_group_id, category_group_name, name, hidden, original_category_group_id, note, budgeted, activity, balance, goal_type, goal_needs_whole_amount, goal_day, goal_cadence, goal_cadence_frequency, goal_creation_month, goal_target, goal_target_month, goal_target_date, goal_percentage_complete, goal_months_to_budget, goal_under_funded, goal_overall_funded, goal_overall_left, goal_snoozed_at, deleted, balance_formatted, balance_currency, activity_formatted, activity_currency, budgeted_formatted, budgeted_currency, goal_target_formatted, goal_target_currency, goal_under_funded_formatted, goal_under_funded_currency, goal_overall_funded_formatted, goal_overall_funded_currency, goal_overall_left_formatted, goal_overall_left_currency].hash
543
+ [id, category_group_id, category_group_name, name, hidden, internal, original_category_group_id, note, budgeted, activity, balance, goal_type, goal_needs_whole_amount, goal_day, goal_cadence, goal_cadence_frequency, goal_creation_month, goal_target, goal_target_month, goal_target_date, goal_percentage_complete, goal_months_to_budget, goal_under_funded, goal_overall_funded, goal_overall_left, goal_snoozed_at, deleted, balance_formatted, balance_currency, activity_formatted, activity_currency, budgeted_formatted, budgeted_currency, goal_target_formatted, goal_target_currency, goal_under_funded_formatted, goal_under_funded_currency, goal_overall_funded_formatted, goal_overall_funded_currency, goal_overall_left_formatted, goal_overall_left_currency].hash
533
544
  end
534
545
 
535
546
  # Builds the object from hash
@@ -23,6 +23,9 @@ module YNAB
23
23
  # Whether or not the category is hidden
24
24
  attr_accessor :hidden
25
25
 
26
+ # Whether or not the category is internal
27
+ attr_accessor :internal
28
+
26
29
  # DEPRECATED: No longer used. Value will always be null.
27
30
  attr_accessor :original_category_group_id
28
31
 
@@ -115,6 +118,7 @@ module YNAB
115
118
  :'category_group_name' => :'category_group_name',
116
119
  :'name' => :'name',
117
120
  :'hidden' => :'hidden',
121
+ :'internal' => :'internal',
118
122
  :'original_category_group_id' => :'original_category_group_id',
119
123
  :'note' => :'note',
120
124
  :'budgeted' => :'budgeted',
@@ -152,6 +156,7 @@ module YNAB
152
156
  :'category_group_name' => :'String',
153
157
  :'name' => :'String',
154
158
  :'hidden' => :'Boolean',
159
+ :'internal' => :'Boolean',
155
160
  :'original_category_group_id' => :'String',
156
161
  :'note' => :'String',
157
162
  :'budgeted' => :'Integer',
@@ -234,6 +239,10 @@ module YNAB
234
239
  self.hidden = attributes[:'hidden']
235
240
  end
236
241
 
242
+ if attributes.key?(:'internal')
243
+ self.internal = attributes[:'internal']
244
+ end
245
+
237
246
  if attributes.key?(:'original_category_group_id')
238
247
  self.original_category_group_id = attributes[:'original_category_group_id']
239
248
  end
@@ -333,6 +342,7 @@ module YNAB
333
342
  return false if @category_group_id.nil?
334
343
  return false if @name.nil?
335
344
  return false if @hidden.nil?
345
+ return false if @internal.nil?
336
346
  return false if @budgeted.nil?
337
347
  return false if @activity.nil?
338
348
  return false if @balance.nil?
@@ -358,6 +368,7 @@ module YNAB
358
368
  category_group_name == o.category_group_name &&
359
369
  name == o.name &&
360
370
  hidden == o.hidden &&
371
+ internal == o.internal &&
361
372
  original_category_group_id == o.original_category_group_id &&
362
373
  note == o.note &&
363
374
  budgeted == o.budgeted &&
@@ -390,7 +401,7 @@ module YNAB
390
401
  # Calculates hash code according to all attributes.
391
402
  # @return [Integer] Hash code
392
403
  def hash
393
- [id, category_group_id, category_group_name, name, hidden, original_category_group_id, note, budgeted, activity, balance, goal_type, goal_needs_whole_amount, goal_day, goal_cadence, goal_cadence_frequency, goal_creation_month, goal_target, goal_target_month, goal_target_date, goal_percentage_complete, goal_months_to_budget, goal_under_funded, goal_overall_funded, goal_overall_left, goal_snoozed_at, deleted].hash
404
+ [id, category_group_id, category_group_name, name, hidden, internal, original_category_group_id, note, budgeted, activity, balance, goal_type, goal_needs_whole_amount, goal_day, goal_cadence, goal_cadence_frequency, goal_creation_month, goal_target, goal_target_month, goal_target_date, goal_percentage_complete, goal_months_to_budget, goal_under_funded, goal_overall_funded, goal_overall_left, goal_snoozed_at, deleted].hash
394
405
  end
395
406
 
396
407
  # Builds the object from hash
@@ -19,6 +19,9 @@ module YNAB
19
19
  # Whether or not the category group is hidden
20
20
  attr_accessor :hidden
21
21
 
22
+ # Whether or not the category group is internal
23
+ attr_accessor :internal
24
+
22
25
  # Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests.
23
26
  attr_accessor :deleted
24
27
 
@@ -28,6 +31,7 @@ module YNAB
28
31
  :'id' => :'id',
29
32
  :'name' => :'name',
30
33
  :'hidden' => :'hidden',
34
+ :'internal' => :'internal',
31
35
  :'deleted' => :'deleted'
32
36
  }
33
37
  end
@@ -43,6 +47,7 @@ module YNAB
43
47
  :'id' => :'String',
44
48
  :'name' => :'String',
45
49
  :'hidden' => :'Boolean',
50
+ :'internal' => :'Boolean',
46
51
  :'deleted' => :'Boolean'
47
52
  }
48
53
  end
@@ -80,6 +85,10 @@ module YNAB
80
85
  self.hidden = attributes[:'hidden']
81
86
  end
82
87
 
88
+ if attributes.key?(:'internal')
89
+ self.internal = attributes[:'internal']
90
+ end
91
+
83
92
  if attributes.key?(:'deleted')
84
93
  self.deleted = attributes[:'deleted']
85
94
  end
@@ -98,6 +107,7 @@ module YNAB
98
107
  return false if @id.nil?
99
108
  return false if @name.nil?
100
109
  return false if @hidden.nil?
110
+ return false if @internal.nil?
101
111
  return false if @deleted.nil?
102
112
  true
103
113
  end
@@ -110,6 +120,7 @@ module YNAB
110
120
  id == o.id &&
111
121
  name == o.name &&
112
122
  hidden == o.hidden &&
123
+ internal == o.internal &&
113
124
  deleted == o.deleted
114
125
  end
115
126
 
@@ -122,7 +133,7 @@ module YNAB
122
133
  # Calculates hash code according to all attributes.
123
134
  # @return [Integer] Hash code
124
135
  def hash
125
- [id, name, hidden, deleted].hash
136
+ [id, name, hidden, internal, deleted].hash
126
137
  end
127
138
 
128
139
  # Builds the object from hash
@@ -19,6 +19,9 @@ module YNAB
19
19
  # Whether or not the category group is hidden
20
20
  attr_accessor :hidden
21
21
 
22
+ # Whether or not the category group is internal
23
+ attr_accessor :internal
24
+
22
25
  # Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests.
23
26
  attr_accessor :deleted
24
27
 
@@ -31,6 +34,7 @@ module YNAB
31
34
  :'id' => :'id',
32
35
  :'name' => :'name',
33
36
  :'hidden' => :'hidden',
37
+ :'internal' => :'internal',
34
38
  :'deleted' => :'deleted',
35
39
  :'categories' => :'categories'
36
40
  }
@@ -47,6 +51,7 @@ module YNAB
47
51
  :'id' => :'String',
48
52
  :'name' => :'String',
49
53
  :'hidden' => :'Boolean',
54
+ :'internal' => :'Boolean',
50
55
  :'deleted' => :'Boolean',
51
56
  :'categories' => :'Array<Category>'
52
57
  }
@@ -92,6 +97,10 @@ module YNAB
92
97
  self.hidden = attributes[:'hidden']
93
98
  end
94
99
 
100
+ if attributes.key?(:'internal')
101
+ self.internal = attributes[:'internal']
102
+ end
103
+
95
104
  if attributes.key?(:'deleted')
96
105
  self.deleted = attributes[:'deleted']
97
106
  end
@@ -116,6 +125,7 @@ module YNAB
116
125
  return false if @id.nil?
117
126
  return false if @name.nil?
118
127
  return false if @hidden.nil?
128
+ return false if @internal.nil?
119
129
  return false if @deleted.nil?
120
130
  return false if @categories.nil?
121
131
  true
@@ -129,6 +139,7 @@ module YNAB
129
139
  id == o.id &&
130
140
  name == o.name &&
131
141
  hidden == o.hidden &&
142
+ internal == o.internal &&
132
143
  deleted == o.deleted &&
133
144
  categories == o.categories
134
145
  end
@@ -142,7 +153,7 @@ module YNAB
142
153
  # Calculates hash code according to all attributes.
143
154
  # @return [Integer] Hash code
144
155
  def hash
145
- [id, name, hidden, deleted, categories].hash
156
+ [id, name, hidden, internal, deleted, categories].hash
146
157
  end
147
158
 
148
159
  # Builds the object from hash
@@ -16,6 +16,7 @@ module YNAB
16
16
 
17
17
  attr_accessor :note
18
18
 
19
+ # The id of the category group to which this category belongs. An internal category group may not be specified.
19
20
  attr_accessor :category_group_id
20
21
 
21
22
  # The goal target amount in milliunits format. If value is specified and goal has not already been configured for category, a monthly goal will be created for the category with this target amount. If goal_type is not specified, it will default to 'NEED' or 'MF' for Credit Card Payment categories.
@@ -16,6 +16,7 @@ module YNAB
16
16
 
17
17
  attr_accessor :note
18
18
 
19
+ # The id of the category group to which this category belongs. An internal category group may not be specified.
19
20
  attr_accessor :category_group_id
20
21
 
21
22
  # The goal target amount in milliunits format. If value is specified and goal has not already been configured for category, a monthly goal will be created for the category with this target amount. If goal_type is not specified, it will default to 'NEED' or 'MF' for Credit Card Payment categories.
@@ -16,6 +16,7 @@ module YNAB
16
16
 
17
17
  attr_accessor :note
18
18
 
19
+ # The id of the category group to which this category belongs. An internal category group may not be specified.
19
20
  attr_accessor :category_group_id
20
21
 
21
22
  # The goal target amount in milliunits format. If value is specified and goal has not already been configured for category, a monthly goal will be created for the category with this target amount. If goal_type is not specified, it will default to 'NEED' or 'MF' for Credit Card Payment categories.
data/lib/ynab/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module YNAB
2
- VERSION = '5.1.0'
2
+ VERSION = '5.2.0'
3
3
  end
data/open_api_spec.yaml CHANGED
@@ -5,7 +5,7 @@ info:
5
5
  and relies upon HTTPS for transport. We respond with meaningful HTTP
6
6
  response codes and if an error occurs, we include error details in the
7
7
  response body. API Documentation is at https://api.ynab.com
8
- version: 1.83.0
8
+ version: 1.85.0
9
9
  servers:
10
10
  - url: https://api.ynab.com/v1
11
11
  security:
@@ -1045,7 +1045,7 @@ paths:
1045
1045
  get:
1046
1046
  tags:
1047
1047
  - Transactions
1048
- summary: Get all transactions
1048
+ summary: Get transactions
1049
1049
  description: Returns plan transactions, excluding any pending transactions
1050
1050
  operationId: getTransactions
1051
1051
  parameters:
@@ -1061,6 +1061,14 @@ paths:
1061
1061
  in: query
1062
1062
  description: If specified, only transactions on or after this date will be
1063
1063
  included. The date should be ISO formatted (e.g. 2016-12-30).
1064
+ Defaults to one year ago when not specified.
1065
+ schema:
1066
+ type: string
1067
+ format: date
1068
+ - name: until_date
1069
+ in: query
1070
+ description: If specified, only transactions on or before this date will be
1071
+ included. The date should be ISO formatted (e.g. 2016-12-30).
1064
1072
  schema:
1065
1073
  type: string
1066
1074
  format: date
@@ -1353,7 +1361,7 @@ paths:
1353
1361
  get:
1354
1362
  tags:
1355
1363
  - Transactions
1356
- summary: Get all account transactions
1364
+ summary: Get account transactions
1357
1365
  description: Returns all transactions for a specified account, excluding any
1358
1366
  pending transactions
1359
1367
  operationId: getTransactionsByAccount
@@ -1376,6 +1384,14 @@ paths:
1376
1384
  in: query
1377
1385
  description: If specified, only transactions on or after this date will be
1378
1386
  included. The date should be ISO formatted (e.g. 2016-12-30).
1387
+ Defaults to one year ago when not specified.
1388
+ schema:
1389
+ type: string
1390
+ format: date
1391
+ - name: until_date
1392
+ in: query
1393
+ description: If specified, only transactions on or before this date will be
1394
+ included. The date should be ISO formatted (e.g. 2016-12-30).
1379
1395
  schema:
1380
1396
  type: string
1381
1397
  format: date
@@ -1412,7 +1428,7 @@ paths:
1412
1428
  get:
1413
1429
  tags:
1414
1430
  - Transactions
1415
- summary: Get all category transactions
1431
+ summary: Get category transactions
1416
1432
  description: Returns all transactions for a specified category, excluding any
1417
1433
  pending transactions
1418
1434
  operationId: getTransactionsByCategory
@@ -1435,6 +1451,14 @@ paths:
1435
1451
  in: query
1436
1452
  description: If specified, only transactions on or after this date will be
1437
1453
  included. The date should be ISO formatted (e.g. 2016-12-30).
1454
+ Defaults to one year ago when not specified.
1455
+ schema:
1456
+ type: string
1457
+ format: date
1458
+ - name: until_date
1459
+ in: query
1460
+ description: If specified, only transactions on or before this date will be
1461
+ included. The date should be ISO formatted (e.g. 2016-12-30).
1438
1462
  schema:
1439
1463
  type: string
1440
1464
  format: date
@@ -1471,7 +1495,7 @@ paths:
1471
1495
  get:
1472
1496
  tags:
1473
1497
  - Transactions
1474
- summary: Get all payee transactions
1498
+ summary: Get payee transactions
1475
1499
  description: Returns all transactions for a specified payee, excluding any
1476
1500
  pending transactions
1477
1501
  operationId: getTransactionsByPayee
@@ -1494,6 +1518,14 @@ paths:
1494
1518
  in: query
1495
1519
  description: If specified, only transactions on or after this date will be
1496
1520
  included. The date should be ISO formatted (e.g. 2016-12-30).
1521
+ Defaults to one year ago when not specified.
1522
+ schema:
1523
+ type: string
1524
+ format: date
1525
+ - name: until_date
1526
+ in: query
1527
+ description: If specified, only transactions on or before this date will be
1528
+ included. The date should be ISO formatted (e.g. 2016-12-30).
1497
1529
  schema:
1498
1530
  type: string
1499
1531
  format: date
@@ -1530,7 +1562,7 @@ paths:
1530
1562
  get:
1531
1563
  tags:
1532
1564
  - Transactions
1533
- summary: Get all plan month transactions
1565
+ summary: Get plan month transactions
1534
1566
  description: Returns all transactions for a specified month, excluding any
1535
1567
  pending transactions
1536
1568
  operationId: getTransactionsByMonth
@@ -1557,6 +1589,13 @@ paths:
1557
1589
  schema:
1558
1590
  type: string
1559
1591
  format: date
1592
+ - name: until_date
1593
+ in: query
1594
+ description: If specified, only transactions on or before this date will be
1595
+ included. The date should be ISO formatted (e.g. 2016-12-30).
1596
+ schema:
1597
+ type: string
1598
+ format: date
1560
1599
  - name: type
1561
1600
  in: query
1562
1601
  description: If specified, only transactions of the specified type will be
@@ -2235,6 +2274,7 @@ components:
2235
2274
  required:
2236
2275
  - deleted
2237
2276
  - hidden
2277
+ - internal
2238
2278
  - id
2239
2279
  - name
2240
2280
  type: object
@@ -2247,6 +2287,9 @@ components:
2247
2287
  hidden:
2248
2288
  type: boolean
2249
2289
  description: Whether or not the category group is hidden
2290
+ internal:
2291
+ type: boolean
2292
+ description: Whether or not the category group is internal
2250
2293
  deleted:
2251
2294
  type: boolean
2252
2295
  description: Whether or not the category group has been deleted. Deleted
@@ -2259,6 +2302,7 @@ components:
2259
2302
  - category_group_id
2260
2303
  - deleted
2261
2304
  - hidden
2305
+ - internal
2262
2306
  - id
2263
2307
  - name
2264
2308
  type: object
@@ -2276,6 +2320,9 @@ components:
2276
2320
  hidden:
2277
2321
  type: boolean
2278
2322
  description: Whether or not the category is hidden
2323
+ internal:
2324
+ type: boolean
2325
+ description: Whether or not the category is internal
2279
2326
  original_category_group_id:
2280
2327
  type:
2281
2328
  - string
@@ -3191,6 +3238,7 @@ components:
3191
3238
  category_group_id:
3192
3239
  type: string
3193
3240
  format: uuid
3241
+ description: The id of the category group to which this category belongs. An internal category group may not be specified.
3194
3242
  goal_target:
3195
3243
  type:
3196
3244
  - integer
data/ynab.gemspec CHANGED
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
19
19
  s.email = ["api@ynab.com"]
20
20
  s.homepage = "https://github.com/ynab/ynab-sdk-ruby"
21
21
  s.summary = "Official Ruby client for the YNAB API"
22
- s.description = "Official Ruby client for the YNAB API. API documentation available at https://api.ynab.com. Generated from server specification version 1.83.0."
22
+ s.description = "Official Ruby client for the YNAB API. API documentation available at https://api.ynab.com. Generated from server specification version 1.85.0."
23
23
  s.license = "Apache-2.0"
24
24
  s.required_ruby_version = ">= 3.3"
25
25
  s.metadata = {}
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ynab
3
3
  version: !ruby/object:Gem::Version
4
- version: 5.1.0
4
+ version: 5.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - YNAB
@@ -50,7 +50,7 @@ dependencies:
50
50
  - !ruby/object:Gem::Version
51
51
  version: 3.6.0
52
52
  description: Official Ruby client for the YNAB API. API documentation available at
53
- https://api.ynab.com. Generated from server specification version 1.83.0.
53
+ https://api.ynab.com. Generated from server specification version 1.85.0.
54
54
  email:
55
55
  - api@ynab.com
56
56
  executables: []
@@ -422,7 +422,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
422
422
  - !ruby/object:Gem::Version
423
423
  version: '0'
424
424
  requirements: []
425
- rubygems_version: 4.0.10
425
+ rubygems_version: 4.0.15
426
426
  specification_version: 4
427
427
  summary: Official Ruby client for the YNAB API
428
428
  test_files: