Class: Tradenity::StoreCreditTransaction
- Inherits:
-
Object
- Object
- Tradenity::StoreCreditTransaction
- Defined in:
- lib/tradenity/resources/store_credit_transaction.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#__meta ⇒ Object
Returns the value of attribute __meta.
-
#created_at ⇒ Object
Returns the value of attribute created_at.
-
#status ⇒ Object
Returns the value of attribute status.
-
#store_credit ⇒ Object
Returns the value of attribute store_credit.
-
#type ⇒ Object
Returns the value of attribute type.
-
#updated_at ⇒ Object
Returns the value of attribute updated_at.
Class Method Summary collapse
- .api_client ⇒ Object
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.create_store_credit_transaction(store_credit_transaction, opts = {}) ⇒ StoreCreditTransaction
Create StoreCreditTransaction Create a new StoreCreditTransaction.
-
.create_store_credit_transaction_with_http_info(store_credit_transaction, opts = {}) ⇒ Array<(StoreCreditTransaction, Fixnum, Hash)>
Create StoreCreditTransaction Create a new StoreCreditTransaction.
-
.delete_by_id(id) ⇒ nil
Delete StoreCreditTransaction Delete an instance of StoreCreditTransaction by its ID.
-
.delete_store_credit_transaction_by_id(store_credit_transaction_id, opts = {}) ⇒ nil
Delete StoreCreditTransaction Delete an instance of StoreCreditTransaction by its ID.
-
.delete_store_credit_transaction_by_id_with_http_info(store_credit_transaction_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete StoreCreditTransaction Delete an instance of StoreCreditTransaction by its ID.
-
.find_all ⇒ Page<StoreCreditTransaction>
List StoreCreditTransactions Return a list of StoreCreditTransactions.
-
.find_all_by(opts = {}) ⇒ Page<Collection>
Find List of StoreCreditTransaction Return multiple instances of StoreCreditTransaction by its attributes.
-
.find_by_id(id) ⇒ StoreCreditTransaction
Find StoreCreditTransaction Return single instance of StoreCreditTransaction by its ID.
-
.find_one_by(opts = {}) ⇒ StoreCreditTransaction
Find StoreCreditTransaction by its parameters Return single instance of Collection by its attributes.
-
.get_store_credit_transaction_by_id(store_credit_transaction_id, opts = {}) ⇒ StoreCreditTransaction
Find StoreCreditTransaction Return single instance of StoreCreditTransaction by its ID.
-
.get_store_credit_transaction_by_id_with_http_info(store_credit_transaction_id, opts = {}) ⇒ Array<(StoreCreditTransaction, Fixnum, Hash)>
Find StoreCreditTransaction Return single instance of StoreCreditTransaction by its ID.
-
.list_all_store_credit_transactions(opts = {}) ⇒ Page<StoreCreditTransaction>
List StoreCreditTransactions Return a list of StoreCreditTransactions.
-
.list_all_store_credit_transactions_with_http_info(opts = {}) ⇒ Array<(Page<StoreCreditTransaction>, Fixnum, Hash)>
List StoreCreditTransactions Return a list of StoreCreditTransactions.
-
.replace_store_credit_transaction_by_id(store_credit_transaction_id, store_credit_transaction, opts = {}) ⇒ StoreCreditTransaction
Replace StoreCreditTransaction Replace all attributes of StoreCreditTransaction.
-
.replace_store_credit_transaction_by_id_with_http_info(store_credit_transaction_id, store_credit_transaction, opts = {}) ⇒ Array<(StoreCreditTransaction, Fixnum, Hash)>
Replace StoreCreditTransaction Replace all attributes of StoreCreditTransaction.
-
.swagger_types ⇒ Object
Attribute type mapping.
-
.update_store_credit_transaction_by_id(store_credit_transaction_id, store_credit_transaction, opts = {}) ⇒ StoreCreditTransaction
Update StoreCreditTransaction Update attributes of StoreCreditTransaction.
-
.update_store_credit_transaction_by_id_with_http_info(store_credit_transaction_id, store_credit_transaction, opts = {}) ⇒ Array<(StoreCreditTransaction, Fixnum, Hash)>
Update StoreCreditTransaction Update attributes of StoreCreditTransaction.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
#create ⇒ Object
Create StoreCreditTransaction Create a new StoreCreditTransaction.
-
#delete ⇒ nil
Delete StoreCreditTransaction Delete this instance of StoreCreditTransaction.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
- #id ⇒ Object
- #id=(id) ⇒ Object
-
#initialize(attributes = {}) ⇒ StoreCreditTransaction
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#update ⇒ StoreCreditTransaction
Update StoreCreditTransaction Update attributes of StoreCreditTransaction.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ StoreCreditTransaction
Initializes the object
94 95 96 97 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 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 94 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'__meta') self. = attributes[:'__meta'] end if attributes.has_key?(:'createdAt') self.created_at = attributes[:'createdAt'] end if attributes.has_key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.has_key?(:'updatedAt') self.updated_at = attributes[:'updatedAt'] end if attributes.has_key?(:'updated_at') self.updated_at = attributes[:'updated_at'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'storeCredit') self.store_credit = attributes[:'storeCredit'] end if attributes.has_key?(:'store_credit') self.store_credit = attributes[:'store_credit'] end end |
Instance Attribute Details
#__meta ⇒ Object
Returns the value of attribute __meta.
32 33 34 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 32 def @__meta end |
#created_at ⇒ Object
Returns the value of attribute created_at.
34 35 36 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 34 def created_at @created_at end |
#status ⇒ Object
Returns the value of attribute status.
38 39 40 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 38 def status @status end |
#store_credit ⇒ Object
Returns the value of attribute store_credit.
42 43 44 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 42 def store_credit @store_credit end |
#type ⇒ Object
Returns the value of attribute type.
40 41 42 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 40 def type @type end |
#updated_at ⇒ Object
Returns the value of attribute updated_at.
36 37 38 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 36 def updated_at @updated_at end |
Class Method Details
.api_client ⇒ Object
322 323 324 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 322 def self.api_client ApiClient.default end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 67 def self.attribute_map { :'id' => :'id', :'__meta' => :'__meta', :'created_at' => :'createdAt', :'updated_at' => :'updatedAt', :'status' => :'status', :'type' => :'type', :'store_credit' => :'storeCredit' } end |
.create_store_credit_transaction(store_credit_transaction, opts = {}) ⇒ StoreCreditTransaction
Create StoreCreditTransaction Create a new StoreCreditTransaction
395 396 397 398 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 395 def create_store_credit_transaction(store_credit_transaction, opts = {}) data, _status_code, _headers = create_store_credit_transaction_with_http_info(store_credit_transaction, opts) data end |
.create_store_credit_transaction_with_http_info(store_credit_transaction, opts = {}) ⇒ Array<(StoreCreditTransaction, Fixnum, Hash)>
Create StoreCreditTransaction Create a new StoreCreditTransaction
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 405 def create_store_credit_transaction_with_http_info(store_credit_transaction, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: StoreCreditTransaction.create_store_credit_transaction ...' end # verify the required parameter 'store_credit_transaction' is set if api_client.config.client_side_validation && store_credit_transaction.nil? fail ArgumentError, "Missing the required parameter 'store_credit_transaction' when calling StoreCreditTransaction.create_store_credit_transaction" end # resource path local_var_path = '/storeCreditTransactions' # query parameters query_params = opts # header parameters 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']) # form parameters form_params = {} # http body (model) post_body = api_client.object_to_http_body(store_credit_transaction) auth_names = [] data, status_code, headers = api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'StoreCreditTransaction') if api_client.config.debugging api_client.config.logger.debug "API called: StoreCreditTransaction#create_store_credit_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
.delete_by_id(id) ⇒ nil
Delete StoreCreditTransaction Delete an instance of StoreCreditTransaction by its ID.
386 387 388 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 386 def delete_by_id(id) delete_store_credit_transaction_by_id(id) end |
.delete_store_credit_transaction_by_id(store_credit_transaction_id, opts = {}) ⇒ nil
Delete StoreCreditTransaction Delete an instance of StoreCreditTransaction by its ID.
449 450 451 452 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 449 def delete_store_credit_transaction_by_id(store_credit_transaction_id, opts = {}) delete_store_credit_transaction_by_id_with_http_info(store_credit_transaction_id, opts) nil end |
.delete_store_credit_transaction_by_id_with_http_info(store_credit_transaction_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete StoreCreditTransaction Delete an instance of StoreCreditTransaction by its ID.
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 459 def delete_store_credit_transaction_by_id_with_http_info(store_credit_transaction_id, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: StoreCreditTransaction.delete_store_credit_transaction_by_id ...' end # verify the required parameter 'store_credit_transaction_id' is set if api_client.config.client_side_validation && store_credit_transaction_id.nil? fail ArgumentError, "Missing the required parameter 'store_credit_transaction_id' when calling StoreCreditTransaction.delete_store_credit_transaction_by_id" end # resource path local_var_path = '/storeCreditTransactions/{storeCreditTransactionId}'.sub('{' + 'storeCreditTransactionId' + '}', store_credit_transaction_id.to_s) # query parameters query_params = opts # header parameters 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']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if api_client.config.debugging api_client.config.logger.debug "API called: StoreCreditTransaction#delete_store_credit_transaction_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
.find_all ⇒ Page<StoreCreditTransaction>
List StoreCreditTransactions Return a list of StoreCreditTransactions
354 355 356 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 354 def find_all list_all_store_credit_transactions end |
.find_all_by(opts = {}) ⇒ Page<Collection>
Find List of StoreCreditTransaction Return multiple instances of StoreCreditTransaction by its attributes.
362 363 364 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 362 def find_all_by(opts = {}) list_all_store_credit_transactions(opts) end |
.find_by_id(id) ⇒ StoreCreditTransaction
Find StoreCreditTransaction Return single instance of StoreCreditTransaction by its ID.
378 379 380 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 378 def find_by_id(id) get_store_credit_transaction_by_id(id) end |
.find_one_by(opts = {}) ⇒ StoreCreditTransaction
Find StoreCreditTransaction by its parameters Return single instance of Collection by its attributes.
370 371 372 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 370 def find_one_by(opts = {}) list_all_store_credit_transactions(opts)[0] end |
.get_store_credit_transaction_by_id(store_credit_transaction_id, opts = {}) ⇒ StoreCreditTransaction
Find StoreCreditTransaction Return single instance of StoreCreditTransaction by its ID.
502 503 504 505 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 502 def get_store_credit_transaction_by_id(store_credit_transaction_id, opts = {}) data, _status_code, _headers = get_store_credit_transaction_by_id_with_http_info(store_credit_transaction_id, opts) data end |
.get_store_credit_transaction_by_id_with_http_info(store_credit_transaction_id, opts = {}) ⇒ Array<(StoreCreditTransaction, Fixnum, Hash)>
Find StoreCreditTransaction Return single instance of StoreCreditTransaction by its ID.
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 545 546 547 548 549 550 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 512 def get_store_credit_transaction_by_id_with_http_info(store_credit_transaction_id, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: StoreCreditTransaction.get_store_credit_transaction_by_id ...' end # verify the required parameter 'store_credit_transaction_id' is set if api_client.config.client_side_validation && store_credit_transaction_id.nil? fail ArgumentError, "Missing the required parameter 'store_credit_transaction_id' when calling StoreCreditTransaction.get_store_credit_transaction_by_id" end # resource path local_var_path = '/storeCreditTransactions/{storeCreditTransactionId}'.sub('{' + 'storeCreditTransactionId' + '}', store_credit_transaction_id.to_s) # query parameters query_params = opts # header parameters 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']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'StoreCreditTransaction') if api_client.config.debugging api_client.config.logger.debug "API called: StoreCreditTransaction#get_store_credit_transaction_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
.list_all_store_credit_transactions(opts = {}) ⇒ Page<StoreCreditTransaction>
List StoreCreditTransactions Return a list of StoreCreditTransactions
558 559 560 561 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 558 def list_all_store_credit_transactions(opts = {}) data, _status_code, _headers = list_all_store_credit_transactions_with_http_info(opts) data end |
.list_all_store_credit_transactions_with_http_info(opts = {}) ⇒ Array<(Page<StoreCreditTransaction>, Fixnum, Hash)>
List StoreCreditTransactions Return a list of StoreCreditTransactions
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 570 def list_all_store_credit_transactions_with_http_info(opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: StoreCreditTransaction.list_all_store_credit_transactions ...' end # resource path local_var_path = '/storeCreditTransactions' # query parameters query_params = opts # query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? # query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? # query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters 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']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Page<StoreCreditTransaction>') if api_client.config.debugging api_client.config.logger.debug "API called: StoreCreditTransaction#list_all_store_credit_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
.replace_store_credit_transaction_by_id(store_credit_transaction_id, store_credit_transaction, opts = {}) ⇒ StoreCreditTransaction
Replace StoreCreditTransaction Replace all attributes of StoreCreditTransaction
614 615 616 617 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 614 def replace_store_credit_transaction_by_id(store_credit_transaction_id, store_credit_transaction, opts = {}) data, _status_code, _headers = replace_store_credit_transaction_by_id_with_http_info(store_credit_transaction_id, store_credit_transaction, opts) data end |
.replace_store_credit_transaction_by_id_with_http_info(store_credit_transaction_id, store_credit_transaction, opts = {}) ⇒ Array<(StoreCreditTransaction, Fixnum, Hash)>
Replace StoreCreditTransaction Replace all attributes of StoreCreditTransaction
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 625 def replace_store_credit_transaction_by_id_with_http_info(store_credit_transaction_id, store_credit_transaction, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: StoreCreditTransaction.replace_store_credit_transaction_by_id ...' end # verify the required parameter 'store_credit_transaction_id' is set if api_client.config.client_side_validation && store_credit_transaction_id.nil? fail ArgumentError, "Missing the required parameter 'store_credit_transaction_id' when calling StoreCreditTransaction.replace_store_credit_transaction_by_id" end # verify the required parameter 'store_credit_transaction' is set if api_client.config.client_side_validation && store_credit_transaction.nil? fail ArgumentError, "Missing the required parameter 'store_credit_transaction' when calling StoreCreditTransaction.replace_store_credit_transaction_by_id" end # resource path local_var_path = '/storeCreditTransactions/{storeCreditTransactionId}'.sub('{' + 'storeCreditTransactionId' + '}', store_credit_transaction_id.to_s) # query parameters query_params = opts # header parameters 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']) # form parameters form_params = {} # http body (model) post_body = api_client.object_to_http_body(store_credit_transaction) auth_names = [] data, status_code, headers = api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'StoreCreditTransaction') if api_client.config.debugging api_client.config.logger.debug "API called: StoreCreditTransaction#replace_store_credit_transaction_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
.swagger_types ⇒ Object
Attribute type mapping.
80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 80 def self.swagger_types { :'id' => :'String', :'__meta' => :'InstanceMeta', :'created_at' => :'DateTime', :'updated_at' => :'DateTime', :'status' => :'String', :'type' => :'String', :'store_credit' => :'StoreCredit' } end |
.update_store_credit_transaction_by_id(store_credit_transaction_id, store_credit_transaction, opts = {}) ⇒ StoreCreditTransaction
Update StoreCreditTransaction Update attributes of StoreCreditTransaction
674 675 676 677 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 674 def update_store_credit_transaction_by_id(store_credit_transaction_id, store_credit_transaction, opts = {}) data, _status_code, _headers = update_store_credit_transaction_by_id_with_http_info(store_credit_transaction_id, store_credit_transaction, opts) data end |
.update_store_credit_transaction_by_id_with_http_info(store_credit_transaction_id, store_credit_transaction, opts = {}) ⇒ Array<(StoreCreditTransaction, Fixnum, Hash)>
Update StoreCreditTransaction Update attributes of StoreCreditTransaction
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 685 def update_store_credit_transaction_by_id_with_http_info(store_credit_transaction_id, store_credit_transaction, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: StoreCreditTransaction.update_store_credit_transaction_by_id ...' end # verify the required parameter 'store_credit_transaction_id' is set if api_client.config.client_side_validation && store_credit_transaction_id.nil? fail ArgumentError, "Missing the required parameter 'store_credit_transaction_id' when calling StoreCreditTransaction.update_store_credit_transaction_by_id" end # verify the required parameter 'store_credit_transaction' is set if api_client.config.client_side_validation && store_credit_transaction.nil? fail ArgumentError, "Missing the required parameter 'store_credit_transaction' when calling StoreCreditTransaction.update_store_credit_transaction_by_id" end # resource path local_var_path = '/storeCreditTransactions/{storeCreditTransactionId}'.sub('{' + 'storeCreditTransactionId' + '}', store_credit_transaction_id.to_s) # query parameters query_params = opts # header parameters 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']) # form parameters form_params = {} # http body (model) post_body = api_client.object_to_http_body(store_credit_transaction) auth_names = [] data, status_code, headers = api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'StoreCreditTransaction') if api_client.config.debugging api_client.config.logger.debug "API called: StoreCreditTransaction#update_store_credit_transaction_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
194 195 196 197 198 199 200 201 202 203 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 194 def ==(o) return true if self.equal?(o) self.class == o.class && == o. && created_at == o.created_at && updated_at == o.updated_at && status == o.status && type == o.type && store_credit == o.store_credit end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 274 275 276 277 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 241 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model temp_model = Tradenity.const_get(type).new temp_model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
307 308 309 310 311 312 313 314 315 316 317 318 319 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 307 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 220 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#create ⇒ Object
Create StoreCreditTransaction Create a new StoreCreditTransaction
328 329 330 331 332 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 328 def create data = self.class.create_store_credit_transaction(self) self.id = data.id data end |
#delete ⇒ nil
Delete StoreCreditTransaction Delete this instance of StoreCreditTransaction.
344 345 346 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 344 def delete self.class.delete_store_credit_transaction_by_id(self.id) end |
#eql?(o) ⇒ Boolean
207 208 209 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 207 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
213 214 215 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 213 def hash [, created_at, updated_at, status, type, store_credit].hash end |
#id ⇒ Object
21 22 23 24 25 26 27 28 29 30 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 21 def id if instance_variable_defined?('@id') && @id != nil @id elsif && .href != nil @id = .href.split('/')[-1] @id else nil end end |
#id=(id) ⇒ Object
17 18 19 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 17 def id=(id) @id = id end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 142 def list_invalid_properties invalid_properties = Array.new if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @store_credit.nil? invalid_properties.push('invalid value for "store_credit", store_credit cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
287 288 289 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 287 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
293 294 295 296 297 298 299 300 301 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 293 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
281 282 283 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 281 def to_s to_hash.to_s end |
#update ⇒ StoreCreditTransaction
Update StoreCreditTransaction Update attributes of StoreCreditTransaction
337 338 339 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 337 def update self.class.update_store_credit_transaction_by_id(self.id, self) end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
161 162 163 164 165 166 167 168 169 170 |
# File 'lib/tradenity/resources/store_credit_transaction.rb', line 161 def valid? return false if @status.nil? status_validator = EnumAttributeValidator.new('String', ['completed', 'pending', 'failed']) return false unless status_validator.valid?(@status) return false if @type.nil? type_validator = EnumAttributeValidator.new('String', ['payment', 'refund']) return false unless type_validator.valid?(@type) return false if @store_credit.nil? true end |