class OpenapiClient::Secure3DAuthenticationRequest
Request authentication of the payment card using the 3DS 2.x URL redirect scheme.
Attributes
Indicates if the browser issuing the request is capable of performing JavaScript.
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)
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
Indicates the message category of 3d secure authentication version 2.X. 01 = Payment
Authentication 02 = Non-Payment Authentication 80 = Mastercard Data Only
The 3DS method iframe and transaction ID will be sent here. Note this must be a valid URL (special characters should be URL-encoded).
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).
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/openapi_client/models/secure3_d_authentication_request.rb, line 62 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', :'requestor_authentication_indicator' => :'requestorAuthenticationIndicator' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/openapi_client/models/secure3_d_authentication_request.rb, line 246 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
OpenapiClient::AuthenticationRequest::new
# File lib/openapi_client/models/secure3_d_authentication_request.rb, line 97 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?(:'requestor_authentication_indicator') self.requestor_authentication_indicator = attributes[:'requestor_authentication_indicator'] else self.requestor_authentication_indicator = '01' end end
List of class defined in allOf (OpenAPI v3)
# File lib/openapi_client/models/secure3_d_authentication_request.rb, line 88 def self.openapi_all_of [ :'AuthenticationRequest', :'Secure3DAuthenticationRequestAllOf' ] end
Attribute type mapping.
# File lib/openapi_client/models/secure3_d_authentication_request.rb, line 75 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', :'requestor_authentication_indicator' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/openapi_client/models/secure3_d_authentication_request.rb, line 219 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 && requestor_authentication_indicator == o.requestor_authentication_indicator && super(o) end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/openapi_client/models/secure3_d_authentication_request.rb, line 275 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/openapi_client/models/secure3_d_authentication_request.rb, line 349 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
OpenapiClient::AuthenticationRequest::build_from_hash
# File lib/openapi_client/models/secure3_d_authentication_request.rb, line 253 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
Custom attribute writer method checking allowed values (enum). @param [Object] challenge_indicator
Object to be assigned
# File lib/openapi_client/models/secure3_d_authentication_request.rb, line 179 def challenge_indicator=(challenge_indicator) validator = EnumAttributeValidator.new('String', ["01", "02", "03", "04", "05", "06", "07", "08", "09"]) unless validator.valid?(challenge_indicator) fail ArgumentError, "invalid value for \"challenge_indicator\", must be one of #{validator.allowable_values}." end @challenge_indicator = challenge_indicator end
Custom attribute writer method checking allowed values (enum). @param [Object] challenge_window_size
Object to be assigned
# File lib/openapi_client/models/secure3_d_authentication_request.rb, line 199 def challenge_window_size=(challenge_window_size) validator = EnumAttributeValidator.new('String', ["01", "02", "03", "04", "05"]) unless validator.valid?(challenge_window_size) fail ArgumentError, "invalid value for \"challenge_window_size\", must be one of #{validator.allowable_values}." end @challenge_window_size = challenge_window_size end
@see the `==` method @param [Object] Object to be compared
# File lib/openapi_client/models/secure3_d_authentication_request.rb, line 233 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/openapi_client/models/secure3_d_authentication_request.rb, line 239 def hash [term_url, method_notification_url, challenge_indicator, message_category, challenge_window_size, browser_java_script_enabled, requestor_authentication_indicator].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
OpenapiClient::AuthenticationRequest#list_invalid_properties
# File lib/openapi_client/models/secure3_d_authentication_request.rb, line 148 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 invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] message_category
Object to be assigned
# File lib/openapi_client/models/secure3_d_authentication_request.rb, line 189 def message_category=(message_category) validator = EnumAttributeValidator.new('String', ["01", "02", "80"]) unless validator.valid?(message_category) fail ArgumentError, "invalid value for \"message_category\", must be one of #{validator.allowable_values}." end @message_category = message_category end
Custom attribute writer method checking allowed values (enum). @param [Object] requestor_authentication_indicator
Object to be assigned
# File lib/openapi_client/models/secure3_d_authentication_request.rb, line 209 def requestor_authentication_indicator=(requestor_authentication_indicator) validator = EnumAttributeValidator.new('String', ["01", "02", "03", "04", "05", "06"]) unless validator.valid?(requestor_authentication_indicator) fail ArgumentError, "invalid value for \"requestor_authentication_indicator\", must be one of #{validator.allowable_values}." end @requestor_authentication_indicator = requestor_authentication_indicator end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
OpenapiClient::AuthenticationRequest#to_hash
# File lib/openapi_client/models/secure3_d_authentication_request.rb, line 331 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/openapi_client/models/secure3_d_authentication_request.rb, line 319 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
OpenapiClient::AuthenticationRequest#valid?
# File lib/openapi_client/models/secure3_d_authentication_request.rb, line 163 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) 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 && super end