Class: OpenapiClient::Secure3D21AuthenticationRequest

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

Overview

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AuthenticationRequest

openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ Secure3D21AuthenticationRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



87
88
89
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
 
# File 'lib/openapi_client/models/secure3_d21_authentication_request.rb', line 87

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

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

Instance Attribute Details

#authentication_type ⇒ Object

Indicates what kind of authentication scheme the merchant wants to use on the card.



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

def authentication_type
  @authentication_type
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)



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

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_d21_authentication_request.rb', line 31

def challenge_window_size
  @challenge_window_size
end

#method_notification_url ⇒ Object

The 3DS method iframe and transaction ID will be sent here.



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

def method_notification_url
  @method_notification_url
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.



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

def term_url
  @term_url
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
 
# File 'lib/openapi_client/models/secure3_d21_authentication_request.rb', line 56

def self.attribute_map
  {
    :'authentication_type' => :'authenticationType',
    :'term_url' => :'termURL',
    :'method_notification_url' => :'methodNotificationURL',
    :'challenge_indicator' => :'challengeIndicator',
    :'challenge_window_size' => :'challengeWindowSize'
  }
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



190
191
192
 
# File 'lib/openapi_client/models/secure3_d21_authentication_request.rb', line 190

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



78
79
80
81
82
83
 
# File 'lib/openapi_client/models/secure3_d21_authentication_request.rb', line 78

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

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
 
# File 'lib/openapi_client/models/secure3_d21_authentication_request.rb', line 67

def self.openapi_types
  {
    :'authentication_type' => :'String',
    :'term_url' => :'String',
    :'method_notification_url' => :'String',
    :'challenge_indicator' => :'String',
    :'challenge_window_size' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



165
166
167
168
169
170
171
172
173
 
# File 'lib/openapi_client/models/secure3_d21_authentication_request.rb', line 165

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authentication_type == o.authentication_type &&
      term_url == o.term_url &&
      method_notification_url == o.method_notification_url &&
      challenge_indicator == o.challenge_indicator &&
      challenge_window_size == o.challenge_window_size && 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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/openapi_client/models/secure3_d21_authentication_request.rb', line 219

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
    OpenapiClient.const_get(type).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



284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/openapi_client/models/secure3_d21_authentication_request.rb', line 284

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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/openapi_client/models/secure3_d21_authentication_request.rb', line 197

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


177
178
179
 
# File 'lib/openapi_client/models/secure3_d21_authentication_request.rb', line 177

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



183
184
185
 
# File 'lib/openapi_client/models/secure3_d21_authentication_request.rb', line 183

def hash
  [authentication_type, term_url, method_notification_url, challenge_indicator, challenge_window_size].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



128
129
130
131
 
# File 'lib/openapi_client/models/secure3_d21_authentication_request.rb', line 128

def list_invalid_properties
  invalid_properties = super
  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



264
265
266
 
# File 'lib/openapi_client/models/secure3_d21_authentication_request.rb', line 264

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



270
271
272
273
274
275
276
277
278
 
# File 'lib/openapi_client/models/secure3_d21_authentication_request.rb', line 270

def to_hash
  hash = super
  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



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

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



135
136
137
138
139
140
141
 
# File 'lib/openapi_client/models/secure3_d21_authentication_request.rb', line 135

def valid?
  challenge_indicator_validator = EnumAttributeValidator.new('String', ["01", "02", "03", "04"])
  return false unless challenge_indicator_validator.valid?(@challenge_indicator)
  challenge_window_size_validator = EnumAttributeValidator.new('String', ["01", "02", "03", "04", "05"])
  return false unless challenge_window_size_validator.valid?(@challenge_window_size)
  true && super
end