Class: OpenapiClient::Secure3DAuthenticationResult

Inherits:
AuthenticationResult show all
Defined in:
lib/openapi_client/models/secure3_d_authentication_result.rb

Overview

Submit the result of the authentication managed outside of the gateway for a 3-D Secure 2.x scheme. For more convenient usage without implementing 3-D Secure yourself see "authenticationRequest" section.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from AuthenticationResult

#authentication_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AuthenticationResult

openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ Secure3DAuthenticationResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/openapi_client/models/secure3_d_authentication_result.rb', line 92

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Secure3DAuthenticationResult` 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 `OpenapiClient::Secure3DAuthenticationResult`. 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
  }

  # call parent's initialize
  super(attributes)

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

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

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

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

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

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

Instance Attribute Details

#authentication_response ⇒ Object

The result of authentication attempt returned by the 3D Secure authentication process (ARes).



28
29
30
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 28

def authentication_response
  @authentication_response
end

#cavv ⇒ Object

The Cardholder Authentication Verification Value (CAVV) is a cryptographic value derived by the issuer during payment authentication that can provide evidence of the results of payment authentication during an online purchase.



19
20
21
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 19

def cavv
  @cavv
end

#ds_transaction_id ⇒ Object

The response transaction UUID from the DS (directory server)



25
26
27
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 25

def ds_transaction_id
  @ds_transaction_id
end

#message_category ⇒ Object

Indicates the message category of 3d secure authentication version 2.X. 01 = Payment Authentication 02 = Non-Payment Authentication 80 = Mastercard Data Only



34
35
36
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 34

def message_category
  @message_category
end

#transaction_status ⇒ Object

The transaction status as returned by the 3D Secure authentication process. (CRes)



31
32
33
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 31

def transaction_status
  @transaction_status
end

#xid ⇒ Object

The transaction identifier (XID) is a unique tracking number set by the merchant.



22
23
24
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 22

def xid
  @xid
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 59

def self.attribute_map
  {
    :'cavv' => :'cavv',
    :'xid' => :'xid',
    :'ds_transaction_id' => :'dsTransactionId',
    :'authentication_response' => :'authenticationResponse',
    :'transaction_status' => :'transactionStatus',
    :'message_category' => :'messageCategory'
  }
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



258
259
260
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 258

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



83
84
85
86
87
88
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 83

def self.openapi_all_of
  [
  :'AuthenticationResult',
  :'Secure3DAuthenticationResultAllOf'
  ]
end

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 71

def self.openapi_types
  {
    :'cavv' => :'String',
    :'xid' => :'String',
    :'ds_transaction_id' => :'String',
    :'authentication_response' => :'String',
    :'transaction_status' => :'String',
    :'message_category' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



232
233
234
235
236
237
238
239
240
241
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 232

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cavv == o.cavv &&
      xid == o.xid &&
      ds_transaction_id == o.ds_transaction_id &&
      authentication_response == o.authentication_response &&
      transaction_status == o.transaction_status &&
      message_category == o.message_category && super(o)
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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 287

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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    klass.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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 361

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, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 265

def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  super(attributes, self.class.superclass.attribute_map, self.class.superclass.openapi_types)
  openapi_types.each_pair do |key, type|
    if 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)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[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


245
246
247
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



251
252
253
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 251

def hash
  [cavv, xid, ds_transaction_id, authentication_response, transaction_status, message_category].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



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 135

def list_invalid_properties
  invalid_properties = super
  if !@cavv.nil? && @cavv.to_s.length > 32
    invalid_properties.push('invalid value for "cavv", the character length must be smaller than or equal to 32.')
  end

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

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

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



337
338
339
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 337

def to_body
  to_hash
end

#to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 343

def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
  hash = super(self.class.superclass.attribute_map, openapi_nullable)
  attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = 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



331
332
333
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 331

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



158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/openapi_client/models/secure3_d_authentication_result.rb', line 158

def valid?
  return false if !@cavv.nil? && @cavv.to_s.length > 32
  return false if !@cavv.nil? && @cavv.to_s.length < 20
  return false if !@xid.nil? && @xid.to_s.length > 32
  return false if !@xid.nil? && @xid.to_s.length < 20
  authentication_response_validator = EnumAttributeValidator.new('String', ["A", "N", "U", "Y", "C", "R"])
  return false unless authentication_response_validator.valid?(@authentication_response)
  transaction_status_validator = EnumAttributeValidator.new('String', ["A", "N", "U", "Y", "C", "R"])
  return false unless transaction_status_validator.valid?(@transaction_status)
  message_category_validator = EnumAttributeValidator.new('String', ["01", "02", "80"])
  return false unless message_category_validator.valid?(@message_category)
  true && super
end