ynab 1.19.0 → 1.20.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/lib/ynab.rb +2 -0
- data/lib/ynab/api/accounts_api.rb +62 -4
- data/lib/ynab/api/budgets_api.rb +4 -4
- data/lib/ynab/api/categories_api.rb +8 -8
- data/lib/ynab/api/deprecated_api.rb +2 -2
- data/lib/ynab/api/months_api.rb +4 -4
- data/lib/ynab/api/payee_locations_api.rb +6 -6
- data/lib/ynab/api/payees_api.rb +4 -4
- data/lib/ynab/api/scheduled_transactions_api.rb +4 -4
- data/lib/ynab/api/transactions_api.rb +18 -18
- data/lib/ynab/models/save_account.rb +250 -0
- data/lib/ynab/models/save_account_wrapper.rb +189 -0
- data/lib/ynab/version.rb +1 -1
- data/spec/api/accounts_spec.rb +19 -10
- data/spec/api/budgets_spec.rb +4 -4
- data/spec/api/categories_spec.rb +5 -5
- data/spec/api/months_spec.rb +4 -4
- data/spec/api/payee_locations_spec.rb +4 -4
- data/spec/api/payees_spec.rb +4 -4
- data/spec/api/scheduled_transactions_spec.rb +4 -4
- data/spec/api/transactions_spec.rb +13 -14
- data/spec/fixtures/vcr_cassettes/create_account.yml +51 -0
- metadata +6 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 50c70c6eb4dfc2f8852ab1668c82c45b3cd4c9b843fbdd60dd7872a2dd1726e0
|
|
4
|
+
data.tar.gz: c942864319a05b4ed45559e48d0dd905878ab37747d17b38f6191dd9ea751cc2
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 90a4be03029b69c7aaf0d4247cc925685e50821c23887a1544d8a5c3cc4ab54ed8cecca07a6140a5f179c5793d4af78b8c2e471588de483ff7cb2a087bb0f5e3
|
|
7
|
+
data.tar.gz: 3eeb6a9bb2dc7eb0d01380e86b999720c900ee3b227c6cd61cb7689ab6c1332b08acbed9f4a708662ec8d4fec6a3a0463533f505abbca9182d6afd072db85114
|
data/lib/ynab.rb
CHANGED
|
@@ -65,6 +65,8 @@ require 'ynab/models/payee_response'
|
|
|
65
65
|
require 'ynab/models/payee_response_data'
|
|
66
66
|
require 'ynab/models/payees_response'
|
|
67
67
|
require 'ynab/models/payees_response_data'
|
|
68
|
+
require 'ynab/models/save_account'
|
|
69
|
+
require 'ynab/models/save_account_wrapper'
|
|
68
70
|
require 'ynab/models/save_category_response'
|
|
69
71
|
require 'ynab/models/save_category_response_data'
|
|
70
72
|
require 'ynab/models/save_month_category'
|
|
@@ -19,9 +19,67 @@ module YNAB
|
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
|
+
# Create a new account
|
|
23
|
+
# Creates a new account.
|
|
24
|
+
# @param budget_id The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget)
|
|
25
|
+
# @param data The account to create.
|
|
26
|
+
# @param [Hash] opts the optional parameters
|
|
27
|
+
# @return [AccountResponse]
|
|
28
|
+
def create_account(budget_id, data, opts = {})
|
|
29
|
+
data, _status_code, _headers = create_account_with_http_info(budget_id, data, opts)
|
|
30
|
+
data
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# Create a new account
|
|
34
|
+
# Creates a new account.
|
|
35
|
+
# @param budget_id The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget)
|
|
36
|
+
# @param data The account to create.
|
|
37
|
+
# @param [Hash] opts the optional parameters
|
|
38
|
+
# @return [Array<(AccountResponse, Fixnum, Hash)>] AccountResponse data, response status code and response headers
|
|
39
|
+
def create_account_with_http_info(budget_id, data, opts = {})
|
|
40
|
+
if @api_client.config.debugging
|
|
41
|
+
@api_client.config.logger.debug 'Calling API: AccountsApi.create_account ...'
|
|
42
|
+
end
|
|
43
|
+
# verify the required parameter 'budget_id' is set
|
|
44
|
+
if @api_client.config.client_side_validation && budget_id.nil?
|
|
45
|
+
fail ArgumentError, "Missing the required parameter 'budget_id' when calling AccountsApi.create_account"
|
|
46
|
+
end
|
|
47
|
+
# verify the required parameter 'data' is set
|
|
48
|
+
if @api_client.config.client_side_validation && data.nil?
|
|
49
|
+
fail ArgumentError, "Missing the required parameter 'data' when calling AccountsApi.create_account"
|
|
50
|
+
end
|
|
51
|
+
# resource path
|
|
52
|
+
local_var_path = '/budgets/{budget_id}/accounts'.sub('{' + 'budget_id' + '}', budget_id.to_s)
|
|
53
|
+
|
|
54
|
+
# query parameters
|
|
55
|
+
query_params = {}
|
|
56
|
+
|
|
57
|
+
# header parameters
|
|
58
|
+
header_params = {}
|
|
59
|
+
# HTTP header 'Accept' (if needed)
|
|
60
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
61
|
+
|
|
62
|
+
# form parameters
|
|
63
|
+
form_params = {}
|
|
64
|
+
|
|
65
|
+
# http body (model)
|
|
66
|
+
post_body = @api_client.object_to_http_body(data)
|
|
67
|
+
auth_names = ['bearer']
|
|
68
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
69
|
+
:header_params => header_params,
|
|
70
|
+
:query_params => query_params,
|
|
71
|
+
:form_params => form_params,
|
|
72
|
+
:body => post_body,
|
|
73
|
+
:auth_names => auth_names,
|
|
74
|
+
:return_type => 'AccountResponse')
|
|
75
|
+
if @api_client.config.debugging
|
|
76
|
+
@api_client.config.logger.debug "API called: AccountsApi#create_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
77
|
+
end
|
|
78
|
+
return data, status_code, headers
|
|
79
|
+
end
|
|
22
80
|
# Single account
|
|
23
81
|
# Returns a single account
|
|
24
|
-
# @param budget_id The id of the budget
|
|
82
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
25
83
|
# @param account_id The id of the account
|
|
26
84
|
# @param [Hash] opts the optional parameters
|
|
27
85
|
# @return [AccountResponse]
|
|
@@ -32,7 +90,7 @@ module YNAB
|
|
|
32
90
|
|
|
33
91
|
# Single account
|
|
34
92
|
# Returns a single account
|
|
35
|
-
# @param budget_id The id of the budget
|
|
93
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
36
94
|
# @param account_id The id of the account
|
|
37
95
|
# @param [Hash] opts the optional parameters
|
|
38
96
|
# @return [Array<(AccountResponse, Fixnum, Hash)>] AccountResponse data, response status code and response headers
|
|
@@ -79,7 +137,7 @@ module YNAB
|
|
|
79
137
|
end
|
|
80
138
|
# Account list
|
|
81
139
|
# Returns all accounts
|
|
82
|
-
# @param budget_id The id of the budget
|
|
140
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
83
141
|
# @param [Hash] opts the optional parameters
|
|
84
142
|
# @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
85
143
|
# @return [AccountsResponse]
|
|
@@ -90,7 +148,7 @@ module YNAB
|
|
|
90
148
|
|
|
91
149
|
# Account list
|
|
92
150
|
# Returns all accounts
|
|
93
|
-
# @param budget_id The id of the budget
|
|
151
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
94
152
|
# @param [Hash] opts the optional parameters
|
|
95
153
|
# @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
96
154
|
# @return [Array<(AccountsResponse, Fixnum, Hash)>] AccountsResponse data, response status code and response headers
|
data/lib/ynab/api/budgets_api.rb
CHANGED
|
@@ -21,7 +21,7 @@ module YNAB
|
|
|
21
21
|
end
|
|
22
22
|
# Single budget
|
|
23
23
|
# Returns a single budget with all related entities. This resource is effectively a full budget export.
|
|
24
|
-
# @param budget_id The id of the budget
|
|
24
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
27
27
|
# @return [BudgetDetailResponse]
|
|
@@ -32,7 +32,7 @@ module YNAB
|
|
|
32
32
|
|
|
33
33
|
# Single budget
|
|
34
34
|
# Returns a single budget with all related entities. This resource is effectively a full budget export.
|
|
35
|
-
# @param budget_id The id of the budget
|
|
35
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
36
36
|
# @param [Hash] opts the optional parameters
|
|
37
37
|
# @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
38
38
|
# @return [Array<(BudgetDetailResponse, Fixnum, Hash)>] BudgetDetailResponse data, response status code and response headers
|
|
@@ -76,7 +76,7 @@ module YNAB
|
|
|
76
76
|
end
|
|
77
77
|
# Budget Settings
|
|
78
78
|
# Returns settings for a budget
|
|
79
|
-
# @param budget_id The id of the budget
|
|
79
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
80
80
|
# @param [Hash] opts the optional parameters
|
|
81
81
|
# @return [BudgetSettingsResponse]
|
|
82
82
|
def get_budget_settings_by_id(budget_id, opts = {})
|
|
@@ -86,7 +86,7 @@ module YNAB
|
|
|
86
86
|
|
|
87
87
|
# Budget Settings
|
|
88
88
|
# Returns settings for a budget
|
|
89
|
-
# @param budget_id The id of the budget
|
|
89
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
90
90
|
# @param [Hash] opts the optional parameters
|
|
91
91
|
# @return [Array<(BudgetSettingsResponse, Fixnum, Hash)>] BudgetSettingsResponse data, response status code and response headers
|
|
92
92
|
def get_budget_settings_by_id_with_http_info(budget_id, opts = {})
|
|
@@ -21,7 +21,7 @@ module YNAB
|
|
|
21
21
|
end
|
|
22
22
|
# List categories
|
|
23
23
|
# Returns all categories grouped by category group. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
|
|
24
|
-
# @param budget_id The id of the budget
|
|
24
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
27
27
|
# @return [CategoriesResponse]
|
|
@@ -32,7 +32,7 @@ module YNAB
|
|
|
32
32
|
|
|
33
33
|
# List categories
|
|
34
34
|
# Returns all categories grouped by category group. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
|
|
35
|
-
# @param budget_id The id of the budget
|
|
35
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
36
36
|
# @param [Hash] opts the optional parameters
|
|
37
37
|
# @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
38
38
|
# @return [Array<(CategoriesResponse, Fixnum, Hash)>] CategoriesResponse data, response status code and response headers
|
|
@@ -76,7 +76,7 @@ module YNAB
|
|
|
76
76
|
end
|
|
77
77
|
# Single category
|
|
78
78
|
# Returns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
|
|
79
|
-
# @param budget_id The id of the budget
|
|
79
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
80
80
|
# @param category_id The id of the category
|
|
81
81
|
# @param [Hash] opts the optional parameters
|
|
82
82
|
# @return [CategoryResponse]
|
|
@@ -87,7 +87,7 @@ module YNAB
|
|
|
87
87
|
|
|
88
88
|
# Single category
|
|
89
89
|
# Returns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
|
|
90
|
-
# @param budget_id The id of the budget
|
|
90
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
91
91
|
# @param category_id The id of the category
|
|
92
92
|
# @param [Hash] opts the optional parameters
|
|
93
93
|
# @return [Array<(CategoryResponse, Fixnum, Hash)>] CategoryResponse data, response status code and response headers
|
|
@@ -134,7 +134,7 @@ module YNAB
|
|
|
134
134
|
end
|
|
135
135
|
# Single category for a specific budget month
|
|
136
136
|
# Returns a single category for a specific budget month. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
|
|
137
|
-
# @param budget_id The id of the budget
|
|
137
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
138
138
|
# @param month The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
|
|
139
139
|
# @param category_id The id of the category
|
|
140
140
|
# @param [Hash] opts the optional parameters
|
|
@@ -146,7 +146,7 @@ module YNAB
|
|
|
146
146
|
|
|
147
147
|
# Single category for a specific budget month
|
|
148
148
|
# Returns a single category for a specific budget month. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
|
|
149
|
-
# @param budget_id The id of the budget
|
|
149
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
150
150
|
# @param month The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
|
|
151
151
|
# @param category_id The id of the category
|
|
152
152
|
# @param [Hash] opts the optional parameters
|
|
@@ -198,7 +198,7 @@ module YNAB
|
|
|
198
198
|
end
|
|
199
199
|
# Update a category for a specific month
|
|
200
200
|
# Update a category for a specific month. Only `budgeted` amount can be updated.
|
|
201
|
-
# @param budget_id The id of the budget
|
|
201
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
202
202
|
# @param month The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
|
|
203
203
|
# @param category_id The id of the category
|
|
204
204
|
# @param data The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored.
|
|
@@ -211,7 +211,7 @@ module YNAB
|
|
|
211
211
|
|
|
212
212
|
# Update a category for a specific month
|
|
213
213
|
# Update a category for a specific month. Only `budgeted` amount can be updated.
|
|
214
|
-
# @param budget_id The id of the budget
|
|
214
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
215
215
|
# @param month The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
|
|
216
216
|
# @param category_id The id of the category
|
|
217
217
|
# @param data The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored.
|
|
@@ -21,7 +21,7 @@ module YNAB
|
|
|
21
21
|
end
|
|
22
22
|
# Bulk create transactions
|
|
23
23
|
# Creates multiple transactions. Although this endpoint is still supported, it is recommended to use 'POST /budgets/{budget_id}/transactions' to create multiple transactions.
|
|
24
|
-
# @param budget_id The id of the budget
|
|
24
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
25
25
|
# @param transactions The list of transactions to create
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
27
27
|
# @return [BulkResponse]
|
|
@@ -32,7 +32,7 @@ module YNAB
|
|
|
32
32
|
|
|
33
33
|
# Bulk create transactions
|
|
34
34
|
# Creates multiple transactions. Although this endpoint is still supported, it is recommended to use 'POST /budgets/{budget_id}/transactions' to create multiple transactions.
|
|
35
|
-
# @param budget_id The id of the budget
|
|
35
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
36
36
|
# @param transactions The list of transactions to create
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
38
38
|
# @return [Array<(BulkResponse, Fixnum, Hash)>] BulkResponse data, response status code and response headers
|
data/lib/ynab/api/months_api.rb
CHANGED
|
@@ -21,7 +21,7 @@ module YNAB
|
|
|
21
21
|
end
|
|
22
22
|
# Single budget month
|
|
23
23
|
# Returns a single budget month
|
|
24
|
-
# @param budget_id The id of the budget
|
|
24
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
25
25
|
# @param month The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
27
27
|
# @return [MonthDetailResponse]
|
|
@@ -32,7 +32,7 @@ module YNAB
|
|
|
32
32
|
|
|
33
33
|
# Single budget month
|
|
34
34
|
# Returns a single budget month
|
|
35
|
-
# @param budget_id The id of the budget
|
|
35
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
36
36
|
# @param month The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
38
38
|
# @return [Array<(MonthDetailResponse, Fixnum, Hash)>] MonthDetailResponse data, response status code and response headers
|
|
@@ -79,7 +79,7 @@ module YNAB
|
|
|
79
79
|
end
|
|
80
80
|
# List budget months
|
|
81
81
|
# Returns all budget months
|
|
82
|
-
# @param budget_id The id of the budget
|
|
82
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
83
83
|
# @param [Hash] opts the optional parameters
|
|
84
84
|
# @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
85
85
|
# @return [MonthSummariesResponse]
|
|
@@ -90,7 +90,7 @@ module YNAB
|
|
|
90
90
|
|
|
91
91
|
# List budget months
|
|
92
92
|
# Returns all budget months
|
|
93
|
-
# @param budget_id The id of the budget
|
|
93
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
94
94
|
# @param [Hash] opts the optional parameters
|
|
95
95
|
# @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
96
96
|
# @return [Array<(MonthSummariesResponse, Fixnum, Hash)>] MonthSummariesResponse data, response status code and response headers
|
|
@@ -21,7 +21,7 @@ module YNAB
|
|
|
21
21
|
end
|
|
22
22
|
# Single payee location
|
|
23
23
|
# Returns a single payee location
|
|
24
|
-
# @param budget_id The id of the budget
|
|
24
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
25
25
|
# @param payee_location_id id of payee location
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
27
27
|
# @return [PayeeLocationResponse]
|
|
@@ -32,7 +32,7 @@ module YNAB
|
|
|
32
32
|
|
|
33
33
|
# Single payee location
|
|
34
34
|
# Returns a single payee location
|
|
35
|
-
# @param budget_id The id of the budget
|
|
35
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
36
36
|
# @param payee_location_id id of payee location
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
38
38
|
# @return [Array<(PayeeLocationResponse, Fixnum, Hash)>] PayeeLocationResponse data, response status code and response headers
|
|
@@ -79,7 +79,7 @@ module YNAB
|
|
|
79
79
|
end
|
|
80
80
|
# List payee locations
|
|
81
81
|
# Returns all payee locations
|
|
82
|
-
# @param budget_id The id of the budget
|
|
82
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
83
83
|
# @param [Hash] opts the optional parameters
|
|
84
84
|
# @return [PayeeLocationsResponse]
|
|
85
85
|
def get_payee_locations(budget_id, opts = {})
|
|
@@ -89,7 +89,7 @@ module YNAB
|
|
|
89
89
|
|
|
90
90
|
# List payee locations
|
|
91
91
|
# Returns all payee locations
|
|
92
|
-
# @param budget_id The id of the budget
|
|
92
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
93
93
|
# @param [Hash] opts the optional parameters
|
|
94
94
|
# @return [Array<(PayeeLocationsResponse, Fixnum, Hash)>] PayeeLocationsResponse data, response status code and response headers
|
|
95
95
|
def get_payee_locations_with_http_info(budget_id, opts = {})
|
|
@@ -131,7 +131,7 @@ module YNAB
|
|
|
131
131
|
end
|
|
132
132
|
# List locations for a payee
|
|
133
133
|
# Returns all payee locations for the specified payee
|
|
134
|
-
# @param budget_id The id of the budget
|
|
134
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
135
135
|
# @param payee_id id of payee
|
|
136
136
|
# @param [Hash] opts the optional parameters
|
|
137
137
|
# @return [PayeeLocationsResponse]
|
|
@@ -142,7 +142,7 @@ module YNAB
|
|
|
142
142
|
|
|
143
143
|
# List locations for a payee
|
|
144
144
|
# Returns all payee locations for the specified payee
|
|
145
|
-
# @param budget_id The id of the budget
|
|
145
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
146
146
|
# @param payee_id id of payee
|
|
147
147
|
# @param [Hash] opts the optional parameters
|
|
148
148
|
# @return [Array<(PayeeLocationsResponse, Fixnum, Hash)>] PayeeLocationsResponse data, response status code and response headers
|
data/lib/ynab/api/payees_api.rb
CHANGED
|
@@ -21,7 +21,7 @@ module YNAB
|
|
|
21
21
|
end
|
|
22
22
|
# Single payee
|
|
23
23
|
# Returns single payee
|
|
24
|
-
# @param budget_id The id of the budget
|
|
24
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
25
25
|
# @param payee_id The id of the payee
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
27
27
|
# @return [PayeeResponse]
|
|
@@ -32,7 +32,7 @@ module YNAB
|
|
|
32
32
|
|
|
33
33
|
# Single payee
|
|
34
34
|
# Returns single payee
|
|
35
|
-
# @param budget_id The id of the budget
|
|
35
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
36
36
|
# @param payee_id The id of the payee
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
38
38
|
# @return [Array<(PayeeResponse, Fixnum, Hash)>] PayeeResponse data, response status code and response headers
|
|
@@ -79,7 +79,7 @@ module YNAB
|
|
|
79
79
|
end
|
|
80
80
|
# List payees
|
|
81
81
|
# Returns all payees
|
|
82
|
-
# @param budget_id The id of the budget
|
|
82
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
83
83
|
# @param [Hash] opts the optional parameters
|
|
84
84
|
# @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
85
85
|
# @return [PayeesResponse]
|
|
@@ -90,7 +90,7 @@ module YNAB
|
|
|
90
90
|
|
|
91
91
|
# List payees
|
|
92
92
|
# Returns all payees
|
|
93
|
-
# @param budget_id The id of the budget
|
|
93
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
94
94
|
# @param [Hash] opts the optional parameters
|
|
95
95
|
# @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
96
96
|
# @return [Array<(PayeesResponse, Fixnum, Hash)>] PayeesResponse data, response status code and response headers
|
|
@@ -21,7 +21,7 @@ module YNAB
|
|
|
21
21
|
end
|
|
22
22
|
# Single scheduled transaction
|
|
23
23
|
# Returns a single scheduled transaction
|
|
24
|
-
# @param budget_id The id of the budget
|
|
24
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
25
25
|
# @param scheduled_transaction_id The id of the scheduled transaction
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
27
27
|
# @return [ScheduledTransactionResponse]
|
|
@@ -32,7 +32,7 @@ module YNAB
|
|
|
32
32
|
|
|
33
33
|
# Single scheduled transaction
|
|
34
34
|
# Returns a single scheduled transaction
|
|
35
|
-
# @param budget_id The id of the budget
|
|
35
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
36
36
|
# @param scheduled_transaction_id The id of the scheduled transaction
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
38
38
|
# @return [Array<(ScheduledTransactionResponse, Fixnum, Hash)>] ScheduledTransactionResponse data, response status code and response headers
|
|
@@ -79,7 +79,7 @@ module YNAB
|
|
|
79
79
|
end
|
|
80
80
|
# List scheduled transactions
|
|
81
81
|
# Returns all scheduled transactions
|
|
82
|
-
# @param budget_id The id of the budget
|
|
82
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
83
83
|
# @param [Hash] opts the optional parameters
|
|
84
84
|
# @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
85
85
|
# @return [ScheduledTransactionsResponse]
|
|
@@ -90,7 +90,7 @@ module YNAB
|
|
|
90
90
|
|
|
91
91
|
# List scheduled transactions
|
|
92
92
|
# Returns all scheduled transactions
|
|
93
|
-
# @param budget_id The id of the budget
|
|
93
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
94
94
|
# @param [Hash] opts the optional parameters
|
|
95
95
|
# @option opts [Integer] :last_knowledge_of_server The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.
|
|
96
96
|
# @return [Array<(ScheduledTransactionsResponse, Fixnum, Hash)>] ScheduledTransactionsResponse data, response status code and response headers
|
|
@@ -21,7 +21,7 @@ module YNAB
|
|
|
21
21
|
end
|
|
22
22
|
# Create a single transaction or multiple transactions
|
|
23
23
|
# Creates a single transaction or multiple transactions. If you provide a body containing a `transaction` object, a single transaction will be created and if you provide a body containing a `transactions` array, multiple transactions will be created. Scheduled transactions cannot be created on this endpoint.
|
|
24
|
-
# @param budget_id The id of the budget
|
|
24
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
25
25
|
# @param data The transaction or transactions to create. To create a single transaction you can specify a value for the `transaction` object and to create multiple transactions you can specify an array of `transactions`. It is expected that you will only provide a value for one of these objects.
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
27
27
|
# @return [SaveTransactionsResponse]
|
|
@@ -32,7 +32,7 @@ module YNAB
|
|
|
32
32
|
|
|
33
33
|
# Create a single transaction or multiple transactions
|
|
34
34
|
# Creates a single transaction or multiple transactions. If you provide a body containing a `transaction` object, a single transaction will be created and if you provide a body containing a `transactions` array, multiple transactions will be created. Scheduled transactions cannot be created on this endpoint.
|
|
35
|
-
# @param budget_id The id of the budget
|
|
35
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
36
36
|
# @param data The transaction or transactions to create. To create a single transaction you can specify a value for the `transaction` object and to create multiple transactions you can specify an array of `transactions`. It is expected that you will only provide a value for one of these objects.
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
38
38
|
# @return [Array<(SaveTransactionsResponse, Fixnum, Hash)>] SaveTransactionsResponse data, response status code and response headers
|
|
@@ -79,7 +79,7 @@ module YNAB
|
|
|
79
79
|
end
|
|
80
80
|
# Single transaction
|
|
81
81
|
# Returns a single transaction
|
|
82
|
-
# @param budget_id The id of the budget
|
|
82
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
83
83
|
# @param transaction_id The id of the transaction
|
|
84
84
|
# @param [Hash] opts the optional parameters
|
|
85
85
|
# @return [TransactionResponse]
|
|
@@ -90,7 +90,7 @@ module YNAB
|
|
|
90
90
|
|
|
91
91
|
# Single transaction
|
|
92
92
|
# Returns a single transaction
|
|
93
|
-
# @param budget_id The id of the budget
|
|
93
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
94
94
|
# @param transaction_id The id of the transaction
|
|
95
95
|
# @param [Hash] opts the optional parameters
|
|
96
96
|
# @return [Array<(TransactionResponse, Fixnum, Hash)>] TransactionResponse data, response status code and response headers
|
|
@@ -137,7 +137,7 @@ module YNAB
|
|
|
137
137
|
end
|
|
138
138
|
# List transactions
|
|
139
139
|
# Returns budget transactions
|
|
140
|
-
# @param budget_id The id of the budget
|
|
140
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
141
141
|
# @param [Hash] opts the optional parameters
|
|
142
142
|
# @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).
|
|
143
143
|
# @option opts [String] :type If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.
|
|
@@ -150,7 +150,7 @@ module YNAB
|
|
|
150
150
|
|
|
151
151
|
# List transactions
|
|
152
152
|
# Returns budget transactions
|
|
153
|
-
# @param budget_id The id of the budget
|
|
153
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
154
154
|
# @param [Hash] opts the optional parameters
|
|
155
155
|
# @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).
|
|
156
156
|
# @option opts [String] :type If specified, only transactions of the specified type will be included. \"uncategorized\" and \"unapproved\" are currently supported.
|
|
@@ -201,7 +201,7 @@ module YNAB
|
|
|
201
201
|
end
|
|
202
202
|
# List account transactions
|
|
203
203
|
# Returns all transactions for a specified account
|
|
204
|
-
# @param budget_id The id of the budget
|
|
204
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
205
205
|
# @param account_id The id of the account
|
|
206
206
|
# @param [Hash] opts the optional parameters
|
|
207
207
|
# @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).
|
|
@@ -215,7 +215,7 @@ module YNAB
|
|
|
215
215
|
|
|
216
216
|
# List account transactions
|
|
217
217
|
# Returns all transactions for a specified account
|
|
218
|
-
# @param budget_id The id of the budget
|
|
218
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
219
219
|
# @param account_id The id of the account
|
|
220
220
|
# @param [Hash] opts the optional parameters
|
|
221
221
|
# @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).
|
|
@@ -271,7 +271,7 @@ module YNAB
|
|
|
271
271
|
end
|
|
272
272
|
# List category transactions
|
|
273
273
|
# Returns all transactions for a specified category
|
|
274
|
-
# @param budget_id The id of the budget
|
|
274
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
275
275
|
# @param category_id The id of the category
|
|
276
276
|
# @param [Hash] opts the optional parameters
|
|
277
277
|
# @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).
|
|
@@ -285,7 +285,7 @@ module YNAB
|
|
|
285
285
|
|
|
286
286
|
# List category transactions
|
|
287
287
|
# Returns all transactions for a specified category
|
|
288
|
-
# @param budget_id The id of the budget
|
|
288
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
289
289
|
# @param category_id The id of the category
|
|
290
290
|
# @param [Hash] opts the optional parameters
|
|
291
291
|
# @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).
|
|
@@ -341,7 +341,7 @@ module YNAB
|
|
|
341
341
|
end
|
|
342
342
|
# List payee transactions
|
|
343
343
|
# Returns all transactions for a specified payee
|
|
344
|
-
# @param budget_id The id of the budget
|
|
344
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
345
345
|
# @param payee_id The id of the payee
|
|
346
346
|
# @param [Hash] opts the optional parameters
|
|
347
347
|
# @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).
|
|
@@ -355,7 +355,7 @@ module YNAB
|
|
|
355
355
|
|
|
356
356
|
# List payee transactions
|
|
357
357
|
# Returns all transactions for a specified payee
|
|
358
|
-
# @param budget_id The id of the budget
|
|
358
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
359
359
|
# @param payee_id The id of the payee
|
|
360
360
|
# @param [Hash] opts the optional parameters
|
|
361
361
|
# @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).
|
|
@@ -411,7 +411,7 @@ module YNAB
|
|
|
411
411
|
end
|
|
412
412
|
# Import transactions
|
|
413
413
|
# Imports transactions.
|
|
414
|
-
# @param budget_id The id of the budget
|
|
414
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
415
415
|
# @param [Hash] opts the optional parameters
|
|
416
416
|
# @return [TransactionsImportResponse]
|
|
417
417
|
def import_transactions(budget_id, opts = {})
|
|
@@ -421,7 +421,7 @@ module YNAB
|
|
|
421
421
|
|
|
422
422
|
# Import transactions
|
|
423
423
|
# Imports transactions.
|
|
424
|
-
# @param budget_id The id of the budget
|
|
424
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
425
425
|
# @param [Hash] opts the optional parameters
|
|
426
426
|
# @return [Array<(TransactionsImportResponse, Fixnum, Hash)>] TransactionsImportResponse data, response status code and response headers
|
|
427
427
|
def import_transactions_with_http_info(budget_id, opts = {})
|
|
@@ -463,7 +463,7 @@ module YNAB
|
|
|
463
463
|
end
|
|
464
464
|
# Updates an existing transaction
|
|
465
465
|
# Updates a transaction
|
|
466
|
-
# @param budget_id The id of the budget
|
|
466
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
467
467
|
# @param transaction_id The id of the transaction
|
|
468
468
|
# @param data The transaction to update
|
|
469
469
|
# @param [Hash] opts the optional parameters
|
|
@@ -475,7 +475,7 @@ module YNAB
|
|
|
475
475
|
|
|
476
476
|
# Updates an existing transaction
|
|
477
477
|
# Updates a transaction
|
|
478
|
-
# @param budget_id The id of the budget
|
|
478
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
479
479
|
# @param transaction_id The id of the transaction
|
|
480
480
|
# @param data The transaction to update
|
|
481
481
|
# @param [Hash] opts the optional parameters
|
|
@@ -527,7 +527,7 @@ module YNAB
|
|
|
527
527
|
end
|
|
528
528
|
# Update multiple transactions
|
|
529
529
|
# Updates multiple transactions, by `id` or `import_id`.
|
|
530
|
-
# @param budget_id The id of the budget
|
|
530
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
531
531
|
# @param data The transactions to update. Each transaction must have either an `id` or `import_id` specified. If `id` is specified as null an `import_id` value can be provided which will allow transaction(s) to be updated by their `import_id`. If an `id` is specified, it will always be used for lookup.
|
|
532
532
|
# @param [Hash] opts the optional parameters
|
|
533
533
|
# @return [SaveTransactionsResponse]
|
|
@@ -538,7 +538,7 @@ module YNAB
|
|
|
538
538
|
|
|
539
539
|
# Update multiple transactions
|
|
540
540
|
# Updates multiple transactions, by `id` or `import_id`.
|
|
541
|
-
# @param budget_id The id of the budget
|
|
541
|
+
# @param budget_id The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
|
|
542
542
|
# @param data The transactions to update. Each transaction must have either an `id` or `import_id` specified. If `id` is specified as null an `import_id` value can be provided which will allow transaction(s) to be updated by their `import_id`. If an `id` is specified, it will always be used for lookup.
|
|
543
543
|
# @param [Hash] opts the optional parameters
|
|
544
544
|
# @return [Array<(SaveTransactionsResponse, Fixnum, Hash)>] SaveTransactionsResponse data, response status code and response headers
|