class OpenapiClient::Secure3DAuthenticationResult
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.
Attributes
The result of authentication attempt returned by the 3D Secure authentication process (ARes).
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.
The response transaction UUID from the DS (directory server)
Indicates the message category of 3d secure authentication version 2.X. 01 = Payment
Authentication 02 = Non-Payment Authentication 80 = Mastercard Data Only
The transaction status as returned by the 3D Secure authentication process. (CRes)
The transaction identifier (XID) is a unique tracking number set by the merchant.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
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_result.rb, line 258 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::AuthenticationResult::new
# 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
List of class defined in allOf (OpenAPI v3)
# File lib/openapi_client/models/secure3_d_authentication_result.rb, line 83 def self.openapi_all_of [ :'AuthenticationResult', :'Secure3DAuthenticationResultAllOf' ] end
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# 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
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_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
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_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
Custom attribute writer method checking allowed values (enum). @param [Object] authentication_response
Object to be assigned
# File lib/openapi_client/models/secure3_d_authentication_result.rb, line 202 def authentication_response=(authentication_response) validator = EnumAttributeValidator.new('String', ["A", "N", "U", "Y", "C", "R"]) unless validator.valid?(authentication_response) fail ArgumentError, "invalid value for \"authentication_response\", must be one of #{validator.allowable_values}." end @authentication_response = authentication_response end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
OpenapiClient::AuthenticationResult::build_from_hash
# 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
Custom attribute writer method with validation @param [Object] cavv Value to be assigned
# File lib/openapi_client/models/secure3_d_authentication_result.rb, line 174 def cavv=(cavv) if !cavv.nil? && cavv.to_s.length > 32 fail ArgumentError, 'invalid value for "cavv", the character length must be smaller than or equal to 32.' end if !cavv.nil? && cavv.to_s.length < 20 fail ArgumentError, 'invalid value for "cavv", the character length must be great than or equal to 20.' end @cavv = cavv end
@see the `==` method @param [Object] Object to be compared
# File lib/openapi_client/models/secure3_d_authentication_result.rb, line 245 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_result.rb, line 251 def hash [cavv, xid, ds_transaction_id, authentication_response, transaction_status, message_category].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
OpenapiClient::AuthenticationResult#list_invalid_properties
# 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
Custom attribute writer method checking allowed values (enum). @param [Object] message_category
Object to be assigned
# File lib/openapi_client/models/secure3_d_authentication_result.rb, line 222 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
OpenapiClient::AuthenticationResult#to_hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/openapi_client/models/secure3_d_authentication_result.rb, line 331 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] transaction_status
Object to be assigned
# File lib/openapi_client/models/secure3_d_authentication_result.rb, line 212 def transaction_status=(transaction_status) validator = EnumAttributeValidator.new('String', ["A", "N", "U", "Y", "C", "R"]) unless validator.valid?(transaction_status) fail ArgumentError, "invalid value for \"transaction_status\", must be one of #{validator.allowable_values}." end @transaction_status = transaction_status end
Check to see if the all the properties in the model are valid @return true if the model is valid
OpenapiClient::AuthenticationResult#valid?
# 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
Custom attribute writer method with validation @param [Object] xid Value to be assigned
# File lib/openapi_client/models/secure3_d_authentication_result.rb, line 188 def xid=(xid) if !xid.nil? && xid.to_s.length > 32 fail ArgumentError, 'invalid value for "xid", the character length must be smaller than or equal to 32.' end if !xid.nil? && xid.to_s.length < 20 fail ArgumentError, 'invalid value for "xid", the character length must be great than or equal to 20.' end @xid = xid end