first_data_gateway 1.9.0 → 1.10.0

data/lib/openapi_client/models/secure3_d10_authentication_result.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.
 
-The version of the OpenAPI document: 6.14.0.20201015.001
+The version of the OpenAPI document: 21.1.0.20210122.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1
@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.1.1
 require 'date'
 
 module OpenapiClient
-  # Submit the result of the authentication managed outside of the gateway for a 3-D Secure 1.0 scheme. For more convenient usage without implementing 3-D Secure yourself see \"authenticationRequest\" section.
+  # Submit the result of the authentication managed outside of the gateway for a 3-D Secure 1.0 scheme. For more convenient usage without implementing 3-D Secure yourself see \"authenticationRequest\" section. DEPRECATED - use Secure3DAuthenticationResult instead
   class Secure3D10AuthenticationResult < AuthenticationResult
     # Card enrollment result from the Verification Response (VeRes).
     attr_accessor :verification_response

data/lib/openapi_client/models/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.
 
-The version of the OpenAPI document: 6.14.0.20201015.001
+The version of the OpenAPI document: 21.1.0.20210122.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1

data/lib/openapi_client/models/secure3_d10_authentication_update_request.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.
 
-The version of the OpenAPI document: 6.14.0.20201015.001
+The version of the OpenAPI document: 21.1.0.20210122.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1
@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.1.1
 require 'date'
 
 module OpenapiClient
-  # Authentication update request specific to 3DSecure 1.0 transactions.
+  # Authentication update request specific to 3DSecure 1.0 transactions. DEPRECATED - use Secure3DAuthenticationUpdateRequest instead
   class Secure3D10AuthenticationUpdateRequest < AuthenticationUpdateRequest
     # A formatted message providing results of the issuer’s cardholder authentication.
     attr_accessor :payer_authentication_response

data/lib/openapi_client/models/secure3_d10_authentication_update_request_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.
 
-The version of the OpenAPI document: 6.14.0.20201015.001
+The version of the OpenAPI document: 21.1.0.20210122.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1

data/lib/openapi_client/models/secure3_d21_authentication_request.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.
 
-The version of the OpenAPI document: 6.14.0.20201015.001
+The version of the OpenAPI document: 21.1.0.20210122.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1
@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.1.1
 require 'date'
 
 module OpenapiClient
-  # Request authentication of the payment card using the 3DS 2.x URL redirect scheme.
+  # Request authentication of the payment card using the 3DS 2.x URL redirect scheme. DEPRECATED - use Secure3DAuthenticationRequest instead
   class Secure3D21AuthenticationRequest < AuthenticationRequest
     # 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).
     attr_accessor :term_url

data/lib/openapi_client/models/secure3_d21_authentication_request_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.
 
-The version of the OpenAPI document: 6.14.0.20201015.001
+The version of the OpenAPI document: 21.1.0.20210122.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1

data/lib/openapi_client/models/secure3_d21_authentication_result.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.
 
-The version of the OpenAPI document: 6.14.0.20201015.001
+The version of the OpenAPI document: 21.1.0.20210122.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1
@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.1.1
 require 'date'
 
 module OpenapiClient
-  # 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.
+  # 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. DEPRECATED - use Secure3DAuthenticationResult instead
   class Secure3D21AuthenticationResult < AuthenticationResult
     # 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 :cavv

data/lib/openapi_client/models/secure3_d21_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.
 
-The version of the OpenAPI document: 6.14.0.20201015.001
+The version of the OpenAPI document: 21.1.0.20210122.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1

data/lib/openapi_client/models/secure3_d21_authentication_update_request.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.
 
-The version of the OpenAPI document: 6.14.0.20201015.001
+The version of the OpenAPI document: 21.1.0.20210122.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1
@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.1.1
 require 'date'
 
 module OpenapiClient
-  # Authentication update request specific to 3DSecure 2.x transactions.
+  # Authentication update request specific to 3DSecure 2.x transactions. DEPRECATED - use Secure3DAuthenticationUpdateRequest instead
   class Secure3D21AuthenticationUpdateRequest < AuthenticationUpdateRequest
     # Indicates how the merchant received the 3DS method.
     attr_accessor :method_notification_status

data/lib/openapi_client/models/secure3_d21_authentication_update_request_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.
 
-The version of the OpenAPI document: 6.14.0.20201015.001
+The version of the OpenAPI document: 21.1.0.20210122.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1

data/lib/openapi_client/models/secure3_d_authentication_request.rb

@@ -0,0 +1,329 @@
+=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: 21.1.0.20210122.001
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.1
+
+=end
+
+require 'date'
+
+module OpenapiClient
+  # Request authentication of the payment card using the 3DS 2.x URL redirect scheme.
+  class Secure3DAuthenticationRequest < AuthenticationRequest
+    # 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).
+    attr_accessor :term_url
+
+    # The 3DS method iframe and transaction ID will be sent here. Note this must be a valid URL (special characters should be URL-encoded).
+    attr_accessor :method_notification_url
+
+    # 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) 
+    attr_accessor :challenge_indicator
+
+    # Indicates the message category of 3d secure authentication version 2.X. 01 = Payment Authentication 02 = Non-Payment Authentication 80 = Mastercard Data Only 
+    attr_accessor :message_category
+
+    # 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 
+    attr_accessor :challenge_window_size
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'term_url' => :'termURL',
+        :'method_notification_url' => :'methodNotificationURL',
+        :'challenge_indicator' => :'challengeIndicator',
+        :'message_category' => :'messageCategory',
+        :'challenge_window_size' => :'challengeWindowSize'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'term_url' => :'String',
+        :'method_notification_url' => :'String',
+        :'challenge_indicator' => :'String',
+        :'message_category' => :'String',
+        :'challenge_window_size' => :'String'
+      }
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'AuthenticationRequest',
+      :'Secure3DAuthenticationRequestAllOf'
+      ]
+    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::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
+    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 @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
+
+    # 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 @term_url.nil?
+      return false if @method_notification_url.nil?
+      challenge_indicator_validator = EnumAttributeValidator.new('String', ["01", "02", "03", "04"])
+      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)
+      true && super
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] challenge_indicator Object to be assigned
+    def challenge_indicator=(challenge_indicator)
+      validator = EnumAttributeValidator.new('String', ["01", "02", "03", "04"])
+      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] message_category Object to be assigned
+    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] challenge_window_size Object to be assigned
+    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
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    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 && 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
+      [term_url, method_notification_url, challenge_indicator, message_category, challenge_window_size].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 = 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
+
+    # 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