Class: PCPServerSDK::CardPaymentMethodSpecificInput

Inherits:
Object
  • Object
show all
Defined in:
lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb

Overview

Object containing the specific input details for card payments.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CardPaymentMethodSpecificInput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 120

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PCPServerSDK::CardPaymentMethodSpecificInput` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PCPServerSDK::CardPaymentMethodSpecificInput`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'authorization_mode')
    self.authorization_mode = attributes[:'authorization_mode']
  end

  if attributes.key?(:'recurring')
    self.recurring = attributes[:'recurring']
  end

  if attributes.key?(:'payment_processing_token')
    self.payment_processing_token = attributes[:'payment_processing_token']
  end

  if attributes.key?(:'reporting_token')
    self.reporting_token = attributes[:'reporting_token']
  end

  if attributes.key?(:'transaction_channel')
    self.transaction_channel = attributes[:'transaction_channel']
  end

  if attributes.key?(:'unscheduled_card_on_file_requestor')
    self.unscheduled_card_on_file_requestor = attributes[:'unscheduled_card_on_file_requestor']
  end

  if attributes.key?(:'unscheduled_card_on_file_sequence_indicator')
    self.unscheduled_card_on_file_sequence_indicator = attributes[:'unscheduled_card_on_file_sequence_indicator']
  end

  if attributes.key?(:'payment_product_id')
    self.payment_product_id = attributes[:'payment_product_id']
  end

  if attributes.key?(:'card')
    self.card = attributes[:'card']
  end

  if attributes.key?(:'return_url')
    self.return_url = attributes[:'return_url']
  end

  if attributes.key?(:'card_on_file_recurring_frequency')
    self.card_on_file_recurring_frequency = attributes[:'card_on_file_recurring_frequency']
  end

  if attributes.key?(:'card_on_file_recurring_expiration')
    self.card_on_file_recurring_expiration = attributes[:'card_on_file_recurring_expiration']
  end
end

Instance Attribute Details

#authorization_mode ⇒ Object

Returns the value of attribute authorization_mode.



19
20
21
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 19

def authorization_mode
  @authorization_mode
end

#card ⇒ Object

Returns the value of attribute card.



38
39
40
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 38

def card
  @card
end

#card_on_file_recurring_expiration ⇒ Object

The end date of the last scheduled payment in a series of transactions. Format YYYYMMDD Supported soon



47
48
49
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 47

def card_on_file_recurring_expiration
  @card_on_file_recurring_expiration
end

#card_on_file_recurring_frequency ⇒ Object

Period of payment occurrence for recurring and installment payments. Allowed values: * Yearly * Quarterly * Monthly * Weekly * Daily Supported soon



44
45
46
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 44

def card_on_file_recurring_frequency
  @card_on_file_recurring_frequency
end

#payment_processing_token ⇒ Object

ID of the token to use to create the payment.



24
25
26
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 24

def payment_processing_token
  @payment_processing_token
end

#payment_product_id ⇒ Object

Payment product identifier - please check product documentation for a full overview of possible values.



36
37
38
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 36

def payment_product_id
  @payment_product_id
end

#recurring ⇒ Object

Returns the value of attribute recurring.



21
22
23
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 21

def recurring
  @recurring
end

#reporting_token ⇒ Object

Token to identify the card in the reporting.



27
28
29
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 27

def reporting_token
  @reporting_token
end

#return_url ⇒ Object

The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process. Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first. URLs without a protocol will be rejected.



41
42
43
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 41

def return_url
  @return_url
end

#transaction_channel ⇒ Object

Returns the value of attribute transaction_channel.



29
30
31
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 29

def transaction_channel
  @transaction_channel
end

#unscheduled_card_on_file_requestor ⇒ Object

Returns the value of attribute unscheduled_card_on_file_requestor.



31
32
33
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 31

def unscheduled_card_on_file_requestor
  @unscheduled_card_on_file_requestor
end

#unscheduled_card_on_file_sequence_indicator ⇒ Object

Returns the value of attribute unscheduled_card_on_file_sequence_indicator.



33
34
35
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 33

def unscheduled_card_on_file_sequence_indicator
  @unscheduled_card_on_file_sequence_indicator
end

Class Method Details

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



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 382

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = PCPServerSDK.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 72

def self.attribute_map
  {
    :'authorization_mode' => :'authorizationMode',
    :'recurring' => :'recurring',
    :'payment_processing_token' => :'paymentProcessingToken',
    :'reporting_token' => :'reportingToken',
    :'transaction_channel' => :'transactionChannel',
    :'unscheduled_card_on_file_requestor' => :'unscheduledCardOnFileRequestor',
    :'unscheduled_card_on_file_sequence_indicator' => :'unscheduledCardOnFileSequenceIndicator',
    :'payment_product_id' => :'paymentProductId',
    :'card' => :'card',
    :'return_url' => :'returnUrl',
    :'card_on_file_recurring_frequency' => :'cardOnFileRecurringFrequency',
    :'card_on_file_recurring_expiration' => :'cardOnFileRecurringExpiration'
  }
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



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 358

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



113
114
115
116
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 113

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 95

def self.openapi_types
  {
    :'authorization_mode' => :'AuthorizationMode',
    :'recurring' => :'CardRecurrenceDetails',
    :'payment_processing_token' => :'String',
    :'reporting_token' => :'String',
    :'transaction_channel' => :'TransactionChannel',
    :'unscheduled_card_on_file_requestor' => :'UnscheduledCardOnFileRequestor',
    :'unscheduled_card_on_file_sequence_indicator' => :'UnscheduledCardOnFileSequenceIndicator',
    :'payment_product_id' => :'Integer',
    :'card' => :'CardInfo',
    :'return_url' => :'String',
    :'card_on_file_recurring_frequency' => :'String',
    :'card_on_file_recurring_expiration' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 326

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authorization_mode == o.authorization_mode &&
      recurring == o.recurring &&
      payment_processing_token == o.payment_processing_token &&
      reporting_token == o.reporting_token &&
      transaction_channel == o.transaction_channel &&
      unscheduled_card_on_file_requestor == o.unscheduled_card_on_file_requestor &&
      unscheduled_card_on_file_sequence_indicator == o.unscheduled_card_on_file_sequence_indicator &&
      payment_product_id == o.payment_product_id &&
      card == o.card &&
      return_url == o.return_url &&
      card_on_file_recurring_frequency == o.card_on_file_recurring_frequency &&
      card_on_file_recurring_expiration == o.card_on_file_recurring_expiration
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



453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 453

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


345
346
347
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 345

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



351
352
353
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 351

def hash
  [authorization_mode, recurring, payment_processing_token, reporting_token, transaction_channel, unscheduled_card_on_file_requestor, unscheduled_card_on_file_sequence_indicator, payment_product_id, card, return_url, card_on_file_recurring_frequency, card_on_file_recurring_expiration].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



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
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 184

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@payment_processing_token.nil? && @payment_processing_token.to_s.length > 40
    invalid_properties.push('invalid value for "payment_processing_token", the character length must be smaller than or equal to 40.')
  end

  if !@reporting_token.nil? && @reporting_token.to_s.length > 40
    invalid_properties.push('invalid value for "reporting_token", the character length must be smaller than or equal to 40.')
  end

  if !@payment_product_id.nil? && @payment_product_id > 99999
    invalid_properties.push('invalid value for "payment_product_id", must be smaller than or equal to 99999.')
  end

  if !@payment_product_id.nil? && @payment_product_id < 0
    invalid_properties.push('invalid value for "payment_product_id", must be greater than or equal to 0.')
  end

  if !@return_url.nil? && @return_url.to_s.length > 200
    invalid_properties.push('invalid value for "return_url", the character length must be smaller than or equal to 200.')
  end

  if !@card_on_file_recurring_expiration.nil? && @card_on_file_recurring_expiration.to_s.length > 8
    invalid_properties.push('invalid value for "card_on_file_recurring_expiration", the character length must be smaller than or equal to 8.')
  end

  pattern = Regexp.new(/^((19|20|21)\d{6})?$/)
  if !@card_on_file_recurring_expiration.nil? && @card_on_file_recurring_expiration !~ pattern
    invalid_properties.push("invalid value for \"card_on_file_recurring_expiration\", must conform to the pattern #{pattern}.")
  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



429
430
431
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 429

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



435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 435

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



423
424
425
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 423

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_method_specific_input.rb', line 221

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@payment_processing_token.nil? && @payment_processing_token.to_s.length > 40
  return false if !@reporting_token.nil? && @reporting_token.to_s.length > 40
  return false if !@payment_product_id.nil? && @payment_product_id > 99999
  return false if !@payment_product_id.nil? && @payment_product_id < 0
  return false if !@return_url.nil? && @return_url.to_s.length > 200
  card_on_file_recurring_frequency_validator = EnumAttributeValidator.new('String', ["Yearly", "Quarterly", "Monthly", "Weekly", "Daily"])
  return false unless card_on_file_recurring_frequency_validator.valid?(@card_on_file_recurring_frequency)
  return false if !@card_on_file_recurring_expiration.nil? && @card_on_file_recurring_expiration.to_s.length > 8
  return false if !@card_on_file_recurring_expiration.nil? && @card_on_file_recurring_expiration !~ Regexp.new(/^((19|20|21)\d{6})?$/)
  true
end