Class: Tradenity::PaymentTransaction

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentTransaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# File 'lib/tradenity/resources/payment_transaction.rb', line 98

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

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

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

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

Instance Attribute Details

#__metaObject

Returns the value of attribute __meta.



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

def __meta
  @__meta
end

#created_atObject

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#orderObject

Returns the value of attribute order.



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

def order
  @order
end

#paymentObject

Returns the value of attribute payment.



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

def payment
  @payment
end

#statusObject

Returns the value of attribute status.



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

def status
  @status
end

#typeObject

Returns the value of attribute type.



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

def type
  @type
end

#updated_atObject

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

.api_clientObject



332
333
334
# File 'lib/tradenity/resources/payment_transaction.rb', line 332

def self.api_client
  ApiClient.default
end

.attribute_mapObject

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



69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/tradenity/resources/payment_transaction.rb', line 69

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'status' => :'status',
    :'type' => :'type',
    :'payment' => :'payment',
    :'order' => :'order'
  }
end

.create_payment_transaction(payment_transaction, opts = {}) ⇒ PaymentTransaction

Create PaymentTransaction Create a new PaymentTransaction

Parameters:

  • payment_transaction

    Attributes of paymentTransaction to create

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

    the optional parameters

Returns:



405
406
407
408
# File 'lib/tradenity/resources/payment_transaction.rb', line 405

def create_payment_transaction(payment_transaction, opts = {})
  data, _status_code, _headers = create_payment_transaction_with_http_info(payment_transaction, opts)
  data
end

.create_payment_transaction_with_http_info(payment_transaction, opts = {}) ⇒ Array<(PaymentTransaction, Fixnum, Hash)>

Create PaymentTransaction Create a new PaymentTransaction

Parameters:

  • payment_transaction

    Attributes of paymentTransaction to create

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

    the optional parameters

Returns:

  • (Array<(PaymentTransaction, Fixnum, Hash)>)

    PaymentTransaction data, response status code and response headers



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
444
445
446
447
448
449
450
451
452
453
# File 'lib/tradenity/resources/payment_transaction.rb', line 415

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

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

.delete_by_id(id) ⇒ nil

Delete PaymentTransaction Delete an instance of PaymentTransaction by its ID.

Parameters:

  • id

    ID of PaymentTransaction to delete.

Returns:

  • (nil)


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

def delete_by_id(id)
  delete_payment_transaction_by_id(id)
end

.delete_payment_transaction_by_id(payment_transaction_id, opts = {}) ⇒ nil

Delete PaymentTransaction Delete an instance of PaymentTransaction by its ID.

Parameters:

  • payment_transaction_id

    ID of paymentTransaction to delete.

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

    the optional parameters

Returns:

  • (nil)


459
460
461
462
# File 'lib/tradenity/resources/payment_transaction.rb', line 459

def delete_payment_transaction_by_id(payment_transaction_id, opts = {})
  delete_payment_transaction_by_id_with_http_info(payment_transaction_id, opts)
  nil
end

.delete_payment_transaction_by_id_with_http_info(payment_transaction_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete PaymentTransaction Delete an instance of PaymentTransaction by its ID.

Parameters:

  • payment_transaction_id

    ID of paymentTransaction to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
497
498
499
500
501
502
503
504
505
506
# File 'lib/tradenity/resources/payment_transaction.rb', line 469

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

.find_allPage<PaymentTransaction>

List PaymentTransactions Return a list of PaymentTransactions

Parameters:

  • opts (Hash)

    the optional parameters

Returns:



364
365
366
# File 'lib/tradenity/resources/payment_transaction.rb', line 364

def find_all
  list_all_payment_transactions
end

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

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

Parameters:

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

    the search parameters

Returns:



372
373
374
# File 'lib/tradenity/resources/payment_transaction.rb', line 372

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

.find_by_id(id) ⇒ PaymentTransaction

Find PaymentTransaction Return single instance of PaymentTransaction by its ID.

Parameters:

  • id

    ID of PaymentTransaction to return

Returns:



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

def find_by_id(id)
  get_payment_transaction_by_id(id)
end

.find_one_by(opts = {}) ⇒ PaymentTransaction

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

Parameters:

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

    search parameters

Returns:



380
381
382
# File 'lib/tradenity/resources/payment_transaction.rb', line 380

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

.get_payment_transaction_by_id(payment_transaction_id, opts = {}) ⇒ PaymentTransaction

Find PaymentTransaction Return single instance of PaymentTransaction by its ID.

Parameters:

  • payment_transaction_id

    ID of paymentTransaction to return

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

    the optional parameters

Returns:



512
513
514
515
# File 'lib/tradenity/resources/payment_transaction.rb', line 512

def get_payment_transaction_by_id(payment_transaction_id, opts = {})
  data, _status_code, _headers = get_payment_transaction_by_id_with_http_info(payment_transaction_id, opts)
  data
end

.get_payment_transaction_by_id_with_http_info(payment_transaction_id, opts = {}) ⇒ Array<(PaymentTransaction, Fixnum, Hash)>

Find PaymentTransaction Return single instance of PaymentTransaction by its ID.

Parameters:

  • payment_transaction_id

    ID of paymentTransaction to return

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

    the optional parameters

Returns:

  • (Array<(PaymentTransaction, Fixnum, Hash)>)

    PaymentTransaction data, response status code and response headers



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
551
552
553
554
555
556
557
558
559
560
# File 'lib/tradenity/resources/payment_transaction.rb', line 522

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

.list_all_payment_transactions(opts = {}) ⇒ Page<PaymentTransaction>

List PaymentTransactions Return a list of PaymentTransactions

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    page number

  • :size (Integer)

    page size

  • :sort (String)

    page order

Returns:



568
569
570
571
# File 'lib/tradenity/resources/payment_transaction.rb', line 568

def list_all_payment_transactions(opts = {})
  data, _status_code, _headers = list_all_payment_transactions_with_http_info(opts)
  data
end

.list_all_payment_transactions_with_http_info(opts = {}) ⇒ Array<(Page<PaymentTransaction>, Fixnum, Hash)>

List PaymentTransactions Return a list of PaymentTransactions

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

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



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
608
609
610
611
612
613
614
615
616
617
# File 'lib/tradenity/resources/payment_transaction.rb', line 580

def list_all_payment_transactions_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: PaymentTransaction.list_all_payment_transactions ...'
  end
  # resource path
  local_var_path = '/paymentTransactions'

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

.replace_payment_transaction_by_id(payment_transaction_id, payment_transaction, opts = {}) ⇒ PaymentTransaction

Replace PaymentTransaction Replace all attributes of PaymentTransaction

Parameters:

  • payment_transaction_id

    ID of paymentTransaction to replace

  • payment_transaction

    Attributes of paymentTransaction to replace

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

    the optional parameters

Returns:



624
625
626
627
# File 'lib/tradenity/resources/payment_transaction.rb', line 624

def replace_payment_transaction_by_id(payment_transaction_id, payment_transaction, opts = {})
  data, _status_code, _headers = replace_payment_transaction_by_id_with_http_info(payment_transaction_id, payment_transaction, opts)
  data
end

.replace_payment_transaction_by_id_with_http_info(payment_transaction_id, payment_transaction, opts = {}) ⇒ Array<(PaymentTransaction, Fixnum, Hash)>

Replace PaymentTransaction Replace all attributes of PaymentTransaction

Parameters:

  • payment_transaction_id

    ID of paymentTransaction to replace

  • payment_transaction

    Attributes of paymentTransaction to replace

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

    the optional parameters

Returns:

  • (Array<(PaymentTransaction, Fixnum, Hash)>)

    PaymentTransaction data, response status code and response headers



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
668
669
670
671
672
673
674
675
676
677
# File 'lib/tradenity/resources/payment_transaction.rb', line 635

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

.swagger_typesObject

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/tradenity/resources/payment_transaction.rb', line 83

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'status' => :'String',
    :'type' => :'String',
    :'payment' => :'Payment',
    :'order' => :'Order'
  }
end

.update_payment_transaction_by_id(payment_transaction_id, payment_transaction, opts = {}) ⇒ PaymentTransaction

Update PaymentTransaction Update attributes of PaymentTransaction

Parameters:

  • payment_transaction_id

    ID of paymentTransaction to update.

  • payment_transaction

    Attributes of paymentTransaction to update.

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

    the optional parameters

Returns:



684
685
686
687
# File 'lib/tradenity/resources/payment_transaction.rb', line 684

def update_payment_transaction_by_id(payment_transaction_id, payment_transaction, opts = {})
  data, _status_code, _headers = update_payment_transaction_by_id_with_http_info(payment_transaction_id, payment_transaction, opts)
  data
end

.update_payment_transaction_by_id_with_http_info(payment_transaction_id, payment_transaction, opts = {}) ⇒ Array<(PaymentTransaction, Fixnum, Hash)>

Update PaymentTransaction Update attributes of PaymentTransaction

Parameters:

  • payment_transaction_id

    ID of paymentTransaction to update.

  • payment_transaction

    Attributes of paymentTransaction to update.

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

    the optional parameters

Returns:

  • (Array<(PaymentTransaction, Fixnum, Hash)>)

    PaymentTransaction data, response status code and response headers



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
728
729
730
731
732
733
734
735
736
737
# File 'lib/tradenity/resources/payment_transaction.rb', line 695

def update_payment_transaction_by_id_with_http_info(payment_transaction_id, payment_transaction, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: PaymentTransaction.update_payment_transaction_by_id ...'
  end
  # verify the required parameter 'payment_transaction_id' is set
  if api_client.config.client_side_validation && payment_transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_transaction_id' when calling PaymentTransaction.update_payment_transaction_by_id"
  end
  # verify the required parameter 'payment_transaction' is set
  if api_client.config.client_side_validation && payment_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'payment_transaction' when calling PaymentTransaction.update_payment_transaction_by_id"
  end
  # resource path
  local_var_path = '/paymentTransactions/{paymentTransactionId}'.sub('{' + 'paymentTransactionId' + '}', payment_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(payment_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 => 'PaymentTransaction')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: PaymentTransaction#update_payment_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.

Parameters:

  • Object (Object)

    to be compared



203
204
205
206
207
208
209
210
211
212
213
# File 'lib/tradenity/resources/payment_transaction.rb', line 203

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 &&
      status == o.status &&
      type == o.type &&
      payment == o.payment &&
      order == o.order
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



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
278
279
280
281
282
283
284
285
286
287
# File 'lib/tradenity/resources/payment_transaction.rb', line 251

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



317
318
319
320
321
322
323
324
325
326
327
328
329
# File 'lib/tradenity/resources/payment_transaction.rb', line 317

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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
# File 'lib/tradenity/resources/payment_transaction.rb', line 230

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

#createObject

Create PaymentTransaction Create a new PaymentTransaction



338
339
340
341
342
# File 'lib/tradenity/resources/payment_transaction.rb', line 338

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

#deletenil

Delete PaymentTransaction Delete this instance of PaymentTransaction.

Returns:

  • (nil)


354
355
356
# File 'lib/tradenity/resources/payment_transaction.rb', line 354

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


217
218
219
# File 'lib/tradenity/resources/payment_transaction.rb', line 217

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



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

def hash
  [__meta, created_at, updated_at, status, type, payment, order].hash
end

#idObject



21
22
23
24
25
26
27
28
29
30
# File 'lib/tradenity/resources/payment_transaction.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/payment_transaction.rb', line 17

def id=(id)
  @id = id
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'lib/tradenity/resources/payment_transaction.rb', line 146

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 @payment.nil?
    invalid_properties.push('invalid value for "payment", payment cannot be nil.')
  end

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



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

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



303
304
305
306
307
308
309
310
311
# File 'lib/tradenity/resources/payment_transaction.rb', line 303

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



291
292
293
# File 'lib/tradenity/resources/payment_transaction.rb', line 291

def to_s
  to_hash.to_s
end

#updatePaymentTransaction

Update PaymentTransaction Update attributes of PaymentTransaction

Returns:



347
348
349
# File 'lib/tradenity/resources/payment_transaction.rb', line 347

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



169
170
171
172
173
174
175
176
177
178
179
# File 'lib/tradenity/resources/payment_transaction.rb', line 169

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 @payment.nil?
  return false if @order.nil?
  true
end