Class: FireflyIIIClient::TransactionsApi
- Inherits:
-
Object
- Object
- FireflyIIIClient::TransactionsApi
- Defined in:
- lib/firefly_iii_client/api/transactions_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#delete_transaction(id, opts = {}) ⇒ nil
Delete a transaction.
-
#delete_transaction_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a transaction.
-
#get_transaction(id, opts = {}) ⇒ TransactionSingle
Get a single transaction.
-
#get_transaction_by_journal(id, opts = {}) ⇒ TransactionSingle
Get a single transaction, based on one of the underlying transaction journals.
-
#get_transaction_by_journal_with_http_info(id, opts = {}) ⇒ Array<(TransactionSingle, Integer, Hash)>
Get a single transaction, based on one of the underlying transaction journals.
-
#get_transaction_with_http_info(id, opts = {}) ⇒ Array<(TransactionSingle, Integer, Hash)>
Get a single transaction.
-
#initialize(api_client = ApiClient.default) ⇒ TransactionsApi
constructor
A new instance of TransactionsApi.
-
#list_attachment_by_transaction(id, opts = {}) ⇒ AttachmentArray
Lists all attachments.
-
#list_attachment_by_transaction_with_http_info(id, opts = {}) ⇒ Array<(AttachmentArray, Integer, Hash)>
Lists all attachments.
-
#list_event_by_transaction(id, opts = {}) ⇒ PiggyBankEventArray
Lists all piggy bank events.
-
#list_event_by_transaction_with_http_info(id, opts = {}) ⇒ Array<(PiggyBankEventArray, Integer, Hash)>
Lists all piggy bank events.
-
#list_transaction(opts = {}) ⇒ TransactionArray
List all the user’s transactions.
-
#list_transaction_with_http_info(opts = {}) ⇒ Array<(TransactionArray, Integer, Hash)>
List all the user's transactions.
-
#store_transaction(transaction, opts = {}) ⇒ TransactionSingle
Store a new transaction Creates a new transaction.
-
#store_transaction_with_http_info(transaction, opts = {}) ⇒ Array<(TransactionSingle, Integer, Hash)>
Store a new transaction Creates a new transaction.
-
#update_transaction(id, transaction, opts = {}) ⇒ TransactionSingle
Update existing transaction.
-
#update_transaction_with_http_info(id, transaction, opts = {}) ⇒ Array<(TransactionSingle, Integer, Hash)>
Update existing transaction.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ TransactionsApi
Returns a new instance of TransactionsApi.
19 20 21 |
# File 'lib/firefly_iii_client/api/transactions_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/firefly_iii_client/api/transactions_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#delete_transaction(id, opts = {}) ⇒ nil
Delete a transaction. Delete a transaction.
27 28 29 30 |
# File 'lib/firefly_iii_client/api/transactions_api.rb', line 27 def delete_transaction(id, opts = {}) delete_transaction_with_http_info(id, opts) nil end |
#delete_transaction_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a transaction. Delete a transaction.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/firefly_iii_client/api/transactions_api.rb', line 37 def delete_transaction_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TransactionsApi.delete_transaction ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling TransactionsApi.delete_transaction" end # resource path local_var_path = '/api/v1/transactions/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['firefly_iii_auth'] = opts.merge( :operation => :"TransactionsApi.delete_transaction", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TransactionsApi#delete_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_transaction(id, opts = {}) ⇒ TransactionSingle
Get a single transaction. Get a single transaction.
88 89 90 91 |
# File 'lib/firefly_iii_client/api/transactions_api.rb', line 88 def get_transaction(id, opts = {}) data, _status_code, _headers = get_transaction_with_http_info(id, opts) data end |
#get_transaction_by_journal(id, opts = {}) ⇒ TransactionSingle
Get a single transaction, based on one of the underlying transaction journals. Get a single transaction by underlying journal.
151 152 153 154 |
# File 'lib/firefly_iii_client/api/transactions_api.rb', line 151 def get_transaction_by_journal(id, opts = {}) data, _status_code, _headers = get_transaction_by_journal_with_http_info(id, opts) data end |
#get_transaction_by_journal_with_http_info(id, opts = {}) ⇒ Array<(TransactionSingle, Integer, Hash)>
Get a single transaction, based on one of the underlying transaction journals. Get a single transaction by underlying journal.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
# File 'lib/firefly_iii_client/api/transactions_api.rb', line 161 def get_transaction_by_journal_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TransactionsApi.get_transaction_by_journal ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling TransactionsApi.get_transaction_by_journal" end # resource path local_var_path = '/api/v1/transaction-journals/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'TransactionSingle' # auth_names auth_names = opts[:debug_auth_names] || ['firefly_iii_auth'] = opts.merge( :operation => :"TransactionsApi.get_transaction_by_journal", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TransactionsApi#get_transaction_by_journal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_transaction_with_http_info(id, opts = {}) ⇒ Array<(TransactionSingle, Integer, Hash)>
Get a single transaction. Get a single transaction.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 |
# File 'lib/firefly_iii_client/api/transactions_api.rb', line 98 def get_transaction_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TransactionsApi.get_transaction ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling TransactionsApi.get_transaction" end # resource path local_var_path = '/api/v1/transactions/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'TransactionSingle' # auth_names auth_names = opts[:debug_auth_names] || ['firefly_iii_auth'] = opts.merge( :operation => :"TransactionsApi.get_transaction", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TransactionsApi#get_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_attachment_by_transaction(id, opts = {}) ⇒ AttachmentArray
Lists all attachments. Lists all attachments.
215 216 217 218 |
# File 'lib/firefly_iii_client/api/transactions_api.rb', line 215 def (id, opts = {}) data, _status_code, _headers = (id, opts) data end |
#list_attachment_by_transaction_with_http_info(id, opts = {}) ⇒ Array<(AttachmentArray, Integer, Hash)>
Lists all attachments. Lists all attachments.
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/firefly_iii_client/api/transactions_api.rb', line 226 def (id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TransactionsApi.list_attachment_by_transaction ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling TransactionsApi.list_attachment_by_transaction" end # resource path local_var_path = '/api/v1/transactions/{id}/attachments'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'AttachmentArray' # auth_names auth_names = opts[:debug_auth_names] || ['firefly_iii_auth'] = opts.merge( :operation => :"TransactionsApi.list_attachment_by_transaction", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TransactionsApi#list_attachment_by_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_event_by_transaction(id, opts = {}) ⇒ PiggyBankEventArray
Lists all piggy bank events. Lists all piggy bank events.
281 282 283 284 |
# File 'lib/firefly_iii_client/api/transactions_api.rb', line 281 def list_event_by_transaction(id, opts = {}) data, _status_code, _headers = list_event_by_transaction_with_http_info(id, opts) data end |
#list_event_by_transaction_with_http_info(id, opts = {}) ⇒ Array<(PiggyBankEventArray, Integer, Hash)>
Lists all piggy bank events. Lists all piggy bank events.
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 |
# File 'lib/firefly_iii_client/api/transactions_api.rb', line 292 def list_event_by_transaction_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TransactionsApi.list_event_by_transaction ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling TransactionsApi.list_event_by_transaction" end # resource path local_var_path = '/api/v1/transactions/{id}/piggy_bank_events'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'PiggyBankEventArray' # auth_names auth_names = opts[:debug_auth_names] || ['firefly_iii_auth'] = opts.merge( :operation => :"TransactionsApi.list_event_by_transaction", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TransactionsApi#list_event_by_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_transaction(opts = {}) ⇒ TransactionArray
List all the user’s transactions. List all the user’s transactions.
349 350 351 352 |
# File 'lib/firefly_iii_client/api/transactions_api.rb', line 349 def list_transaction(opts = {}) data, _status_code, _headers = list_transaction_with_http_info(opts) data end |
#list_transaction_with_http_info(opts = {}) ⇒ Array<(TransactionArray, Integer, Hash)>
List all the user's transactions. List all the user's transactions.
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
# File 'lib/firefly_iii_client/api/transactions_api.rb', line 362 def list_transaction_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TransactionsApi.list_transaction ...' end # resource path local_var_path = '/api/v1/transactions' # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil? query_params[:'end'] = opts[:'_end'] if !opts[:'_end'].nil? query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'TransactionArray' # auth_names auth_names = opts[:debug_auth_names] || ['firefly_iii_auth'] = opts.merge( :operation => :"TransactionsApi.list_transaction", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TransactionsApi#list_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#store_transaction(transaction, opts = {}) ⇒ TransactionSingle
Store a new transaction Creates a new transaction. The data required can be submitted as a JSON body or as a list of parameters.
415 416 417 418 |
# File 'lib/firefly_iii_client/api/transactions_api.rb', line 415 def store_transaction(transaction, opts = {}) data, _status_code, _headers = store_transaction_with_http_info(transaction, opts) data end |
#store_transaction_with_http_info(transaction, opts = {}) ⇒ Array<(TransactionSingle, Integer, Hash)>
Store a new transaction Creates a new transaction. The data required can be submitted as a JSON body or as a list of parameters.
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/firefly_iii_client/api/transactions_api.rb', line 425 def store_transaction_with_http_info(transaction, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TransactionsApi.store_transaction ...' end # verify the required parameter 'transaction' is set if @api_client.config.client_side_validation && transaction.nil? fail ArgumentError, "Missing the required parameter 'transaction' when calling TransactionsApi.store_transaction" end # resource path local_var_path = '/api/v1/transactions' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(transaction) # return_type return_type = opts[:debug_return_type] || 'TransactionSingle' # auth_names auth_names = opts[:debug_auth_names] || ['firefly_iii_auth'] = opts.merge( :operation => :"TransactionsApi.store_transaction", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TransactionsApi#store_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_transaction(id, transaction, opts = {}) ⇒ TransactionSingle
Update existing transaction. Update an existing transaction.
481 482 483 484 |
# File 'lib/firefly_iii_client/api/transactions_api.rb', line 481 def update_transaction(id, transaction, opts = {}) data, _status_code, _headers = update_transaction_with_http_info(id, transaction, opts) data end |
#update_transaction_with_http_info(id, transaction, opts = {}) ⇒ Array<(TransactionSingle, Integer, Hash)>
Update existing transaction. Update an existing transaction.
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 |
# File 'lib/firefly_iii_client/api/transactions_api.rb', line 492 def update_transaction_with_http_info(id, transaction, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TransactionsApi.update_transaction ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling TransactionsApi.update_transaction" end # verify the required parameter 'transaction' is set if @api_client.config.client_side_validation && transaction.nil? fail ArgumentError, "Missing the required parameter 'transaction' when calling TransactionsApi.update_transaction" end # resource path local_var_path = '/api/v1/transactions/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(transaction) # return_type return_type = opts[:debug_return_type] || 'TransactionSingle' # auth_names auth_names = opts[:debug_auth_names] || ['firefly_iii_auth'] = opts.merge( :operation => :"TransactionsApi.update_transaction", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TransactionsApi#update_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |