Class: Tradenity::CashOnDeliveryPayment

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CashOnDeliveryPayment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 102

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
end

Instance Attribute Details

#__meta ⇒ Object

Returns the value of attribute __meta.



32
33
34
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 32

def __meta
  @__meta
end

#amount ⇒ Object

Returns the value of attribute amount.



38
39
40
 
# File 'lib/tradenity/resources/cash_on_delivery_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/cash_on_delivery_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/cash_on_delivery_payment.rb', line 44

def currency
  @currency
end

#order ⇒ Object

Returns the value of attribute order.



40
41
42
 
# File 'lib/tradenity/resources/cash_on_delivery_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/cash_on_delivery_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/cash_on_delivery_payment.rb', line 46

def status
  @status
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

.api_client ⇒ Object 



338
339
340
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 338

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 71

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'
  }
end

.create_cash_on_delivery_payment(cash_on_delivery_payment, opts = {}) ⇒ CashOnDeliveryPayment

Create CashOnDeliveryPayment Create a new CashOnDeliveryPayment

Parameters:

  • cash_on_delivery_payment —

    Attributes of cashOnDeliveryPayment to create

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

    the optional parameters

Returns:



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

def create_cash_on_delivery_payment(cash_on_delivery_payment, opts = {})
  data, _status_code, _headers = create_cash_on_delivery_payment_with_http_info(cash_on_delivery_payment, opts)
  data
end

.create_cash_on_delivery_payment_with_http_info(cash_on_delivery_payment, opts = {}) ⇒ Array<(CashOnDeliveryPayment, Fixnum, Hash)>

Create CashOnDeliveryPayment Create a new CashOnDeliveryPayment

Parameters:

  • cash_on_delivery_payment —

    Attributes of cashOnDeliveryPayment to create

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

    the optional parameters

Returns:

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

    CashOnDeliveryPayment data, response status code and response headers



421
422
423
424
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
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 421

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

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

.delete_by_id(id) ⇒ nil

Delete CashOnDeliveryPayment Delete an instance of CashOnDeliveryPayment by its ID.

Parameters:

  • id —

    ID of CashOnDeliveryPayment to delete.

Returns:

  • (nil) 


402
403
404
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 402

def delete_by_id(id)
  delete_cash_on_delivery_payment_by_id(id)
end

.delete_cash_on_delivery_payment_by_id(cash_on_delivery_payment_id, opts = {}) ⇒ nil

Delete CashOnDeliveryPayment Delete an instance of CashOnDeliveryPayment by its ID.

Parameters:

  • cash_on_delivery_payment_id —

    ID of cashOnDeliveryPayment to delete.

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

    the optional parameters

Returns:

  • (nil) 


465
466
467
468
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 465

def delete_cash_on_delivery_payment_by_id(cash_on_delivery_payment_id, opts = {})
  delete_cash_on_delivery_payment_by_id_with_http_info(cash_on_delivery_payment_id, opts)
  nil
end

.delete_cash_on_delivery_payment_by_id_with_http_info(cash_on_delivery_payment_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete CashOnDeliveryPayment Delete an instance of CashOnDeliveryPayment by its ID.

Parameters:

  • cash_on_delivery_payment_id —

    ID of cashOnDeliveryPayment to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 475

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

.find_all ⇒ Page<CashOnDeliveryPayment>

List CashOnDeliveryPayments Return a list of CashOnDeliveryPayments

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



370
371
372
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 370

def find_all
  list_all_cash_on_delivery_payments
end

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

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

Parameters:

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

    the search parameters

Returns:



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

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

.find_by_id(id) ⇒ CashOnDeliveryPayment

Find CashOnDeliveryPayment Return single instance of CashOnDeliveryPayment by its ID.

Parameters:

  • id —

    ID of CashOnDeliveryPayment to return

Returns:



394
395
396
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 394

def find_by_id(id)
  get_cash_on_delivery_payment_by_id(id)
end

.find_one_by(opts = {}) ⇒ CashOnDeliveryPayment

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

Parameters:

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

    search parameters

Returns:



386
387
388
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 386

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

.get_cash_on_delivery_payment_by_id(cash_on_delivery_payment_id, opts = {}) ⇒ CashOnDeliveryPayment

Find CashOnDeliveryPayment Return single instance of CashOnDeliveryPayment by its ID.

Parameters:

  • cash_on_delivery_payment_id —

    ID of cashOnDeliveryPayment to return

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

    the optional parameters

Returns:



518
519
520
521
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 518

def get_cash_on_delivery_payment_by_id(cash_on_delivery_payment_id, opts = {})
  data, _status_code, _headers = get_cash_on_delivery_payment_by_id_with_http_info(cash_on_delivery_payment_id, opts)
  data
end

.get_cash_on_delivery_payment_by_id_with_http_info(cash_on_delivery_payment_id, opts = {}) ⇒ Array<(CashOnDeliveryPayment, Fixnum, Hash)>

Find CashOnDeliveryPayment Return single instance of CashOnDeliveryPayment by its ID.

Parameters:

  • cash_on_delivery_payment_id —

    ID of cashOnDeliveryPayment to return

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

    the optional parameters

Returns:

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

    CashOnDeliveryPayment data, response status code and response headers



528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 528

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

.list_all_cash_on_delivery_payments(opts = {}) ⇒ Page<CashOnDeliveryPayment>

List CashOnDeliveryPayments Return a list of CashOnDeliveryPayments

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



574
575
576
577
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 574

def list_all_cash_on_delivery_payments(opts = {})
  data, _status_code, _headers = list_all_cash_on_delivery_payments_with_http_info(opts)
  data
end

.list_all_cash_on_delivery_payments_with_http_info(opts = {}) ⇒ Array<(Page<CashOnDeliveryPayment>, Fixnum, Hash)>

List CashOnDeliveryPayments Return a list of CashOnDeliveryPayments

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<CashOnDeliveryPayment>, Fixnum, Hash)>) —

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



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 586

def list_all_cash_on_delivery_payments_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: CashOnDeliveryPayment.list_all_cash_on_delivery_payments ...'
  end
  # resource path
  local_var_path = '/cashOnDeliveryPayments'

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

.replace_cash_on_delivery_payment_by_id(cash_on_delivery_payment_id, cash_on_delivery_payment, opts = {}) ⇒ CashOnDeliveryPayment

Replace CashOnDeliveryPayment Replace all attributes of CashOnDeliveryPayment

Parameters:

  • cash_on_delivery_payment_id —

    ID of cashOnDeliveryPayment to replace

  • cash_on_delivery_payment —

    Attributes of cashOnDeliveryPayment to replace

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

    the optional parameters

Returns:



630
631
632
633
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 630

def replace_cash_on_delivery_payment_by_id(cash_on_delivery_payment_id, cash_on_delivery_payment, opts = {})
  data, _status_code, _headers = replace_cash_on_delivery_payment_by_id_with_http_info(cash_on_delivery_payment_id, cash_on_delivery_payment, opts)
  data
end

.replace_cash_on_delivery_payment_by_id_with_http_info(cash_on_delivery_payment_id, cash_on_delivery_payment, opts = {}) ⇒ Array<(CashOnDeliveryPayment, Fixnum, Hash)>

Replace CashOnDeliveryPayment Replace all attributes of CashOnDeliveryPayment

Parameters:

  • cash_on_delivery_payment_id —

    ID of cashOnDeliveryPayment to replace

  • cash_on_delivery_payment —

    Attributes of cashOnDeliveryPayment to replace

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

    the optional parameters

Returns:

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

    CashOnDeliveryPayment data, response status code and response headers



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
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 641

def replace_cash_on_delivery_payment_by_id_with_http_info(cash_on_delivery_payment_id, cash_on_delivery_payment, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: CashOnDeliveryPayment.replace_cash_on_delivery_payment_by_id ...'
  end
  # verify the required parameter 'cash_on_delivery_payment_id' is set
  if api_client.config.client_side_validation && cash_on_delivery_payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'cash_on_delivery_payment_id' when calling CashOnDeliveryPayment.replace_cash_on_delivery_payment_by_id"
  end
  # verify the required parameter 'cash_on_delivery_payment' is set
  if api_client.config.client_side_validation && cash_on_delivery_payment.nil?
    fail ArgumentError, "Missing the required parameter 'cash_on_delivery_payment' when calling CashOnDeliveryPayment.replace_cash_on_delivery_payment_by_id"
  end
  # resource path
  local_var_path = '/cashOnDeliveryPayments/{cashOnDeliveryPaymentId}'.sub('{' + 'cashOnDeliveryPaymentId' + '}', cash_on_delivery_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(cash_on_delivery_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 => 'CashOnDeliveryPayment')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: CashOnDeliveryPayment#replace_cash_on_delivery_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.



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 86

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'
  }
end

.update_cash_on_delivery_payment_by_id(cash_on_delivery_payment_id, cash_on_delivery_payment, opts = {}) ⇒ CashOnDeliveryPayment

Update CashOnDeliveryPayment Update attributes of CashOnDeliveryPayment

Parameters:

  • cash_on_delivery_payment_id —

    ID of cashOnDeliveryPayment to update.

  • cash_on_delivery_payment —

    Attributes of cashOnDeliveryPayment to update.

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

    the optional parameters

Returns:



690
691
692
693
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 690

def update_cash_on_delivery_payment_by_id(cash_on_delivery_payment_id, cash_on_delivery_payment, opts = {})
  data, _status_code, _headers = update_cash_on_delivery_payment_by_id_with_http_info(cash_on_delivery_payment_id, cash_on_delivery_payment, opts)
  data
end

.update_cash_on_delivery_payment_by_id_with_http_info(cash_on_delivery_payment_id, cash_on_delivery_payment, opts = {}) ⇒ Array<(CashOnDeliveryPayment, Fixnum, Hash)>

Update CashOnDeliveryPayment Update attributes of CashOnDeliveryPayment

Parameters:

  • cash_on_delivery_payment_id —

    ID of cashOnDeliveryPayment to update.

  • cash_on_delivery_payment —

    Attributes of cashOnDeliveryPayment to update.

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

    the optional parameters

Returns:

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

    CashOnDeliveryPayment data, response status code and response headers



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
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 701

def update_cash_on_delivery_payment_by_id_with_http_info(cash_on_delivery_payment_id, cash_on_delivery_payment, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: CashOnDeliveryPayment.update_cash_on_delivery_payment_by_id ...'
  end
  # verify the required parameter 'cash_on_delivery_payment_id' is set
  if api_client.config.client_side_validation && cash_on_delivery_payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'cash_on_delivery_payment_id' when calling CashOnDeliveryPayment.update_cash_on_delivery_payment_by_id"
  end
  # verify the required parameter 'cash_on_delivery_payment' is set
  if api_client.config.client_side_validation && cash_on_delivery_payment.nil?
    fail ArgumentError, "Missing the required parameter 'cash_on_delivery_payment' when calling CashOnDeliveryPayment.update_cash_on_delivery_payment_by_id"
  end
  # resource path
  local_var_path = '/cashOnDeliveryPayments/{cashOnDeliveryPaymentId}'.sub('{' + 'cashOnDeliveryPaymentId' + '}', cash_on_delivery_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(cash_on_delivery_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 => 'CashOnDeliveryPayment')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: CashOnDeliveryPayment#update_cash_on_delivery_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



208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 208

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
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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 257

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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 323

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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 236

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



344
345
346
347
348
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 344

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

#delete ⇒ nil

Delete CashOnDeliveryPayment Delete this instance of CashOnDeliveryPayment.

Returns:

  • (nil) 


360
361
362
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 360

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


223
224
225
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 223

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



229
230
231
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 229

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

#id ⇒ Object 



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/tradenity/resources/cash_on_delivery_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/cash_on_delivery_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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 158

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

  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



303
304
305
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 303

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



309
310
311
312
313
314
315
316
317
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 309

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



297
298
299
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 297

def to_s
  to_hash.to_s
end

#update ⇒ CashOnDeliveryPayment

Update CashOnDeliveryPayment Update attributes of CashOnDeliveryPayment

Returns:



353
354
355
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 353

def update
  self.class.update_cash_on_delivery_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



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/tradenity/resources/cash_on_delivery_payment.rb', line 185

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)
  true
end