Class: OpenapiClient::Secure3DAuthenticationRequest

Inherits:
AuthenticationRequest show all
Defined in:
lib/openapi_client/models/secure3_d_authentication_request.rb

Overview

Request authentication of the payment card using the 3DS 2.x URL redirect scheme.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from AuthenticationRequest

#authentication_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AuthenticationRequest

openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ Secure3DAuthenticationRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 117

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

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

  if attributes.key?(:'challenge_indicator')
    self.challenge_indicator = attributes[:'challenge_indicator']
  else
    self.challenge_indicator = '01'
  end

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

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

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

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

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

  if attributes.key?(:'authentication_indicator')
    self.authentication_indicator = attributes[:'authentication_indicator']
  else
    self.authentication_indicator = '01'
  end

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

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

Instance Attribute Details

#authentication_indicator ⇒ Object

Provides additional information to the ACS to determine the best approach for handling an authentication request. 01 = Payment transaction 02 = Recurring transaction 03 = Installment transaction 04 = Add card 05 = Maintain card 06 = Card holder verification as part of EMV token ID and Value



43
44
45
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 43

def authentication_indicator
  @authentication_indicator
end

#browser_java_script_enabled ⇒ Object

Indicates if the browser issuing the request is capable of performing JavaScript.



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

def browser_java_script_enabled
  @browser_java_script_enabled
end

#challenge_indicator ⇒ Object

Indicates whether or not a challenge should be performed. 01 = No preference (You have no preference whether a challenge should be performed. This is the default value) 02 = No challenge requested (You prefer that no challenge should be performed) 03 = Challenge requested: 3DS Requestor Preference (You prefer that a challenge should be performed) 04 = Challenge requested: Mandate (There are local or regional mandates that mean that a challenge must be performed) The following are applicable only for 3DS 2.2 protocol. 05 = No challenge requested (transactional risk analysis is already performed) 06 = No challenge requested (Data share only) 07 = No challenge requested (strong consumer authentication is already performed) 08 = No challenge requested (utilise whitelist exemption if no challenge required) 09 = Challenge requested (whitelist prompt requested if challenge required)



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

def challenge_indicator
  @challenge_indicator
end

#challenge_window_size ⇒ Object

Defines the size of the challenge window displayed to customers during authentication. 01 = 250 x 400 02 = 390 x 400 03 = 500 x 600 04 = 600 x 400 05 = Full screen



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

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



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

def message_category
  @message_category
end

#method_notification_url ⇒ Object

The 3DS method iframe and transaction ID will be sent here. Note this must be a valid URL (special characters should be URL-encoded).



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

def method_notification_url
  @method_notification_url
end

#recurring_expiry ⇒ Object

Date after which no further authorisations shall be performed.



46
47
48
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 46

def recurring_expiry
  @recurring_expiry
end

#recurring_frequency ⇒ Object

Indicates the minimum number of days between authorisations.



49
50
51
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 49

def recurring_frequency
  @recurring_frequency
end

#secure3_d_device_channel ⇒ Object

02 = BRW 03 = 3RI



37
38
39
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 37

def secure3_d_device_channel
  @secure3_d_device_channel
end

#secure3_d_three_ri_indicator ⇒ Object

01 = Recurring transaction 02 = Instalment transaction 03 = Add card 04 = Maintain card information 05 = Account verification 06 = Split/delayed shipment 07 = Top-up 08 = Mail Order 09 = Telephone Order 10 = Whitelist status check 11 = Other payment



40
41
42
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 40

def secure3_d_three_ri_indicator
  @secure3_d_three_ri_indicator
end

#term_url ⇒ Object

The result of the authentication will be sent to this URL. If not provided, a term URL will be dynamically generated. Note this must be a valid URL (special characters should be URL-encoded).



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

def term_url
  @term_url
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 74

def self.attribute_map
  {
    :'term_url' => :'termURL',
    :'method_notification_url' => :'methodNotificationURL',
    :'challenge_indicator' => :'challengeIndicator',
    :'message_category' => :'messageCategory',
    :'challenge_window_size' => :'challengeWindowSize',
    :'browser_java_script_enabled' => :'browserJavaScriptEnabled',
    :'secure3_d_device_channel' => :'secure3DDeviceChannel',
    :'secure3_d_three_ri_indicator' => :'secure3DThreeRIIndicator',
    :'authentication_indicator' => :'authenticationIndicator',
    :'recurring_expiry' => :'recurringExpiry',
    :'recurring_frequency' => :'recurringFrequency'
  }
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



351
352
353
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 351

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



108
109
110
111
112
113
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 108

def self.openapi_all_of
  [
  :'AuthenticationRequest',
  :'Secure3DAuthenticationRequestAllOf'
  ]
end

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 91

def self.openapi_types
  {
    :'term_url' => :'String',
    :'method_notification_url' => :'String',
    :'challenge_indicator' => :'String',
    :'message_category' => :'String',
    :'challenge_window_size' => :'String',
    :'browser_java_script_enabled' => :'Boolean',
    :'secure3_d_device_channel' => :'String',
    :'secure3_d_three_ri_indicator' => :'String',
    :'authentication_indicator' => :'String',
    :'recurring_expiry' => :'String',
    :'recurring_frequency' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 320

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      term_url == o.term_url &&
      method_notification_url == o.method_notification_url &&
      challenge_indicator == o.challenge_indicator &&
      message_category == o.message_category &&
      challenge_window_size == o.challenge_window_size &&
      browser_java_script_enabled == o.browser_java_script_enabled &&
      secure3_d_device_channel == o.secure3_d_device_channel &&
      secure3_d_three_ri_indicator == o.secure3_d_three_ri_indicator &&
      authentication_indicator == o.authentication_indicator &&
      recurring_expiry == o.recurring_expiry &&
      recurring_frequency == o.recurring_frequency && 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



380
381
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
420
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 380

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



454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 454

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



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

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


338
339
340
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 338

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



344
345
346
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 344

def hash
  [term_url, method_notification_url, challenge_indicator, message_category, challenge_window_size, browser_java_script_enabled, secure3_d_device_channel, secure3_d_three_ri_indicator, authentication_indicator, recurring_expiry, recurring_frequency].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
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 184

def list_invalid_properties
  invalid_properties = super
  if @term_url.nil?
    invalid_properties.push('invalid value for "term_url", term_url cannot be nil.')
  end

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

  pattern = Regexp.new(/^([0-9]{4})(1[0-2]|0[1-9])(3[01]|0[1-9]|[12][0-9])$/)
  if !@recurring_expiry.nil? && @recurring_expiry !~ pattern
    invalid_properties.push("invalid value for \"recurring_expiry\", must conform to the pattern #{pattern}.")
  end

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

  if !@recurring_frequency.nil? && @recurring_frequency < 1
    invalid_properties.push('invalid value for "recurring_frequency", must be greater than or equal to 1.')
  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



430
431
432
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 430

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



436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 436

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



424
425
426
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 424

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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/openapi_client/models/secure3_d_authentication_request.rb', line 212

def valid?
  return false if @term_url.nil?
  return false if @method_notification_url.nil?
  challenge_indicator_validator = EnumAttributeValidator.new('String', ["01", "02", "03", "04", "05", "06", "07", "08", "09"])
  return false unless challenge_indicator_validator.valid?(@challenge_indicator)
  message_category_validator = EnumAttributeValidator.new('String', ["01", "02", "80"])
  return false unless message_category_validator.valid?(@message_category)
  challenge_window_size_validator = EnumAttributeValidator.new('String', ["01", "02", "03", "04", "05"])
  return false unless challenge_window_size_validator.valid?(@challenge_window_size)
  secure3_d_device_channel_validator = EnumAttributeValidator.new('String', ["02", "03"])
  return false unless secure3_d_device_channel_validator.valid?(@secure3_d_device_channel)
  secure3_d_three_ri_indicator_validator = EnumAttributeValidator.new('String', ["01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11"])
  return false unless secure3_d_three_ri_indicator_validator.valid?(@secure3_d_three_ri_indicator)
  authentication_indicator_validator = EnumAttributeValidator.new('String', ["01", "02", "03", "04", "05", "06"])
  return false unless authentication_indicator_validator.valid?(@authentication_indicator)
  return false if !@recurring_expiry.nil? && @recurring_expiry !~ Regexp.new(/^([0-9]{4})(1[0-2]|0[1-9])(3[01]|0[1-9]|[12][0-9])$/)
  return false if !@recurring_frequency.nil? && @recurring_frequency > 9999
  return false if !@recurring_frequency.nil? && @recurring_frequency < 1
  true && super
end