Class: OpenapiClient::Secure3DAuthenticationRequestAllOf
- Inherits:
-
Object
- Object
- OpenapiClient::Secure3DAuthenticationRequestAllOf
- Defined in:
- lib/openapi_client/models/secure3_d_authentication_request_all_of.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#browser_java_script_enabled ⇒ Object
Indicates if the browser issuing the request is capable of performing JavaScript.
-
#challenge_indicator ⇒ Object
Indicates whether or not a challenge should be performed.
-
#challenge_window_size ⇒ Object
Defines the size of the challenge window displayed to customers during authentication.
-
#message_category ⇒ Object
Indicates the message category of 3d secure authentication version 2.X.
-
#method_notification_url ⇒ Object
The 3DS method iframe and transaction ID will be sent here.
-
#requestor_authentication_indicator ⇒ Object
Indicates whether or not a challenge should be performed.
-
#secure3_d_device_channel ⇒ Object
02 = BRW 03 = 3RI.
-
#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.
-
#term_url ⇒ Object
The result of the authentication will be sent to this URL.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Secure3DAuthenticationRequestAllOf
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Secure3DAuthenticationRequestAllOf
Initializes the object
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 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 98 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Secure3DAuthenticationRequestAllOf` 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::Secure3DAuthenticationRequestAllOf`. 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 } 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. = 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?(:'requestor_authentication_indicator') self.requestor_authentication_indicator = attributes[:'requestor_authentication_indicator'] else self.requestor_authentication_indicator = '01' end end |
Instance Attribute Details
#browser_java_script_enabled ⇒ Object
Indicates if the browser issuing the request is capable of performing JavaScript.
33 34 35 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 33 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)
24 25 26 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 24 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
30 31 32 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 30 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
27 28 29 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 27 def @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).
21 22 23 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 21 def method_notification_url @method_notification_url end |
#requestor_authentication_indicator ⇒ Object
Indicates whether or not a challenge should be performed. 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
42 43 44 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 42 def requestor_authentication_indicator @requestor_authentication_indicator end |
#secure3_d_device_channel ⇒ Object
02 = BRW 03 = 3RI
36 37 38 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 36 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
39 40 41 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 39 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).
18 19 20 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 18 def term_url @term_url end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 67 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', :'requestor_authentication_indicator' => :'requestorAuthenticationIndicator' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
278 279 280 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 278 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 82 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', :'requestor_authentication_indicator' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
249 250 251 252 253 254 255 256 257 258 259 260 261 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 249 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 && == o. && 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 && requestor_authentication_indicator == o.requestor_authentication_indicator end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 306 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
380 381 382 383 384 385 386 387 388 389 390 391 392 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 380 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
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 285 def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) return nil unless attributes.is_a?(Hash) 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
265 266 267 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 265 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
271 272 273 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 271 def hash [term_url, method_notification_url, challenge_indicator, , challenge_window_size, browser_java_script_enabled, secure3_d_device_channel, secure3_d_three_ri_indicator, requestor_authentication_indicator].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 154 def list_invalid_properties invalid_properties = Array.new 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 invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
356 357 358 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 356 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
362 363 364 365 366 367 368 369 370 371 372 373 374 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 362 def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) hash = {} 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
350 351 352 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 350 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/openapi_client/models/secure3_d_authentication_request_all_of.rb', line 169 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) = EnumAttributeValidator.new('String', ["01", "02", "80"]) return false unless .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) requestor_authentication_indicator_validator = EnumAttributeValidator.new('String', ["01", "02", "03", "04", "05", "06"]) return false unless requestor_authentication_indicator_validator.valid?(@requestor_authentication_indicator) true end |