first_data_gateway 1.2.0 → 1.7.0

data/lib/openapi_client/models/{secure3d_authentication_result.rb → secure3_d10_authentication_result_all_of.rb}

@@ -3,7 +3,7 @@
 
 #The documentation here is designed to provide all of the technical guidance required to consume and integrate with our APIs for payment processing. To learn more about our APIs please visit https://docs.firstdata.com/org/gateway.
 
-OpenAPI spec version: 6.6.0.20190329.001
+The version of the OpenAPI document: 6.12.0.20200605.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset
@@ -13,11 +13,7 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
-  # Submit the result of the authentication managed outside of the gateway. For more convenient usage without implementing 3-D Secure yourself see \"authenticationRequest\" section.
-  class Secure3dAuthenticationResult
-    # Indicates what kind of authentication scheme the merchant wants to use on the card.
-    attr_accessor :request_type
-
+  class Secure3D10AuthenticationResultAllOf
     # Card enrollment result from the Verification Response (VeRes).
     attr_accessor :verification_response
 
@@ -25,7 +21,7 @@ module OpenapiClient
     attr_accessor :authentication_attempt_result
 
     # 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.
-    attr_accessor :authentication_value
+    attr_accessor :cavv
 
     # The transaction identifier (XID) is a unique tracking number set by the merchant.
     attr_accessor :xid
@@ -55,10 +51,9 @@ module OpenapiClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'request_type' => :'requestType',
         :'verification_response' => :'verificationResponse',
         :'authentication_attempt_result' => :'authenticationAttemptResult',
-        :'authentication_value' => :'authenticationValue',
+        :'cavv' => :'cavv',
         :'xid' => :'xid'
       }
     end
@@ -66,39 +61,47 @@ module OpenapiClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'request_type' => :'String',
         :'verification_response' => :'String',
         :'authentication_attempt_result' => :'String',
-        :'authentication_value' => :'String',
+        :'cavv' => :'String',
         :'xid' => :'String'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
-
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
-
-      if attributes.has_key?(:'requestType')
-        self.request_type = attributes[:'requestType']
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Secure3D10AuthenticationResultAllOf` initialize method"
       end
 
-      if attributes.has_key?(:'verificationResponse')
-        self.verification_response = attributes[:'verificationResponse']
+      # 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::Secure3D10AuthenticationResultAllOf`. 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?(:'verification_response')
+        self.verification_response = attributes[:'verification_response']
       end
 
-      if attributes.has_key?(:'authenticationAttemptResult')
-        self.authentication_attempt_result = attributes[:'authenticationAttemptResult']
+      if attributes.key?(:'authentication_attempt_result')
+        self.authentication_attempt_result = attributes[:'authentication_attempt_result']
       end
 
-      if attributes.has_key?(:'authenticationValue')
-        self.authentication_value = attributes[:'authenticationValue']
+      if attributes.key?(:'cavv')
+        self.cavv = attributes[:'cavv']
       end
 
-      if attributes.has_key?(:'xid')
+      if attributes.key?(:'xid')
         self.xid = attributes[:'xid']
       end
     end
@@ -107,16 +110,12 @@ module OpenapiClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @request_type.nil?
-        invalid_properties.push('invalid value for "request_type", request_type cannot be nil.')
+      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 !@authentication_value.nil? && @authentication_value.to_s.length > 32
-        invalid_properties.push('invalid value for "authentication_value", the character length must be smaller than or equal to 32.')
-      end
-
-      if !@authentication_value.nil? && @authentication_value.to_s.length < 20
-        invalid_properties.push('invalid value for "authentication_value", the character length must be great than or equal to 20.')
+      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
@@ -133,13 +132,12 @@ module OpenapiClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @request_type.nil?
-      verification_response_validator = EnumAttributeValidator.new('String', ['Y', 'N', 'U'])
+      verification_response_validator = EnumAttributeValidator.new('String', ["Y", "N", "U"])
       return false unless verification_response_validator.valid?(@verification_response)
-      authentication_attempt_result_validator = EnumAttributeValidator.new('String', ['Y', 'N', 'U', 'A'])
+      authentication_attempt_result_validator = EnumAttributeValidator.new('String', ["Y", "N", "U", "A"])
       return false unless authentication_attempt_result_validator.valid?(@authentication_attempt_result)
-      return false if !@authentication_value.nil? && @authentication_value.to_s.length > 32
-      return false if !@authentication_value.nil? && @authentication_value.to_s.length < 20
+      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
       true
@@ -148,9 +146,9 @@ module OpenapiClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] verification_response Object to be assigned
     def verification_response=(verification_response)
-      validator = EnumAttributeValidator.new('String', ['Y', 'N', 'U'])
+      validator = EnumAttributeValidator.new('String', ["Y", "N", "U"])
       unless validator.valid?(verification_response)
-        fail ArgumentError, 'invalid value for "verification_response", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"verification_response\", must be one of #{validator.allowable_values}."
       end
       @verification_response = verification_response
     end
@@ -158,25 +156,25 @@ module OpenapiClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] authentication_attempt_result Object to be assigned
     def authentication_attempt_result=(authentication_attempt_result)
-      validator = EnumAttributeValidator.new('String', ['Y', 'N', 'U', 'A'])
+      validator = EnumAttributeValidator.new('String', ["Y", "N", "U", "A"])
       unless validator.valid?(authentication_attempt_result)
-        fail ArgumentError, 'invalid value for "authentication_attempt_result", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"authentication_attempt_result\", must be one of #{validator.allowable_values}."
       end
       @authentication_attempt_result = authentication_attempt_result
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] authentication_value Value to be assigned
-    def authentication_value=(authentication_value)
-      if !authentication_value.nil? && authentication_value.to_s.length > 32
-        fail ArgumentError, 'invalid value for "authentication_value", the character length must be smaller than or equal to 32.'
+    # @param [Object] cavv Value to be assigned
+    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 !authentication_value.nil? && authentication_value.to_s.length < 20
-        fail ArgumentError, 'invalid value for "authentication_value", the character length must be great than or equal to 20.'
+      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
 
-      @authentication_value = authentication_value
+      @cavv = cavv
     end
 
     # Custom attribute writer method with validation
@@ -198,10 +196,9 @@ module OpenapiClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          request_type == o.request_type &&
           verification_response == o.verification_response &&
           authentication_attempt_result == o.authentication_attempt_result &&
-          authentication_value == o.authentication_value &&
+          cavv == o.cavv &&
           xid == o.xid
     end
 
@@ -212,25 +209,32 @@ module OpenapiClient
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [request_type, verification_response, authentication_attempt_result, authentication_value, xid].hash
+      [verification_response, authentication_attempt_result, cavv, xid].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
     end
 
     # Builds the object from hash
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
+    def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
       return nil unless attributes.is_a?(Hash)
-      self.class.openapi_types.each_pair do |key, type|
+      openapi_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
+          # 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) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[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]]))
+        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
 
@@ -253,7 +257,7 @@ module OpenapiClient
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -274,8 +278,12 @@ module OpenapiClient
           end
         end
       else # model
-        temp_model = OpenapiClient.const_get(type).new
-        temp_model.build_from_hash(value)
+        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
 
@@ -293,11 +301,15 @@ module OpenapiClient
 
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
-    def to_hash
+    def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = self.class.openapi_nullable)
       hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
+      attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        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

data/lib/openapi_client/models/secure3_d10_authentication_update_request.rb

@@ -0,0 +1,297 @@
+=begin
+#Payment Gateway API Specification.
+
+#The documentation here is designed to provide all of the technical guidance required to consume and integrate with our APIs for payment processing. To learn more about our APIs please visit https://docs.firstdata.com/org/gateway.
+
+The version of the OpenAPI document: 6.12.0.20200605.001
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: unset
+
+=end
+
+require 'date'
+
+module OpenapiClient
+  # Authentication update request specific to 3DSecure 1.0 transactions.
+  class Secure3D10AuthenticationUpdateRequest < AuthenticationUpdateRequest
+    # A formatted message providing results of the issuer’s cardholder authentication.
+    attr_accessor :payer_authentication_response
+
+    # Formatted string encoding transaction time, order ID, and return URL data.
+    attr_accessor :merchant_data
+
+    # Card security code if required by merchant.
+    attr_accessor :security_code
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'payer_authentication_response' => :'payerAuthenticationResponse',
+        :'merchant_data' => :'merchantData',
+        :'security_code' => :'securityCode'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'payer_authentication_response' => :'String',
+        :'merchant_data' => :'String',
+        :'security_code' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'AuthenticationUpdateRequest',
+      :'Secure3D10AuthenticationUpdateRequestAllOf'
+      ]
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Secure3D10AuthenticationUpdateRequest` 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::Secure3D10AuthenticationUpdateRequest`. 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?(:'payer_authentication_response')
+        self.payer_authentication_response = attributes[:'payer_authentication_response']
+      end
+
+      if attributes.key?(:'merchant_data')
+        self.merchant_data = attributes[:'merchant_data']
+      end
+
+      if attributes.key?(:'security_code')
+        self.security_code = attributes[:'security_code']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = super
+      if @payer_authentication_response.nil?
+        invalid_properties.push('invalid value for "payer_authentication_response", payer_authentication_response cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^(?!\s*$).+/)
+      if @payer_authentication_response !~ pattern
+        invalid_properties.push("invalid value for \"payer_authentication_response\", must conform to the pattern #{pattern}.")
+      end
+
+      if @merchant_data.nil?
+        invalid_properties.push('invalid value for "merchant_data", merchant_data cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^(?!\s*$).+/)
+      if @merchant_data !~ pattern
+        invalid_properties.push("invalid value for \"merchant_data\", must conform to the pattern #{pattern}.")
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @payer_authentication_response.nil?
+      return false if @payer_authentication_response !~ Regexp.new(/^(?!\s*$).+/)
+      return false if @merchant_data.nil?
+      return false if @merchant_data !~ Regexp.new(/^(?!\s*$).+/)
+      true && super
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] payer_authentication_response Value to be assigned
+    def payer_authentication_response=(payer_authentication_response)
+      if payer_authentication_response.nil?
+        fail ArgumentError, 'payer_authentication_response cannot be nil'
+      end
+
+      pattern = Regexp.new(/^(?!\s*$).+/)
+      if payer_authentication_response !~ pattern
+        fail ArgumentError, "invalid value for \"payer_authentication_response\", must conform to the pattern #{pattern}."
+      end
+
+      @payer_authentication_response = payer_authentication_response
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] merchant_data Value to be assigned
+    def merchant_data=(merchant_data)
+      if merchant_data.nil?
+        fail ArgumentError, 'merchant_data cannot be nil'
+      end
+
+      pattern = Regexp.new(/^(?!\s*$).+/)
+      if merchant_data !~ pattern
+        fail ArgumentError, "invalid value for \"merchant_data\", must conform to the pattern #{pattern}."
+      end
+
+      @merchant_data = merchant_data
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          payer_authentication_response == o.payer_authentication_response &&
+          merchant_data == o.merchant_data &&
+          security_code == o.security_code && super(o)
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [payer_authentication_response, merchant_data, security_code].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = self.class.openapi_nullable)
+      hash = super(self.class.superclass.attribute_map, self.class.superclass.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
+
+    # 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
+    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
+  end
+end