Class: Tradenity::StoreCreditPayment

Inherits:
Object
  • Object
show all
Defined in:
lib/tradenity/resources/store_credit_payment.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StoreCreditPayment

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 106

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.__meta = 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?(:'amount')
    self.amount = attributes[:'amount']
  end

  if attributes.has_key?(:'order')
    self.order = attributes[:'order']
  end

  if attributes.has_key?(:'paymentSource')
    self.payment_source = attributes[:'paymentSource']
  end

  if attributes.has_key?(:'payment_source')
    self.payment_source = attributes[:'payment_source']
  end

  if attributes.has_key?(:'currency')
    self.currency = attributes[:'currency']
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  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_payment.rb', line 32

def __meta
  @__meta
end

#amount ⇒ Object

Returns the value of attribute amount.



38
39
40
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 38

def amount
  @amount
end

#created_at ⇒ Object

Returns the value of attribute created_at.



34
35
36
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 34

def created_at
  @created_at
end

#currency ⇒ Object

Returns the value of attribute currency.



44
45
46
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 44

def currency
  @currency
end

#order ⇒ Object

Returns the value of attribute order.



40
41
42
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 40

def order
  @order
end

#payment_source ⇒ Object

Returns the value of attribute payment_source.



42
43
44
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 42

def payment_source
  @payment_source
end

#status ⇒ Object

Returns the value of attribute status.



46
47
48
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 46

def status
  @status
end

#store_credit ⇒ Object

Returns the value of attribute store_credit.



48
49
50
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 48

def store_credit
  @store_credit
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



36
37
38
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 36

def updated_at
  @updated_at
end

Class Method Details

.api_client ⇒ Object 



356
357
358
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 356

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 73

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'amount' => :'amount',
    :'order' => :'order',
    :'payment_source' => :'paymentSource',
    :'currency' => :'currency',
    :'status' => :'status',
    :'store_credit' => :'storeCredit'
  }
end

.create_store_credit_payment(store_credit_payment, opts = {}) ⇒ StoreCreditPayment

Create StoreCreditPayment Create a new StoreCreditPayment

Parameters:

  • store_credit_payment —

    Attributes of storeCreditPayment to create

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



429
430
431
432
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 429

def create_store_credit_payment(store_credit_payment, opts = {})
  data, _status_code, _headers = create_store_credit_payment_with_http_info(store_credit_payment, opts)
  data
end

.create_store_credit_payment_with_http_info(store_credit_payment, opts = {}) ⇒ Array<(StoreCreditPayment, Fixnum, Hash)>

Create StoreCreditPayment Create a new StoreCreditPayment

Parameters:

  • store_credit_payment —

    Attributes of storeCreditPayment to create

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(StoreCreditPayment, Fixnum, Hash)>) —

    StoreCreditPayment data, response status code and response headers



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
474
475
476
477
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 439

def create_store_credit_payment_with_http_info(store_credit_payment, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: StoreCreditPayment.create_store_credit_payment ...'
  end
  # verify the required parameter 'store_credit_payment' is set
  if api_client.config.client_side_validation && store_credit_payment.nil?
    fail ArgumentError, "Missing the required parameter 'store_credit_payment' when calling StoreCreditPayment.create_store_credit_payment"
  end
  # resource path
  local_var_path = '/storeCreditPayments'

  # 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_payment)
  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 => 'StoreCreditPayment')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: StoreCreditPayment#create_store_credit_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.delete_by_id(id) ⇒ nil

Delete StoreCreditPayment Delete an instance of StoreCreditPayment by its ID.

Parameters:

  • id —

    ID of StoreCreditPayment to delete.

Returns:

  • (nil) 


420
421
422
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 420

def delete_by_id(id)
  delete_store_credit_payment_by_id(id)
end

.delete_store_credit_payment_by_id(store_credit_payment_id, opts = {}) ⇒ nil

Delete StoreCreditPayment Delete an instance of StoreCreditPayment by its ID.

Parameters:

  • store_credit_payment_id —

    ID of storeCreditPayment to delete.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


483
484
485
486
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 483

def delete_store_credit_payment_by_id(store_credit_payment_id, opts = {})
  delete_store_credit_payment_by_id_with_http_info(store_credit_payment_id, opts)
  nil
end

.delete_store_credit_payment_by_id_with_http_info(store_credit_payment_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete StoreCreditPayment Delete an instance of StoreCreditPayment by its ID.

Parameters:

  • store_credit_payment_id —

    ID of storeCreditPayment to delete.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 493

def delete_store_credit_payment_by_id_with_http_info(store_credit_payment_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: StoreCreditPayment.delete_store_credit_payment_by_id ...'
  end
  # verify the required parameter 'store_credit_payment_id' is set
  if api_client.config.client_side_validation && store_credit_payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_credit_payment_id' when calling StoreCreditPayment.delete_store_credit_payment_by_id"
  end
  # resource path
  local_var_path = '/storeCreditPayments/{storeCreditPaymentId}'.sub('{' + 'storeCreditPaymentId' + '}', store_credit_payment_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: StoreCreditPayment#delete_store_credit_payment_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.find_all ⇒ Page<StoreCreditPayment>

List StoreCreditPayments Return a list of StoreCreditPayments

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



388
389
390
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 388

def find_all
  list_all_store_credit_payments
end

.find_all_by(opts = {}) ⇒ Page<Collection>

Find List of StoreCreditPayment Return multiple instances of StoreCreditPayment by its attributes.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the search parameters

Returns:



396
397
398
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 396

def find_all_by(opts = {})
  list_all_store_credit_payments(opts)
end

.find_by_id(id) ⇒ StoreCreditPayment

Find StoreCreditPayment Return single instance of StoreCreditPayment by its ID.

Parameters:

  • id —

    ID of StoreCreditPayment to return

Returns:



412
413
414
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 412

def find_by_id(id)
  get_store_credit_payment_by_id(id)
end

.find_one_by(opts = {}) ⇒ StoreCreditPayment

Find StoreCreditPayment by its parameters Return single instance of Collection by its attributes.

Parameters:

  • opts (Hash) (defaults to: {}) —

    search parameters

Returns:



404
405
406
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 404

def find_one_by(opts = {})
  list_all_store_credit_payments(opts)[0]
end

.get_store_credit_payment_by_id(store_credit_payment_id, opts = {}) ⇒ StoreCreditPayment

Find StoreCreditPayment Return single instance of StoreCreditPayment by its ID.

Parameters:

  • store_credit_payment_id —

    ID of storeCreditPayment to return

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



536
537
538
539
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 536

def get_store_credit_payment_by_id(store_credit_payment_id, opts = {})
  data, _status_code, _headers = get_store_credit_payment_by_id_with_http_info(store_credit_payment_id, opts)
  data
end

.get_store_credit_payment_by_id_with_http_info(store_credit_payment_id, opts = {}) ⇒ Array<(StoreCreditPayment, Fixnum, Hash)>

Find StoreCreditPayment Return single instance of StoreCreditPayment by its ID.

Parameters:

  • store_credit_payment_id —

    ID of storeCreditPayment to return

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(StoreCreditPayment, Fixnum, Hash)>) —

    StoreCreditPayment data, response status code and response headers



546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 546

def get_store_credit_payment_by_id_with_http_info(store_credit_payment_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: StoreCreditPayment.get_store_credit_payment_by_id ...'
  end
  # verify the required parameter 'store_credit_payment_id' is set
  if api_client.config.client_side_validation && store_credit_payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_credit_payment_id' when calling StoreCreditPayment.get_store_credit_payment_by_id"
  end
  # resource path
  local_var_path = '/storeCreditPayments/{storeCreditPaymentId}'.sub('{' + 'storeCreditPaymentId' + '}', store_credit_payment_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 => 'StoreCreditPayment')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: StoreCreditPayment#get_store_credit_payment_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.list_all_store_credit_payments(opts = {}) ⇒ Page<StoreCreditPayment>

List StoreCreditPayments Return a list of StoreCreditPayments

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



592
593
594
595
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 592

def list_all_store_credit_payments(opts = {})
  data, _status_code, _headers = list_all_store_credit_payments_with_http_info(opts)
  data
end

.list_all_store_credit_payments_with_http_info(opts = {}) ⇒ Array<(Page<StoreCreditPayment>, Fixnum, Hash)>

List StoreCreditPayments Return a list of StoreCreditPayments

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:

  • (Array<(Page<StoreCreditPayment>, Fixnum, Hash)>) —

    Page<StoreCreditPayment> data, response status code and response headers



604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 604

def list_all_store_credit_payments_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: StoreCreditPayment.list_all_store_credit_payments ...'
  end
  # resource path
  local_var_path = '/storeCreditPayments'

  # 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<StoreCreditPayment>')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: StoreCreditPayment#list_all_store_credit_payments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.replace_store_credit_payment_by_id(store_credit_payment_id, store_credit_payment, opts = {}) ⇒ StoreCreditPayment

Replace StoreCreditPayment Replace all attributes of StoreCreditPayment

Parameters:

  • store_credit_payment_id —

    ID of storeCreditPayment to replace

  • store_credit_payment —

    Attributes of storeCreditPayment to replace

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



648
649
650
651
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 648

def replace_store_credit_payment_by_id(store_credit_payment_id, store_credit_payment, opts = {})
  data, _status_code, _headers = replace_store_credit_payment_by_id_with_http_info(store_credit_payment_id, store_credit_payment, opts)
  data
end

.replace_store_credit_payment_by_id_with_http_info(store_credit_payment_id, store_credit_payment, opts = {}) ⇒ Array<(StoreCreditPayment, Fixnum, Hash)>

Replace StoreCreditPayment Replace all attributes of StoreCreditPayment

Parameters:

  • store_credit_payment_id —

    ID of storeCreditPayment to replace

  • store_credit_payment —

    Attributes of storeCreditPayment to replace

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(StoreCreditPayment, Fixnum, Hash)>) —

    StoreCreditPayment data, response status code and response headers



659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 659

def replace_store_credit_payment_by_id_with_http_info(store_credit_payment_id, store_credit_payment, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: StoreCreditPayment.replace_store_credit_payment_by_id ...'
  end
  # verify the required parameter 'store_credit_payment_id' is set
  if api_client.config.client_side_validation && store_credit_payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_credit_payment_id' when calling StoreCreditPayment.replace_store_credit_payment_by_id"
  end
  # verify the required parameter 'store_credit_payment' is set
  if api_client.config.client_side_validation && store_credit_payment.nil?
    fail ArgumentError, "Missing the required parameter 'store_credit_payment' when calling StoreCreditPayment.replace_store_credit_payment_by_id"
  end
  # resource path
  local_var_path = '/storeCreditPayments/{storeCreditPaymentId}'.sub('{' + 'storeCreditPaymentId' + '}', store_credit_payment_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_payment)
  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 => 'StoreCreditPayment')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: StoreCreditPayment#replace_store_credit_payment_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 89

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'amount' => :'Integer',
    :'order' => :'Order',
    :'payment_source' => :'PaymentSource',
    :'currency' => :'Currency',
    :'status' => :'String',
    :'store_credit' => :'StoreCredit'
  }
end

.update_store_credit_payment_by_id(store_credit_payment_id, store_credit_payment, opts = {}) ⇒ StoreCreditPayment

Update StoreCreditPayment Update attributes of StoreCreditPayment

Parameters:

  • store_credit_payment_id —

    ID of storeCreditPayment to update.

  • store_credit_payment —

    Attributes of storeCreditPayment to update.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



708
709
710
711
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 708

def update_store_credit_payment_by_id(store_credit_payment_id, store_credit_payment, opts = {})
  data, _status_code, _headers = update_store_credit_payment_by_id_with_http_info(store_credit_payment_id, store_credit_payment, opts)
  data
end

.update_store_credit_payment_by_id_with_http_info(store_credit_payment_id, store_credit_payment, opts = {}) ⇒ Array<(StoreCreditPayment, Fixnum, Hash)>

Update StoreCreditPayment Update attributes of StoreCreditPayment

Parameters:

  • store_credit_payment_id —

    ID of storeCreditPayment to update.

  • store_credit_payment —

    Attributes of storeCreditPayment to update.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(StoreCreditPayment, Fixnum, Hash)>) —

    StoreCreditPayment data, response status code and response headers



719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 719

def update_store_credit_payment_by_id_with_http_info(store_credit_payment_id, store_credit_payment, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: StoreCreditPayment.update_store_credit_payment_by_id ...'
  end
  # verify the required parameter 'store_credit_payment_id' is set
  if api_client.config.client_side_validation && store_credit_payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_credit_payment_id' when calling StoreCreditPayment.update_store_credit_payment_by_id"
  end
  # verify the required parameter 'store_credit_payment' is set
  if api_client.config.client_side_validation && store_credit_payment.nil?
    fail ArgumentError, "Missing the required parameter 'store_credit_payment' when calling StoreCreditPayment.update_store_credit_payment_by_id"
  end
  # resource path
  local_var_path = '/storeCreditPayments/{storeCreditPaymentId}'.sub('{' + 'storeCreditPaymentId' + '}', store_credit_payment_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_payment)
  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 => 'StoreCreditPayment')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: StoreCreditPayment#update_store_credit_payment_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.

Parameters:

  • Object (Object) —

    to be compared



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 225

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      __meta == o.__meta &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      amount == o.amount &&
      order == o.order &&
      payment_source == o.payment_source &&
      currency == o.currency &&
      status == o.status &&
      store_credit == o.store_credit
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 275

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 341

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 254

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 StoreCreditPayment Create a new StoreCreditPayment



362
363
364
365
366
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 362

def create
  data = self.class.create_store_credit_payment(self)
  self.id = data.id
  data
end

#delete ⇒ nil

Delete StoreCreditPayment Delete this instance of StoreCreditPayment.

Returns:

  • (nil) 


378
379
380
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 378

def delete
  self.class.delete_store_credit_payment_by_id(self.id)
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


241
242
243
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 241

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



247
248
249
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 247

def hash
  [__meta, created_at, updated_at, amount, order, payment_source, currency, status, store_credit].hash
end

#id ⇒ Object 



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 21

def id
  if instance_variable_defined?('@id') && @id != nil
    @id
  elsif __meta && __meta.href != nil
    @id = __meta.href.split('/')[-1]
    @id
  else
    nil
  end
end

#id=(id) ⇒ Object 



17
18
19
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 17

def id=(id)
  @id = id
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 170

def list_invalid_properties
  invalid_properties = Array.new
  if @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

  if @order.nil?
    invalid_properties.push('invalid value for "order", order cannot be nil.')
  end

  if @payment_source.nil?
    invalid_properties.push('invalid value for "payment_source", payment_source cannot be nil.')
  end

  if @currency.nil?
    invalid_properties.push('invalid value for "currency", currency cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status 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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



321
322
323
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 321

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



327
328
329
330
331
332
333
334
335
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 327

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

Returns:

  • (String) —

    String presentation of the object



315
316
317
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 315

def to_s
  to_hash.to_s
end

#update ⇒ StoreCreditPayment

Update StoreCreditPayment Update attributes of StoreCreditPayment

Returns:



371
372
373
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 371

def update
  self.class.update_store_credit_payment_by_id(self.id, self)
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/tradenity/resources/store_credit_payment.rb', line 201

def valid?
  return false if @amount.nil?
  return false if @order.nil?
  return false if @payment_source.nil?
  return false if @currency.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ['pending', 'awaitingRetry', 'successful', 'failed'])
  return false unless status_validator.valid?(@status)
  return false if @store_credit.nil?
  true
end