Class: CyberSource::Tmsv2customersEmbeddedDefaultPaymentInstrumentCard

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Tmsv2customersEmbeddedDefaultPaymentInstrumentCard

Initializes the object

Parameters:

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

    Model attributes in the form of hash



90
91
92
93
94
95
96
97
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
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 90

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#expiration_monthObject

Two-digit month in which the payment card expires. Format: ‘MM`. Possible Values: `01` through `12`.



17
18
19
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 17

def expiration_month
  @expiration_month
end

#expiration_yearObject

Four-digit year in which the credit card expires. Format: ‘YYYY`.



20
21
22
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 20

def expiration_year
  @expiration_year
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



38
39
40
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 38

def hash
  @hash
end

#issue_numberObject

Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. Note The issue number is not required for Maestro (UK Domestic) transactions.



26
27
28
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 26

def issue_number
  @issue_number
end

#start_monthObject

Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. ‘Format: MM`. Possible Values: 01 through 12. Note The start date is not required for Maestro (UK Domestic) transactions.



29
30
31
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 29

def start_month
  @start_month
end

#start_yearObject

Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. ‘Format: YYYY`. Note The start date is not required for Maestro (UK Domestic) transactions.



32
33
34
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 32

def start_year
  @start_year
end

#tokenized_informationObject

Returns the value of attribute tokenized_information.



41
42
43
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 41

def tokenized_information
  @tokenized_information
end

#typeObject

Value that indicates the card type. Possible Values v2 : v1: * 001 : visa * 002 : mastercard - Eurocard—European regional brand of Mastercard * 003 : american express * 004 : discover * 005 : diners club * 006 : carte blanche * 007 : jcb * 008 : optima * 011 : twinpay credit * 012 : twinpay debit * 013 : walmart * 014 : enRoute * 015 : lowes consumer * 016 : home depot consumer * 017 : mbna * 018 : dicks sportswear * 019 : casual corner * 020 : sears * 021 : jal * 023 : disney * 024 : maestro uk domestic * 025 : sams club consumer * 026 : sams club business * 028 : bill me later * 029 : bebe * 030 : restoration hardware * 031 : delta online — use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types. * 032 : solo * 033 : visa electron * 034 : dankort * 035 : laser * 036 : carte bleue — formerly Cartes Bancaires * 037 : carta si * 038 : pinless debit * 039 : encoded account * 040 : uatp * 041 : household * 042 : maestro international * 043 : ge money uk * 044 : korean cards * 045 : style * 046 : jcrew * 047 : payease china processing ewallet * 048 : payease china processing bank transfer * 049 : meijer private label * 050 : hipercard — supported only by the Comercio Latino processor. * 051 : aura — supported only by the Comercio Latino processor. * 052 : redecard * 054 : elo — supported only by the Comercio Latino processor. * 055 : capital one private label * 056 : synchrony private label * 057 : costco private label * 060 : mada * 062 : china union pay * 063 : falabella private label



23
24
25
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 23

def type
  @type
end

#use_asObject

‘Payment Instrument was created / updated as part of a pinless debit transaction.’



35
36
37
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 35

def use_as
  @use_as
end

Class Method Details

.attribute_mapObject

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



44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 44

def self.attribute_map
  {
    :'expiration_month' => :'expirationMonth',
    :'expiration_year' => :'expirationYear',
    :'type' => :'type',
    :'issue_number' => :'issueNumber',
    :'start_month' => :'startMonth',
    :'start_year' => :'startYear',
    :'use_as' => :'useAs',
    :'sdk_hash_value' => :'hash',
    :'tokenized_information' => :'tokenizedInformation'
  }
end

.json_mapObject

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



59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 59

def self.json_map
  {
    :'expiration_month' => :'expiration_month',
    :'expiration_year' => :'expiration_year',
    :'type' => :'type',
    :'issue_number' => :'issue_number',
    :'start_month' => :'start_month',
    :'start_year' => :'start_year',
    :'use_as' => :'use_as',
    :'sdk_hash_value' => :'hash',
    :'tokenized_information' => :'tokenized_information'
  }
end

.swagger_typesObject

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 74

def self.swagger_types
  {
    :'expiration_month' => :'String',
    :'expiration_year' => :'String',
    :'type' => :'String',
    :'issue_number' => :'String',
    :'start_month' => :'String',
    :'start_year' => :'String',
    :'use_as' => :'String',
    :'sdk_hash_value' => :'String',
    :'tokenized_information' => :'Tmsv2customersEmbeddedDefaultPaymentInstrumentCardTokenizedInformation'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



184
185
186
187
188
189
190
191
192
193
194
195
196
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 184

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      expiration_month == o.expiration_month &&
      expiration_year == o.expiration_year &&
      type == o.type &&
      issue_number == o.issue_number &&
      start_month == o.start_month &&
      start_year == o.start_year &&
      use_as == o.use_as &&
      sdk_hash_value == o.sdk_hash_value &&
      tokenized_information == o.tokenized_information
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



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
262
263
264
265
266
267
268
269
270
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 234

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 = CyberSource.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



300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 300

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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 213

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("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


200
201
202
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 200

def eql?(o)
  self == o
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



135
136
137
138
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 135

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#sdk_hash_valueObject

Hash value representing the card.



39
40
41
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 39

def hash
  @hash
end

#sdk_hash_value=(sdk_hash_value) ⇒ Object

Custom attribute writer method with validation

Parameters:

  • sdk_hash_value (Object)

    Value to be assigned



178
179
180
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 178

def sdk_hash_value=(sdk_hash_value)
  @sdk_hash_value = sdk_hash_value
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



280
281
282
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 280

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



286
287
288
289
290
291
292
293
294
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 286

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



274
275
276
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 274

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



142
143
144
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card.rb', line 142

def valid?
  true
end