Class: PostfinancecheckoutRubySdk::TokenizedCardDataCreate

Inherits:
Object
  • Object
show all
Defined in:
lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TokenizedCardDataCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 122

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

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

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

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

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

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

  if attributes.key?(:'primary_account_number')
    self. = attributes[:'primary_account_number']
  else
    self. = nil
  end

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

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

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

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

Instance Attribute Details

#card_holder_name ⇒ Object

The name of the cardholder, as printed on the card, identifying the card owner.



34
35
36
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 34

def card_holder_name
  @card_holder_name
end

#card_verification_code ⇒ Object

The security code used to validate the card during transactions.



37
38
39
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 37

def card_verification_code
  @card_verification_code
end

#cryptogram ⇒ Object

Returns the value of attribute cryptogram.



50
51
52
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 50

def cryptogram
  @cryptogram
end

#expiry_date ⇒ Object

The expiry date of the card, indicating its validity period in yyyy-mm format (e.g., 2023-09).



29
30
31
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 29

def expiry_date
  @expiry_date
end

#pan_type ⇒ Object

Returns the value of attribute pan_type.



31
32
33
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 31

def pan_type
  @pan_type
end

#primary_account_number ⇒ Object

The card’s primary account number (PAN), the unique identifier of the card.



40
41
42
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 40

def 
  @primary_account_number
end

#recurring_indicator ⇒ Object

Returns the value of attribute recurring_indicator.



42
43
44
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 42

def recurring_indicator
  @recurring_indicator
end

#scheme_transaction_reference ⇒ Object

A reference specific to the card’s transaction within its payment scheme.



45
46
47
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 45

def scheme_transaction_reference
  @scheme_transaction_reference
end

#token_requestor_id ⇒ Object

The token requestor identifier (TRID) identifies the entity requesting tokenization for a card transaction.



48
49
50
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 48

def token_requestor_id
  @token_requestor_id
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



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
420
421
422
423
424
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 387

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 = PostfinancecheckoutRubySdk.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



90
91
92
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 90

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



95
96
97
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 95

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 75

def self.attribute_map
  {
    :'expiry_date' => :'expiryDate',
    :'pan_type' => :'panType',
    :'card_holder_name' => :'cardHolderName',
    :'card_verification_code' => :'cardVerificationCode',
    :'primary_account_number' => :'primaryAccountNumber',
    :'recurring_indicator' => :'recurringIndicator',
    :'scheme_transaction_reference' => :'schemeTransactionReference',
    :'token_requestor_id' => :'tokenRequestorId',
    :'cryptogram' => :'cryptogram'
  }
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



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 363

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



115
116
117
118
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 115

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

.openapi_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 100

def self.openapi_types
  {
    :'expiry_date' => :'String',
    :'pan_type' => :'PanType',
    :'card_holder_name' => :'String',
    :'card_verification_code' => :'String',
    :'primary_account_number' => :'String',
    :'recurring_indicator' => :'RecurringIndicator',
    :'scheme_transaction_reference' => :'String',
    :'token_requestor_id' => :'String',
    :'cryptogram' => :'CardCryptogramCreate'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 334

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      expiry_date == o.expiry_date &&
      pan_type == o.pan_type &&
      card_holder_name == o.card_holder_name &&
      card_verification_code == o.card_verification_code &&
       == o. &&
      recurring_indicator == o.recurring_indicator &&
      scheme_transaction_reference == o.scheme_transaction_reference &&
      token_requestor_id == o.token_requestor_id &&
      cryptogram == o.cryptogram
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



458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 458

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


350
351
352
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 350

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



356
357
358
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 356

def hash
  [expiry_date, pan_type, card_holder_name, card_verification_code, , recurring_indicator, scheme_transaction_reference, token_requestor_id, cryptogram].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



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
223
224
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 177

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/(\d{4})-(11|12|10|0[1-9])/)
  if !@expiry_date.nil? && @expiry_date !~ pattern
    invalid_properties.push("invalid value for \"expiry_date\", must conform to the pattern #{pattern}.")
  end

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

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

  if !@card_verification_code.nil? && @card_verification_code.to_s.length < 3
    invalid_properties.push('invalid value for "card_verification_code", the character length must be great than or equal to 3.')
  end

  pattern = Regexp.new(/([0-9 ]+)/)
  if !@card_verification_code.nil? && @card_verification_code !~ pattern
    invalid_properties.push("invalid value for \"card_verification_code\", must conform to the pattern #{pattern}.")
  end

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

  if @primary_account_number.to_s.length > 30
    invalid_properties.push('invalid value for "primary_account_number", the character length must be smaller than or equal to 30.')
  end

  if @primary_account_number.to_s.length < 10
    invalid_properties.push('invalid value for "primary_account_number", the character length must be great than or equal to 10.')
  end

  pattern = Regexp.new(/([0-9 ]+)/)
  if @primary_account_number !~ pattern
    invalid_properties.push("invalid value for \"primary_account_number\", must conform to the pattern #{pattern}.")
  end

  if !@scheme_transaction_reference.nil? && @scheme_transaction_reference.to_s.length > 100
    invalid_properties.push('invalid value for "scheme_transaction_reference", the character length must be smaller than or equal to 100.')
  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



434
435
436
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 434

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



440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 440

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



428
429
430
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 428

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/postfinancecheckout-ruby-sdk/models/tokenized_card_data_create.rb', line 228

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@expiry_date.nil? && @expiry_date !~ Regexp.new(/(\d{4})-(11|12|10|0[1-9])/)
  return false if !@card_holder_name.nil? && @card_holder_name.to_s.length > 100
  return false if !@card_verification_code.nil? && @card_verification_code.to_s.length > 4
  return false if !@card_verification_code.nil? && @card_verification_code.to_s.length < 3
  return false if !@card_verification_code.nil? && @card_verification_code !~ Regexp.new(/([0-9 ]+)/)
  return false if @primary_account_number.nil?
  return false if @primary_account_number.to_s.length > 30
  return false if @primary_account_number.to_s.length < 10
  return false if @primary_account_number !~ Regexp.new(/([0-9 ]+)/)
  return false if !@scheme_transaction_reference.nil? && @scheme_transaction_reference.to_s.length > 100
  true
end