Class: CyberSource::Tmsv2TokenizedCard

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Tmsv2TokenizedCard

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 106

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#card ⇒ Object

Returns the value of attribute card.



46
47
48
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 46

def card
  @card
end

#cryptogram ⇒ Object

Generated value used in conjunction with the network token for making a payment.



44
45
46
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 44

def cryptogram
  @cryptogram
end

#enrollment_id ⇒ Object

Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.



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

def enrollment_id
  @enrollment_id
end

#expiration_month ⇒ Object

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



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

def expiration_month
  @expiration_month
end

#expiration_year ⇒ Object

Four-digit year in which the network token expires. Format: ‘YYYY`.



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

def expiration_year
  @expiration_year
end

#metadata ⇒ Object

Returns the value of attribute metadata.



48
49
50
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 48

def metadata
  @metadata
end

#number ⇒ Object

The token requestors network token



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

def number
  @number
end

#reason ⇒ Object

Issuers state for the network token Possible Values: - INVALID_REQUEST : The network token provision request contained invalid data. - CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified. - CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization. - CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization. - DECLINED : Card can currently not be used with issuer for tokenization. - SERVICE_UNAVAILABLE : The network token service was unavailable or timed out. - SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration.



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

def reason
  @reason
end

#source ⇒ Object

This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data. Possible Values: - TOKEN - ISSUER - ONFILE



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

def source
  @source
end

#state ⇒ Object

State of the network token or network token provision Possible Values: - ACTIVE : Network token is active. - SUSPENDED : Network token is suspended. This state can change back to ACTIVE. - DELETED : This is a final state for a network token instance. - UNPROVISIONED : A previous network token provision was unsuccessful.



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

def state
  @state
end

#token_reference_id ⇒ Object

Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.



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

def token_reference_id
  @token_reference_id
end

#type ⇒ Object

The network token card association brand Possible Values: - visa - mastercard - americanexpress



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 51

def self.attribute_map
  {
    :'type' => :'type',
    :'source' => :'source',
    :'state' => :'state',
    :'enrollment_id' => :'enrollmentId',
    :'token_reference_id' => :'tokenReferenceId',
    :'reason' => :'reason',
    :'number' => :'number',
    :'expiration_month' => :'expirationMonth',
    :'expiration_year' => :'expirationYear',
    :'cryptogram' => :'cryptogram',
    :'card' => :'card',
    :'metadata' => :'metadata'
  }
end

.json_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 69

def self.json_map
  {
    :'type' => :'type',
    :'source' => :'source',
    :'state' => :'state',
    :'enrollment_id' => :'enrollment_id',
    :'token_reference_id' => :'token_reference_id',
    :'reason' => :'reason',
    :'number' => :'number',
    :'expiration_month' => :'expiration_month',
    :'expiration_year' => :'expiration_year',
    :'cryptogram' => :'cryptogram',
    :'card' => :'card',
    :'metadata' => :'metadata'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 87

def self.swagger_types
  {
    :'type' => :'String',
    :'source' => :'String',
    :'state' => :'String',
    :'enrollment_id' => :'String',
    :'token_reference_id' => :'String',
    :'reason' => :'String',
    :'number' => :'String',
    :'expiration_month' => :'String',
    :'expiration_year' => :'String',
    :'cryptogram' => :'String',
    :'card' => :'Tmsv2TokenizedCardCard',
    :'metadata' => :'Tmsv2TokenizedCardMetadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 188

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      source == o.source &&
      state == o.state &&
      enrollment_id == o.enrollment_id &&
      token_reference_id == o.token_reference_id &&
      reason == o.reason &&
      number == o.number &&
      expiration_month == o.expiration_month &&
      expiration_year == o.expiration_year &&
      cryptogram == o.cryptogram &&
      card == o.card &&
      metadata == o.metadata
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



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
271
272
273
274
275
276
277
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 241

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



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 307

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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 220

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


207
208
209
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 207

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



213
214
215
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 213

def hash
  [type, source, state, enrollment_id, token_reference_id, reason, number, expiration_month, expiration_year, cryptogram, card, metadata].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



163
164
165
166
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 163

def list_invalid_properties
  invalid_properties = Array.new
  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



287
288
289
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 287

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



293
294
295
296
297
298
299
300
301
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 293

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



281
282
283
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 281

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



170
171
172
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 170

def valid?
  true
end