Class: Tradenity::PaymentCard

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentCard

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/tradenity/resources/payment_card.rb', line 126

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#__meta ⇒ Object

Returns the value of attribute __meta.



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

def __meta
  @__meta
end

#address ⇒ Object

Returns the value of attribute address.



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

def address
  @address
end

#brand ⇒ Object

Returns the value of attribute brand.



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

def brand
  @brand
end

#card_holder_name ⇒ Object

Returns the value of attribute card_holder_name.



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

def card_holder_name
  @card_holder_name
end

#card_last_four_digits ⇒ Object

Returns the value of attribute card_last_four_digits.



58
59
60
 
# File 'lib/tradenity/resources/payment_card.rb', line 58

def card_last_four_digits
  @card_last_four_digits
end

#card_number ⇒ Object

Returns the value of attribute card_number.



56
57
58
 
# File 'lib/tradenity/resources/payment_card.rb', line 56

def card_number
  @card_number
end

#ccv ⇒ Object

Returns the value of attribute ccv.



54
55
56
 
# File 'lib/tradenity/resources/payment_card.rb', line 54

def ccv
  @ccv
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#customer ⇒ Object

Returns the value of attribute customer.



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

def customer
  @customer
end

#expiration_month ⇒ Object

Returns the value of attribute expiration_month.



50
51
52
 
# File 'lib/tradenity/resources/payment_card.rb', line 50

def expiration_month
  @expiration_month
end

#expiration_year ⇒ Object

Returns the value of attribute expiration_year.



52
53
54
 
# File 'lib/tradenity/resources/payment_card.rb', line 52

def expiration_year
  @expiration_year
end

#reusable ⇒ Object

Returns the value of attribute reusable.



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

def reusable
  @reusable
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

.api_client ⇒ Object 



439
440
441
 
# File 'lib/tradenity/resources/payment_card.rb', line 439

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/tradenity/resources/payment_card.rb', line 83

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'customer' => :'customer',
    :'reusable' => :'reusable',
    :'status' => :'status',
    :'card_holder_name' => :'cardHolderName',
    :'address' => :'address',
    :'brand' => :'brand',
    :'expiration_month' => :'expirationMonth',
    :'expiration_year' => :'expirationYear',
    :'ccv' => :'CCV',
    :'card_number' => :'cardNumber',
    :'card_last_four_digits' => :'cardLastFourDigits'
  }
end

.create_payment_card(payment_card, opts = {}) ⇒ PaymentCard

Create PaymentCard Create a new PaymentCard

Parameters:

  • payment_card —

    Attributes of paymentCard to create

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

    the optional parameters

Returns:



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

def create_payment_card(payment_card, opts = {})
  data, _status_code, _headers = create_payment_card_with_http_info(payment_card, opts)
  data
end

.create_payment_card_with_http_info(payment_card, opts = {}) ⇒ Array<(PaymentCard, Fixnum, Hash)>

Create PaymentCard Create a new PaymentCard

Parameters:

  • payment_card —

    Attributes of paymentCard to create

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

    the optional parameters

Returns:

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

    PaymentCard 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_card.rb', line 522

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

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

.delete_by_id(id) ⇒ nil

Delete PaymentCard Delete an instance of PaymentCard by its ID.

Parameters:

  • id —

    ID of PaymentCard to delete.

Returns:

  • (nil) 


503
504
505
 
# File 'lib/tradenity/resources/payment_card.rb', line 503

def delete_by_id(id)
  delete_payment_card_by_id(id)
end

.delete_payment_card_by_id(payment_card_id, opts = {}) ⇒ nil

Delete PaymentCard Delete an instance of PaymentCard by its ID.

Parameters:

  • payment_card_id —

    ID of paymentCard to delete.

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

    the optional parameters

Returns:

  • (nil) 


566
567
568
569
 
# File 'lib/tradenity/resources/payment_card.rb', line 566

def delete_payment_card_by_id(payment_card_id, opts = {})
  delete_payment_card_by_id_with_http_info(payment_card_id, opts)
  nil
end

.delete_payment_card_by_id_with_http_info(payment_card_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete PaymentCard Delete an instance of PaymentCard by its ID.

Parameters:

  • payment_card_id —

    ID of paymentCard to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
 
# File 'lib/tradenity/resources/payment_card.rb', line 576

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

.find_all ⇒ Page<PaymentCard>

List PaymentCards Return a list of PaymentCards

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



471
472
473
 
# File 'lib/tradenity/resources/payment_card.rb', line 471

def find_all
  list_all_payment_cards
end

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

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

Parameters:

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

    the search parameters

Returns:



479
480
481
 
# File 'lib/tradenity/resources/payment_card.rb', line 479

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

.find_by_id(id) ⇒ PaymentCard

Find PaymentCard Return single instance of PaymentCard by its ID.

Parameters:

  • id —

    ID of PaymentCard to return

Returns:



495
496
497
 
# File 'lib/tradenity/resources/payment_card.rb', line 495

def find_by_id(id)
  get_payment_card_by_id(id)
end

.find_one_by(opts = {}) ⇒ PaymentCard

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

Parameters:

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

    search parameters

Returns:



487
488
489
 
# File 'lib/tradenity/resources/payment_card.rb', line 487

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

.get_payment_card_by_id(payment_card_id, opts = {}) ⇒ PaymentCard

Find PaymentCard Return single instance of PaymentCard by its ID.

Parameters:

  • payment_card_id —

    ID of paymentCard to return

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

    the optional parameters

Returns:



619
620
621
622
 
# File 'lib/tradenity/resources/payment_card.rb', line 619

def get_payment_card_by_id(payment_card_id, opts = {})
  data, _status_code, _headers = get_payment_card_by_id_with_http_info(payment_card_id, opts)
  data
end

.get_payment_card_by_id_with_http_info(payment_card_id, opts = {}) ⇒ Array<(PaymentCard, Fixnum, Hash)>

Find PaymentCard Return single instance of PaymentCard by its ID.

Parameters:

  • payment_card_id —

    ID of paymentCard to return

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

    the optional parameters

Returns:

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

    PaymentCard data, response status code and response headers



629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
 
# File 'lib/tradenity/resources/payment_card.rb', line 629

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

.list_all_payment_cards(opts = {}) ⇒ Page<PaymentCard>

List PaymentCards Return a list of PaymentCards

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



675
676
677
678
 
# File 'lib/tradenity/resources/payment_card.rb', line 675

def list_all_payment_cards(opts = {})
  data, _status_code, _headers = list_all_payment_cards_with_http_info(opts)
  data
end

.list_all_payment_cards_with_http_info(opts = {}) ⇒ Array<(Page<PaymentCard>, Fixnum, Hash)>

List PaymentCards Return a list of PaymentCards

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

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



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
 
# File 'lib/tradenity/resources/payment_card.rb', line 687

def list_all_payment_cards_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: PaymentCard.list_all_payment_cards ...'
  end
  # resource path
  local_var_path = '/paymentCards'

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

.replace_payment_card_by_id(payment_card_id, payment_card, opts = {}) ⇒ PaymentCard

Replace PaymentCard Replace all attributes of PaymentCard

Parameters:

  • payment_card_id —

    ID of paymentCard to replace

  • payment_card —

    Attributes of paymentCard to replace

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

    the optional parameters

Returns:



731
732
733
734
 
# File 'lib/tradenity/resources/payment_card.rb', line 731

def replace_payment_card_by_id(payment_card_id, payment_card, opts = {})
  data, _status_code, _headers = replace_payment_card_by_id_with_http_info(payment_card_id, payment_card, opts)
  data
end

.replace_payment_card_by_id_with_http_info(payment_card_id, payment_card, opts = {}) ⇒ Array<(PaymentCard, Fixnum, Hash)>

Replace PaymentCard Replace all attributes of PaymentCard

Parameters:

  • payment_card_id —

    ID of paymentCard to replace

  • payment_card —

    Attributes of paymentCard to replace

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

    the optional parameters

Returns:

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

    PaymentCard data, response status code and response headers



742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
 
# File 'lib/tradenity/resources/payment_card.rb', line 742

def replace_payment_card_by_id_with_http_info(payment_card_id, payment_card, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: PaymentCard.replace_payment_card_by_id ...'
  end
  # verify the required parameter 'payment_card_id' is set
  if api_client.config.client_side_validation && payment_card_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_card_id' when calling PaymentCard.replace_payment_card_by_id"
  end
  # verify the required parameter 'payment_card' is set
  if api_client.config.client_side_validation && payment_card.nil?
    fail ArgumentError, "Missing the required parameter 'payment_card' when calling PaymentCard.replace_payment_card_by_id"
  end
  # resource path
  local_var_path = '/paymentCards/{paymentCardId}'.sub('{' + 'paymentCardId' + '}', payment_card_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_card)
  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 => 'PaymentCard')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: PaymentCard#replace_payment_card_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.swagger_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/tradenity/resources/payment_card.rb', line 104

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'customer' => :'Customer',
    :'reusable' => :'BOOLEAN',
    :'status' => :'String',
    :'card_holder_name' => :'String',
    :'address' => :'Address',
    :'brand' => :'String',
    :'expiration_month' => :'String',
    :'expiration_year' => :'String',
    :'ccv' => :'String',
    :'card_number' => :'String',
    :'card_last_four_digits' => :'String'
  }
end

.update_payment_card_by_id(payment_card_id, payment_card, opts = {}) ⇒ PaymentCard

Update PaymentCard Update attributes of PaymentCard

Parameters:

  • payment_card_id —

    ID of paymentCard to update.

  • payment_card —

    Attributes of paymentCard to update.

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

    the optional parameters

Returns:



791
792
793
794
 
# File 'lib/tradenity/resources/payment_card.rb', line 791

def update_payment_card_by_id(payment_card_id, payment_card, opts = {})
  data, _status_code, _headers = update_payment_card_by_id_with_http_info(payment_card_id, payment_card, opts)
  data
end

.update_payment_card_by_id_with_http_info(payment_card_id, payment_card, opts = {}) ⇒ Array<(PaymentCard, Fixnum, Hash)>

Update PaymentCard Update attributes of PaymentCard

Parameters:

  • payment_card_id —

    ID of paymentCard to update.

  • payment_card —

    Attributes of paymentCard to update.

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

    the optional parameters

Returns:

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

    PaymentCard data, response status code and response headers



802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
 
# File 'lib/tradenity/resources/payment_card.rb', line 802

def update_payment_card_by_id_with_http_info(payment_card_id, payment_card, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: PaymentCard.update_payment_card_by_id ...'
  end
  # verify the required parameter 'payment_card_id' is set
  if api_client.config.client_side_validation && payment_card_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_card_id' when calling PaymentCard.update_payment_card_by_id"
  end
  # verify the required parameter 'payment_card' is set
  if api_client.config.client_side_validation && payment_card.nil?
    fail ArgumentError, "Missing the required parameter 'payment_card' when calling PaymentCard.update_payment_card_by_id"
  end
  # resource path
  local_var_path = '/paymentCards/{paymentCardId}'.sub('{' + 'paymentCardId' + '}', payment_card_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_card)
  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 => 'PaymentCard')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: PaymentCard#update_payment_card_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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/tradenity/resources/payment_card.rb', line 303

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 &&
      customer == o.customer &&
      reusable == o.reusable &&
      status == o.status &&
      card_holder_name == o.card_holder_name &&
      address == o.address &&
      brand == o.brand &&
      expiration_month == o.expiration_month &&
      expiration_year == o.expiration_year &&
      ccv == o.ccv &&
      card_number == o.card_number &&
      card_last_four_digits == o.card_last_four_digits
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



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/tradenity/resources/payment_card.rb', line 358

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



424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/tradenity/resources/payment_card.rb', line 424

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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/tradenity/resources/payment_card.rb', line 337

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



445
446
447
448
449
 
# File 'lib/tradenity/resources/payment_card.rb', line 445

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

#delete ⇒ nil

Delete PaymentCard Delete this instance of PaymentCard.

Returns:

  • (nil) 


461
462
463
 
# File 'lib/tradenity/resources/payment_card.rb', line 461

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


324
325
326
 
# File 'lib/tradenity/resources/payment_card.rb', line 324

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



330
331
332
 
# File 'lib/tradenity/resources/payment_card.rb', line 330

def hash
  [__meta, created_at, updated_at, customer, reusable, status, card_holder_name, address, brand, expiration_month, expiration_year, ccv, card_number, card_last_four_digits].hash
end

#id ⇒ Object 



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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/tradenity/resources/payment_card.rb', line 226

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

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

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

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

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

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

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

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



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

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



410
411
412
413
414
415
416
417
418
 
# File 'lib/tradenity/resources/payment_card.rb', line 410

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



398
399
400
 
# File 'lib/tradenity/resources/payment_card.rb', line 398

def to_s
  to_hash.to_s
end

#update ⇒ PaymentCard

Update PaymentCard Update attributes of PaymentCard

Returns:



454
455
456
 
# File 'lib/tradenity/resources/payment_card.rb', line 454

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/tradenity/resources/payment_card.rb', line 265

def valid?
  return false if @customer.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ['new', 'used', 'expired'])
  return false unless status_validator.valid?(@status)
  return false if @brand.nil?
  brand_validator = EnumAttributeValidator.new('String', ['visa', 'mastercard', 'americanExpress', 'discover'])
  return false unless brand_validator.valid?(@brand)
  return false if @expiration_month.nil?
  return false if @expiration_year.nil?
  return false if @ccv.nil?
  return false if @card_number.nil?
  return false if @card_last_four_digits.nil?
  true
end