ynab 0.6.0 → 0.7.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.
Files changed (98) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +24 -24
  4. data/Rakefile +1 -1
  5. data/config.json +1 -1
  6. data/docs/AccountsApi.md +0 -76
  7. data/docs/BudgetsApi.md +0 -74
  8. data/docs/CategoriesApi.md +0 -76
  9. data/docs/CurrencyFormat.md +8 -1
  10. data/docs/DateFormat.md +1 -1
  11. data/docs/HybridTransaction.md +3 -0
  12. data/docs/MonthsApi.md +0 -76
  13. data/docs/PayeeLocationsApi.md +0 -115
  14. data/docs/PayeesApi.md +0 -76
  15. data/docs/ScheduledTransactionsApi.md +0 -76
  16. data/docs/TransactionsApi.md +0 -325
  17. data/docs/UserApi.md +0 -34
  18. data/lib/ynab/api/accounts_api.rb +8 -10
  19. data/lib/ynab/api/budgets_api.rb +8 -10
  20. data/lib/ynab/api/categories_api.rb +8 -10
  21. data/lib/ynab/api/months_api.rb +8 -10
  22. data/lib/ynab/api/payee_locations_api.rb +11 -14
  23. data/lib/ynab/api/payees_api.rb +8 -10
  24. data/lib/ynab/api/scheduled_transactions_api.rb +8 -10
  25. data/lib/ynab/api/transactions_api.rb +26 -34
  26. data/lib/ynab/api/user_api.rb +5 -6
  27. data/lib/ynab/api_client.rb +1 -1
  28. data/lib/ynab/api_error.rb +1 -1
  29. data/lib/ynab/configuration.rb +2 -2
  30. data/lib/ynab/models/account.rb +18 -22
  31. data/lib/ynab/models/account_response.rb +7 -12
  32. data/lib/ynab/models/account_wrapper.rb +7 -12
  33. data/lib/ynab/models/accounts_response.rb +7 -12
  34. data/lib/ynab/models/accounts_wrapper.rb +7 -12
  35. data/lib/ynab/models/budget_detail.rb +8 -13
  36. data/lib/ynab/models/budget_detail_response.rb +7 -12
  37. data/lib/ynab/models/budget_detail_wrapper.rb +8 -13
  38. data/lib/ynab/models/budget_summary.rb +8 -13
  39. data/lib/ynab/models/budget_summary_response.rb +7 -12
  40. data/lib/ynab/models/budget_summary_wrapper.rb +7 -12
  41. data/lib/ynab/models/bulk_id_wrapper.rb +7 -12
  42. data/lib/ynab/models/bulk_ids.rb +8 -13
  43. data/lib/ynab/models/bulk_response.rb +7 -12
  44. data/lib/ynab/models/bulk_transactions.rb +7 -12
  45. data/lib/ynab/models/categories_response.rb +7 -12
  46. data/lib/ynab/models/category.rb +14 -19
  47. data/lib/ynab/models/category_group.rb +9 -14
  48. data/lib/ynab/models/category_group_with_categories.rb +10 -15
  49. data/lib/ynab/models/category_groups_wrapper.rb +7 -12
  50. data/lib/ynab/models/category_response.rb +7 -12
  51. data/lib/ynab/models/category_wrapper.rb +7 -12
  52. data/lib/ynab/models/currency_format.rb +112 -19
  53. data/lib/ynab/models/date_format.rb +16 -21
  54. data/lib/ynab/models/error_detail.rb +9 -14
  55. data/lib/ynab/models/error_response.rb +7 -12
  56. data/lib/ynab/models/hybrid_transaction.rb +74 -36
  57. data/lib/ynab/models/hybrid_transactions_response.rb +7 -12
  58. data/lib/ynab/models/hybrid_transactions_wrapper.rb +7 -12
  59. data/lib/ynab/models/month_detail.rb +11 -16
  60. data/lib/ynab/models/month_detail_response.rb +7 -12
  61. data/lib/ynab/models/month_detail_wrapper.rb +7 -12
  62. data/lib/ynab/models/month_summaries_response.rb +7 -12
  63. data/lib/ynab/models/month_summaries_wrapper.rb +7 -12
  64. data/lib/ynab/models/month_summary.rb +10 -15
  65. data/lib/ynab/models/payee.rb +9 -14
  66. data/lib/ynab/models/payee_location.rb +10 -15
  67. data/lib/ynab/models/payee_location_response.rb +7 -12
  68. data/lib/ynab/models/payee_location_wrapper.rb +7 -12
  69. data/lib/ynab/models/payee_locations_response.rb +7 -12
  70. data/lib/ynab/models/payee_locations_wrapper.rb +7 -12
  71. data/lib/ynab/models/payee_response.rb +7 -12
  72. data/lib/ynab/models/payee_wrapper.rb +7 -12
  73. data/lib/ynab/models/payees_response.rb +7 -12
  74. data/lib/ynab/models/payees_wrapper.rb +7 -12
  75. data/lib/ynab/models/save_transaction.rb +15 -19
  76. data/lib/ynab/models/save_transaction_wrapper.rb +7 -12
  77. data/lib/ynab/models/scheduled_sub_transaction.rb +13 -18
  78. data/lib/ynab/models/scheduled_transaction_detail.rb +27 -31
  79. data/lib/ynab/models/scheduled_transaction_response.rb +7 -12
  80. data/lib/ynab/models/scheduled_transaction_summary.rb +23 -27
  81. data/lib/ynab/models/scheduled_transaction_wrapper.rb +7 -12
  82. data/lib/ynab/models/scheduled_transactions_response.rb +7 -12
  83. data/lib/ynab/models/scheduled_transactions_wrapper.rb +7 -12
  84. data/lib/ynab/models/sub_transaction.rb +13 -18
  85. data/lib/ynab/models/transaction_detail.rb +28 -32
  86. data/lib/ynab/models/transaction_response.rb +7 -12
  87. data/lib/ynab/models/transaction_summary.rb +24 -28
  88. data/lib/ynab/models/transaction_wrapper.rb +7 -12
  89. data/lib/ynab/models/transactions_response.rb +7 -12
  90. data/lib/ynab/models/transactions_wrapper.rb +7 -12
  91. data/lib/ynab/models/user.rb +7 -12
  92. data/lib/ynab/models/user_response.rb +7 -12
  93. data/lib/ynab/models/user_wrapper.rb +7 -12
  94. data/lib/ynab/version.rb +2 -2
  95. data/spec-v1-swagger.json +50 -5
  96. data/swagger-templates/api_doc.mustache +32 -0
  97. data/ynab.gemspec +1 -1
  98. metadata +4 -3
@@ -16,34 +16,6 @@ Single payee location
16
16
 
17
17
  Returns a single payee location
18
18
 
19
- ### Example
20
- ```ruby
21
- # load the gem
22
- require 'ynab'
23
- # setup authorization
24
- YnabApi.configure do |config|
25
- # Configure API key authorization: bearer
26
- config.api_key['Authorization'] = 'YOUR API KEY'
27
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
28
- #config.api_key_prefix['Authorization'] = 'Bearer'
29
- end
30
-
31
- api_instance = YnabApi::PayeeLocationsApi.new
32
-
33
- budget_id = "budget_id_example" # String | The ID of the Budget.
34
-
35
- payee_location_id = "payee_location_id_example" # String | ID of payee location
36
-
37
-
38
- begin
39
- #Single payee location
40
- result = api_instance.get_payee_location_by_id(budget_id, payee_location_id)
41
- p result
42
- rescue YnabApi::ApiError => e
43
- puts "Exception when calling PayeeLocationsApi->get_payee_location_by_id: #{e}"
44
- end
45
- ```
46
-
47
19
  ### Parameters
48
20
 
49
21
  Name | Type | Description | Notes
@@ -55,17 +27,6 @@ Name | Type | Description | Notes
55
27
 
56
28
  [**PayeeLocationResponse**](PayeeLocationResponse.md)
57
29
 
58
- ### Authorization
59
-
60
- [bearer](../README.md#bearer)
61
-
62
- ### HTTP request headers
63
-
64
- - **Content-Type**: Not defined
65
- - **Accept**: application/json
66
-
67
-
68
-
69
30
  # **get_payee_locations**
70
31
  > PayeeLocationsResponse get_payee_locations(budget_id)
71
32
 
@@ -73,32 +34,6 @@ List payee locations
73
34
 
74
35
  Returns all payee locations
75
36
 
76
- ### Example
77
- ```ruby
78
- # load the gem
79
- require 'ynab'
80
- # setup authorization
81
- YnabApi.configure do |config|
82
- # Configure API key authorization: bearer
83
- config.api_key['Authorization'] = 'YOUR API KEY'
84
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
85
- #config.api_key_prefix['Authorization'] = 'Bearer'
86
- end
87
-
88
- api_instance = YnabApi::PayeeLocationsApi.new
89
-
90
- budget_id = "budget_id_example" # String | The ID of the Budget.
91
-
92
-
93
- begin
94
- #List payee locations
95
- result = api_instance.get_payee_locations(budget_id)
96
- p result
97
- rescue YnabApi::ApiError => e
98
- puts "Exception when calling PayeeLocationsApi->get_payee_locations: #{e}"
99
- end
100
- ```
101
-
102
37
  ### Parameters
103
38
 
104
39
  Name | Type | Description | Notes
@@ -109,17 +44,6 @@ Name | Type | Description | Notes
109
44
 
110
45
  [**PayeeLocationsResponse**](PayeeLocationsResponse.md)
111
46
 
112
- ### Authorization
113
-
114
- [bearer](../README.md#bearer)
115
-
116
- ### HTTP request headers
117
-
118
- - **Content-Type**: Not defined
119
- - **Accept**: application/json
120
-
121
-
122
-
123
47
  # **get_payee_locations_by_payee**
124
48
  > PayeeLocationsResponse get_payee_locations_by_payee(budget_id, payee_id)
125
49
 
@@ -127,34 +51,6 @@ List locations for a payee
127
51
 
128
52
  Returns all payee locations for the specified payee
129
53
 
130
- ### Example
131
- ```ruby
132
- # load the gem
133
- require 'ynab'
134
- # setup authorization
135
- YnabApi.configure do |config|
136
- # Configure API key authorization: bearer
137
- config.api_key['Authorization'] = 'YOUR API KEY'
138
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
139
- #config.api_key_prefix['Authorization'] = 'Bearer'
140
- end
141
-
142
- api_instance = YnabApi::PayeeLocationsApi.new
143
-
144
- budget_id = "budget_id_example" # String | The ID of the Budget.
145
-
146
- payee_id = "payee_id_example" # String | ID of payee
147
-
148
-
149
- begin
150
- #List locations for a payee
151
- result = api_instance.get_payee_locations_by_payee(budget_id, payee_id)
152
- p result
153
- rescue YnabApi::ApiError => e
154
- puts "Exception when calling PayeeLocationsApi->get_payee_locations_by_payee: #{e}"
155
- end
156
- ```
157
-
158
54
  ### Parameters
159
55
 
160
56
  Name | Type | Description | Notes
@@ -166,14 +62,3 @@ Name | Type | Description | Notes
166
62
 
167
63
  [**PayeeLocationsResponse**](PayeeLocationsResponse.md)
168
64
 
169
- ### Authorization
170
-
171
- [bearer](../README.md#bearer)
172
-
173
- ### HTTP request headers
174
-
175
- - **Content-Type**: Not defined
176
- - **Accept**: application/json
177
-
178
-
179
-
@@ -15,34 +15,6 @@ Single payee
15
15
 
16
16
  Returns single payee
17
17
 
18
- ### Example
19
- ```ruby
20
- # load the gem
21
- require 'ynab'
22
- # setup authorization
23
- YnabApi.configure do |config|
24
- # Configure API key authorization: bearer
25
- config.api_key['Authorization'] = 'YOUR API KEY'
26
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
27
- #config.api_key_prefix['Authorization'] = 'Bearer'
28
- end
29
-
30
- api_instance = YnabApi::PayeesApi.new
31
-
32
- budget_id = "budget_id_example" # String | The ID of the Budget.
33
-
34
- payee_id = "payee_id_example" # String | The ID of the Payee.
35
-
36
-
37
- begin
38
- #Single payee
39
- result = api_instance.get_payee_by_id(budget_id, payee_id)
40
- p result
41
- rescue YnabApi::ApiError => e
42
- puts "Exception when calling PayeesApi->get_payee_by_id: #{e}"
43
- end
44
- ```
45
-
46
18
  ### Parameters
47
19
 
48
20
  Name | Type | Description | Notes
@@ -54,17 +26,6 @@ Name | Type | Description | Notes
54
26
 
55
27
  [**PayeeResponse**](PayeeResponse.md)
56
28
 
57
- ### Authorization
58
-
59
- [bearer](../README.md#bearer)
60
-
61
- ### HTTP request headers
62
-
63
- - **Content-Type**: Not defined
64
- - **Accept**: application/json
65
-
66
-
67
-
68
29
  # **get_payees**
69
30
  > PayeesResponse get_payees(budget_id)
70
31
 
@@ -72,32 +33,6 @@ List payees
72
33
 
73
34
  Returns all payees
74
35
 
75
- ### Example
76
- ```ruby
77
- # load the gem
78
- require 'ynab'
79
- # setup authorization
80
- YnabApi.configure do |config|
81
- # Configure API key authorization: bearer
82
- config.api_key['Authorization'] = 'YOUR API KEY'
83
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
84
- #config.api_key_prefix['Authorization'] = 'Bearer'
85
- end
86
-
87
- api_instance = YnabApi::PayeesApi.new
88
-
89
- budget_id = "budget_id_example" # String | The ID of the Budget.
90
-
91
-
92
- begin
93
- #List payees
94
- result = api_instance.get_payees(budget_id)
95
- p result
96
- rescue YnabApi::ApiError => e
97
- puts "Exception when calling PayeesApi->get_payees: #{e}"
98
- end
99
- ```
100
-
101
36
  ### Parameters
102
37
 
103
38
  Name | Type | Description | Notes
@@ -108,14 +43,3 @@ Name | Type | Description | Notes
108
43
 
109
44
  [**PayeesResponse**](PayeesResponse.md)
110
45
 
111
- ### Authorization
112
-
113
- [bearer](../README.md#bearer)
114
-
115
- ### HTTP request headers
116
-
117
- - **Content-Type**: Not defined
118
- - **Accept**: application/json
119
-
120
-
121
-
@@ -15,34 +15,6 @@ Single scheduled transaction
15
15
 
16
16
  Returns a single scheduled transaction
17
17
 
18
- ### Example
19
- ```ruby
20
- # load the gem
21
- require 'ynab'
22
- # setup authorization
23
- YnabApi.configure do |config|
24
- # Configure API key authorization: bearer
25
- config.api_key['Authorization'] = 'YOUR API KEY'
26
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
27
- #config.api_key_prefix['Authorization'] = 'Bearer'
28
- end
29
-
30
- api_instance = YnabApi::ScheduledTransactionsApi.new
31
-
32
- budget_id = "budget_id_example" # String | The ID of the Budget.
33
-
34
- scheduled_transaction_id = "scheduled_transaction_id_example" # String | The ID of the Scheduled Transaction.
35
-
36
-
37
- begin
38
- #Single scheduled transaction
39
- result = api_instance.get_scheduled_transaction_by_id(budget_id, scheduled_transaction_id)
40
- p result
41
- rescue YnabApi::ApiError => e
42
- puts "Exception when calling ScheduledTransactionsApi->get_scheduled_transaction_by_id: #{e}"
43
- end
44
- ```
45
-
46
18
  ### Parameters
47
19
 
48
20
  Name | Type | Description | Notes
@@ -54,17 +26,6 @@ Name | Type | Description | Notes
54
26
 
55
27
  [**ScheduledTransactionResponse**](ScheduledTransactionResponse.md)
56
28
 
57
- ### Authorization
58
-
59
- [bearer](../README.md#bearer)
60
-
61
- ### HTTP request headers
62
-
63
- - **Content-Type**: Not defined
64
- - **Accept**: application/json
65
-
66
-
67
-
68
29
  # **get_scheduled_transactions**
69
30
  > ScheduledTransactionsResponse get_scheduled_transactions(budget_id)
70
31
 
@@ -72,32 +33,6 @@ List scheduled transactions
72
33
 
73
34
  Returns all scheduled transactions
74
35
 
75
- ### Example
76
- ```ruby
77
- # load the gem
78
- require 'ynab'
79
- # setup authorization
80
- YnabApi.configure do |config|
81
- # Configure API key authorization: bearer
82
- config.api_key['Authorization'] = 'YOUR API KEY'
83
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
84
- #config.api_key_prefix['Authorization'] = 'Bearer'
85
- end
86
-
87
- api_instance = YnabApi::ScheduledTransactionsApi.new
88
-
89
- budget_id = "budget_id_example" # String | The ID of the Budget.
90
-
91
-
92
- begin
93
- #List scheduled transactions
94
- result = api_instance.get_scheduled_transactions(budget_id)
95
- p result
96
- rescue YnabApi::ApiError => e
97
- puts "Exception when calling ScheduledTransactionsApi->get_scheduled_transactions: #{e}"
98
- end
99
- ```
100
-
101
36
  ### Parameters
102
37
 
103
38
  Name | Type | Description | Notes
@@ -108,14 +43,3 @@ Name | Type | Description | Notes
108
43
 
109
44
  [**ScheduledTransactionsResponse**](ScheduledTransactionsResponse.md)
110
45
 
111
- ### Authorization
112
-
113
- [bearer](../README.md#bearer)
114
-
115
- ### HTTP request headers
116
-
117
- - **Content-Type**: Not defined
118
- - **Accept**: application/json
119
-
120
-
121
-
@@ -21,34 +21,6 @@ Bulk create transactions
21
21
 
22
22
  Creates multiple transactions
23
23
 
24
- ### Example
25
- ```ruby
26
- # load the gem
27
- require 'ynab'
28
- # setup authorization
29
- YnabApi.configure do |config|
30
- # Configure API key authorization: bearer
31
- config.api_key['Authorization'] = 'YOUR API KEY'
32
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
33
- #config.api_key_prefix['Authorization'] = 'Bearer'
34
- end
35
-
36
- api_instance = YnabApi::TransactionsApi.new
37
-
38
- budget_id = "budget_id_example" # String | The ID of the Budget.
39
-
40
- transactions = YnabApi::BulkTransactions.new # BulkTransactions | The list of Transactions to create.
41
-
42
-
43
- begin
44
- #Bulk create transactions
45
- result = api_instance.bulk_create_transactions(budget_id, transactions)
46
- p result
47
- rescue YnabApi::ApiError => e
48
- puts "Exception when calling TransactionsApi->bulk_create_transactions: #{e}"
49
- end
50
- ```
51
-
52
24
  ### Parameters
53
25
 
54
26
  Name | Type | Description | Notes
@@ -60,17 +32,6 @@ Name | Type | Description | Notes
60
32
 
61
33
  [**BulkResponse**](BulkResponse.md)
62
34
 
63
- ### Authorization
64
-
65
- [bearer](../README.md#bearer)
66
-
67
- ### HTTP request headers
68
-
69
- - **Content-Type**: Not defined
70
- - **Accept**: application/json
71
-
72
-
73
-
74
35
  # **create_transaction**
75
36
  > TransactionResponse create_transaction(budget_id, transaction)
76
37
 
@@ -78,34 +39,6 @@ Create new transaction
78
39
 
79
40
  Creates a transaction
80
41
 
81
- ### Example
82
- ```ruby
83
- # load the gem
84
- require 'ynab'
85
- # setup authorization
86
- YnabApi.configure do |config|
87
- # Configure API key authorization: bearer
88
- config.api_key['Authorization'] = 'YOUR API KEY'
89
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
90
- #config.api_key_prefix['Authorization'] = 'Bearer'
91
- end
92
-
93
- api_instance = YnabApi::TransactionsApi.new
94
-
95
- budget_id = "budget_id_example" # String | The ID of the Budget.
96
-
97
- transaction = YnabApi::SaveTransactionWrapper.new # SaveTransactionWrapper | The Transaction to create.
98
-
99
-
100
- begin
101
- #Create new transaction
102
- result = api_instance.create_transaction(budget_id, transaction)
103
- p result
104
- rescue YnabApi::ApiError => e
105
- puts "Exception when calling TransactionsApi->create_transaction: #{e}"
106
- end
107
- ```
108
-
109
42
  ### Parameters
110
43
 
111
44
  Name | Type | Description | Notes
@@ -117,17 +50,6 @@ Name | Type | Description | Notes
117
50
 
118
51
  [**TransactionResponse**](TransactionResponse.md)
119
52
 
120
- ### Authorization
121
-
122
- [bearer](../README.md#bearer)
123
-
124
- ### HTTP request headers
125
-
126
- - **Content-Type**: Not defined
127
- - **Accept**: application/json
128
-
129
-
130
-
131
53
  # **get_transactions**
132
54
  > TransactionsResponse get_transactions(budget_id, opts)
133
55
 
@@ -135,36 +57,6 @@ List transactions
135
57
 
136
58
  Returns budget transactions
137
59
 
138
- ### Example
139
- ```ruby
140
- # load the gem
141
- require 'ynab'
142
- # setup authorization
143
- YnabApi.configure do |config|
144
- # Configure API key authorization: bearer
145
- config.api_key['Authorization'] = 'YOUR API KEY'
146
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
147
- #config.api_key_prefix['Authorization'] = 'Bearer'
148
- end
149
-
150
- api_instance = YnabApi::TransactionsApi.new
151
-
152
- budget_id = "budget_id_example" # String | The ID of the Budget.
153
-
154
- opts = {
155
- since_date: Date.parse("2013-10-20"), # Date | Only return transactions on or after this date.
156
- type: "type_example" # String | Only return transactions of a certain type (i.e. 'uncategorized', 'unapproved')
157
- }
158
-
159
- begin
160
- #List transactions
161
- result = api_instance.get_transactions(budget_id, opts)
162
- p result
163
- rescue YnabApi::ApiError => e
164
- puts "Exception when calling TransactionsApi->get_transactions: #{e}"
165
- end
166
- ```
167
-
168
60
  ### Parameters
169
61
 
170
62
  Name | Type | Description | Notes
@@ -177,17 +69,6 @@ Name | Type | Description | Notes
177
69
 
178
70
  [**TransactionsResponse**](TransactionsResponse.md)
179
71
 
180
- ### Authorization
181
-
182
- [bearer](../README.md#bearer)
183
-
184
- ### HTTP request headers
185
-
186
- - **Content-Type**: Not defined
187
- - **Accept**: application/json
188
-
189
-
190
-
191
72
  # **get_transactions_by_account**
192
73
  > TransactionsResponse get_transactions_by_account(budget_id, account_id, opts)
193
74
 
@@ -195,37 +76,6 @@ List account transactions
195
76
 
196
77
  Returns all transactions for a specified account
197
78
 
198
- ### Example
199
- ```ruby
200
- # load the gem
201
- require 'ynab'
202
- # setup authorization
203
- YnabApi.configure do |config|
204
- # Configure API key authorization: bearer
205
- config.api_key['Authorization'] = 'YOUR API KEY'
206
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
207
- #config.api_key_prefix['Authorization'] = 'Bearer'
208
- end
209
-
210
- api_instance = YnabApi::TransactionsApi.new
211
-
212
- budget_id = "budget_id_example" # String | The ID of the Budget.
213
-
214
- account_id = "account_id_example" # String | The ID of the Account.
215
-
216
- opts = {
217
- since_date: Date.parse("2013-10-20") # Date | Only return transactions on or after this date.
218
- }
219
-
220
- begin
221
- #List account transactions
222
- result = api_instance.get_transactions_by_account(budget_id, account_id, opts)
223
- p result
224
- rescue YnabApi::ApiError => e
225
- puts "Exception when calling TransactionsApi->get_transactions_by_account: #{e}"
226
- end
227
- ```
228
-
229
79
  ### Parameters
230
80
 
231
81
  Name | Type | Description | Notes
@@ -238,17 +88,6 @@ Name | Type | Description | Notes
238
88
 
239
89
  [**TransactionsResponse**](TransactionsResponse.md)
240
90
 
241
- ### Authorization
242
-
243
- [bearer](../README.md#bearer)
244
-
245
- ### HTTP request headers
246
-
247
- - **Content-Type**: Not defined
248
- - **Accept**: application/json
249
-
250
-
251
-
252
91
  # **get_transactions_by_category**
253
92
  > HybridTransactionsResponse get_transactions_by_category(budget_id, category_id, opts)
254
93
 
@@ -256,37 +95,6 @@ List category transactions
256
95
 
257
96
  Returns all transactions for a specified category
258
97
 
259
- ### Example
260
- ```ruby
261
- # load the gem
262
- require 'ynab'
263
- # setup authorization
264
- YnabApi.configure do |config|
265
- # Configure API key authorization: bearer
266
- config.api_key['Authorization'] = 'YOUR API KEY'
267
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
268
- #config.api_key_prefix['Authorization'] = 'Bearer'
269
- end
270
-
271
- api_instance = YnabApi::TransactionsApi.new
272
-
273
- budget_id = "budget_id_example" # String | The ID of the Budget.
274
-
275
- category_id = "category_id_example" # String | The ID of the Category.
276
-
277
- opts = {
278
- since_date: Date.parse("2013-10-20") # Date | Only return transactions on or after this date.
279
- }
280
-
281
- begin
282
- #List category transactions
283
- result = api_instance.get_transactions_by_category(budget_id, category_id, opts)
284
- p result
285
- rescue YnabApi::ApiError => e
286
- puts "Exception when calling TransactionsApi->get_transactions_by_category: #{e}"
287
- end
288
- ```
289
-
290
98
  ### Parameters
291
99
 
292
100
  Name | Type | Description | Notes
@@ -299,17 +107,6 @@ Name | Type | Description | Notes
299
107
 
300
108
  [**HybridTransactionsResponse**](HybridTransactionsResponse.md)
301
109
 
302
- ### Authorization
303
-
304
- [bearer](../README.md#bearer)
305
-
306
- ### HTTP request headers
307
-
308
- - **Content-Type**: Not defined
309
- - **Accept**: application/json
310
-
311
-
312
-
313
110
  # **get_transactions_by_id**
314
111
  > TransactionResponse get_transactions_by_id(budget_id, transaction_id)
315
112
 
@@ -317,34 +114,6 @@ Single transaction
317
114
 
318
115
  Returns a single transaction
319
116
 
320
- ### Example
321
- ```ruby
322
- # load the gem
323
- require 'ynab'
324
- # setup authorization
325
- YnabApi.configure do |config|
326
- # Configure API key authorization: bearer
327
- config.api_key['Authorization'] = 'YOUR API KEY'
328
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
329
- #config.api_key_prefix['Authorization'] = 'Bearer'
330
- end
331
-
332
- api_instance = YnabApi::TransactionsApi.new
333
-
334
- budget_id = "budget_id_example" # String | The ID of the Budget.
335
-
336
- transaction_id = "transaction_id_example" # String | The ID of the Transaction.
337
-
338
-
339
- begin
340
- #Single transaction
341
- result = api_instance.get_transactions_by_id(budget_id, transaction_id)
342
- p result
343
- rescue YnabApi::ApiError => e
344
- puts "Exception when calling TransactionsApi->get_transactions_by_id: #{e}"
345
- end
346
- ```
347
-
348
117
  ### Parameters
349
118
 
350
119
  Name | Type | Description | Notes
@@ -356,17 +125,6 @@ Name | Type | Description | Notes
356
125
 
357
126
  [**TransactionResponse**](TransactionResponse.md)
358
127
 
359
- ### Authorization
360
-
361
- [bearer](../README.md#bearer)
362
-
363
- ### HTTP request headers
364
-
365
- - **Content-Type**: Not defined
366
- - **Accept**: application/json
367
-
368
-
369
-
370
128
  # **get_transactions_by_payee**
371
129
  > HybridTransactionsResponse get_transactions_by_payee(budget_id, payee_id, opts)
372
130
 
@@ -374,37 +132,6 @@ List payee transactions
374
132
 
375
133
  Returns all transactions for a specified payee
376
134
 
377
- ### Example
378
- ```ruby
379
- # load the gem
380
- require 'ynab'
381
- # setup authorization
382
- YnabApi.configure do |config|
383
- # Configure API key authorization: bearer
384
- config.api_key['Authorization'] = 'YOUR API KEY'
385
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
386
- #config.api_key_prefix['Authorization'] = 'Bearer'
387
- end
388
-
389
- api_instance = YnabApi::TransactionsApi.new
390
-
391
- budget_id = "budget_id_example" # String | The ID of the Budget.
392
-
393
- payee_id = "payee_id_example" # String | The ID of the Payee.
394
-
395
- opts = {
396
- since_date: Date.parse("2013-10-20") # Date | Only return transactions on or after this date.
397
- }
398
-
399
- begin
400
- #List payee transactions
401
- result = api_instance.get_transactions_by_payee(budget_id, payee_id, opts)
402
- p result
403
- rescue YnabApi::ApiError => e
404
- puts "Exception when calling TransactionsApi->get_transactions_by_payee: #{e}"
405
- end
406
- ```
407
-
408
135
  ### Parameters
409
136
 
410
137
  Name | Type | Description | Notes
@@ -417,17 +144,6 @@ Name | Type | Description | Notes
417
144
 
418
145
  [**HybridTransactionsResponse**](HybridTransactionsResponse.md)
419
146
 
420
- ### Authorization
421
-
422
- [bearer](../README.md#bearer)
423
-
424
- ### HTTP request headers
425
-
426
- - **Content-Type**: Not defined
427
- - **Accept**: application/json
428
-
429
-
430
-
431
147
  # **update_transaction**
432
148
  > TransactionResponse update_transaction(budget_id, transaction_id, transaction)
433
149
 
@@ -435,36 +151,6 @@ Updates an existing transaction
435
151
 
436
152
  Updates a transaction
437
153
 
438
- ### Example
439
- ```ruby
440
- # load the gem
441
- require 'ynab'
442
- # setup authorization
443
- YnabApi.configure do |config|
444
- # Configure API key authorization: bearer
445
- config.api_key['Authorization'] = 'YOUR API KEY'
446
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
447
- #config.api_key_prefix['Authorization'] = 'Bearer'
448
- end
449
-
450
- api_instance = YnabApi::TransactionsApi.new
451
-
452
- budget_id = "budget_id_example" # String | The ID of the Budget.
453
-
454
- transaction_id = "transaction_id_example" # String | The ID of the Transaction.
455
-
456
- transaction = YnabApi::SaveTransactionWrapper.new # SaveTransactionWrapper | The Transaction to update.
457
-
458
-
459
- begin
460
- #Updates an existing transaction
461
- result = api_instance.update_transaction(budget_id, transaction_id, transaction)
462
- p result
463
- rescue YnabApi::ApiError => e
464
- puts "Exception when calling TransactionsApi->update_transaction: #{e}"
465
- end
466
- ```
467
-
468
154
  ### Parameters
469
155
 
470
156
  Name | Type | Description | Notes
@@ -477,14 +163,3 @@ Name | Type | Description | Notes
477
163
 
478
164
  [**TransactionResponse**](TransactionResponse.md)
479
165
 
480
- ### Authorization
481
-
482
- [bearer](../README.md#bearer)
483
-
484
- ### HTTP request headers
485
-
486
- - **Content-Type**: Not defined
487
- - **Accept**: application/json
488
-
489
-
490
-