first_data_gateway 1.1.0 → 1.2.0

data/lib/openapi_client/models/secure3d_authentication_request.rb

@@ -0,0 +1,190 @@
+=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.
+
+OpenAPI spec version: 6.6.0.20190329.001
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: unset
+
+=end
+
+require 'date'
+
+module OpenapiClient
+  # Request authentication of the payment card using the 3DS URL redirect scheme.
+  class Secure3dAuthenticationRequest
+    # Indicates what kind of authentication scheme the merchant wants to use on the card.
+    attr_accessor :request_type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'request_type' => :'requestType'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'request_type' => :'String'
+      }
+    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']
+      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 = Array.new
+      if @request_type.nil?
+        invalid_properties.push('invalid value for "request_type", request_type 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 @request_type.nil?
+      true
+    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 &&
+          request_type == o.request_type
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [request_type].hash
+    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)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the 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) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.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
+        temp_model = OpenapiClient.const_get(type).new
+        temp_model.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
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        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

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

@@ -1,9 +1,9 @@
 =begin
 #Payment Gateway API Specification.
 
-#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
+#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.4.0.20181018.001
+OpenAPI spec version: 6.6.0.20190329.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset
@@ -13,21 +13,21 @@ 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 PaymentCardAuthenticationResult
-    # Type of authentication result. For example, 3-D Secure.
-    attr_accessor :type
+  # 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
 
-    # Card enrollment result from the Verification Response (VeRes)
+    # Card enrollment result from the Verification Response (VeRes).
     attr_accessor :verification_response
 
-    # Payer authentication result from Payment Authentication Response (PaRes)
-    attr_accessor :payer_authentication_response
+    # Result of authentication attempt from Payer Authentication Response (PaRes).
+    attr_accessor :authentication_attempt_result
 
-    # Cardholder Authentication Verification Value (CAVV)
+    # 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
 
-    # Authentication ID
+    # The transaction identifier (XID) is a unique tracking number set by the merchant.
     attr_accessor :xid
 
     class EnumAttributeValidator
@@ -55,9 +55,9 @@ module OpenapiClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'type' => :'type',
+        :'request_type' => :'requestType',
         :'verification_response' => :'verificationResponse',
-        :'payer_authentication_response' => :'payerAuthenticationResponse',
+        :'authentication_attempt_result' => :'authenticationAttemptResult',
         :'authentication_value' => :'authenticationValue',
         :'xid' => :'xid'
       }
@@ -66,9 +66,9 @@ module OpenapiClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'type' => :'String',
+        :'request_type' => :'String',
         :'verification_response' => :'String',
-        :'payer_authentication_response' => :'String',
+        :'authentication_attempt_result' => :'String',
         :'authentication_value' => :'String',
         :'xid' => :'String'
       }
@@ -82,16 +82,16 @@ module OpenapiClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'type')
-        self.type = attributes[:'type']
+      if attributes.has_key?(:'requestType')
+        self.request_type = attributes[:'requestType']
       end
 
       if attributes.has_key?(:'verificationResponse')
         self.verification_response = attributes[:'verificationResponse']
       end
 
-      if attributes.has_key?(:'payerAuthenticationResponse')
-        self.payer_authentication_response = attributes[:'payerAuthenticationResponse']
+      if attributes.has_key?(:'authenticationAttemptResult')
+        self.authentication_attempt_result = attributes[:'authenticationAttemptResult']
       end
 
       if attributes.has_key?(:'authenticationValue')
@@ -107,6 +107,10 @@ 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.')
+      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
@@ -129,12 +133,11 @@ module OpenapiClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      type_validator = EnumAttributeValidator.new('String', ['SECURE_3D'])
-      return false unless type_validator.valid?(@type)
+      return false if @request_type.nil?
       verification_response_validator = EnumAttributeValidator.new('String', ['Y', 'N', 'U'])
       return false unless verification_response_validator.valid?(@verification_response)
-      payer_authentication_response_validator = EnumAttributeValidator.new('String', ['Y', 'N', 'U', 'A'])
-      return false unless payer_authentication_response_validator.valid?(@payer_authentication_response)
+      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 !@xid.nil? && @xid.to_s.length > 32
@@ -142,16 +145,6 @@ module OpenapiClient
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] type Object to be assigned
-    def type=(type)
-      validator = EnumAttributeValidator.new('String', ['SECURE_3D'])
-      unless validator.valid?(type)
-        fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
-      end
-      @type = type
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] verification_response Object to be assigned
     def verification_response=(verification_response)
@@ -163,13 +156,13 @@ module OpenapiClient
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] payer_authentication_response Object to be assigned
-    def payer_authentication_response=(payer_authentication_response)
+    # @param [Object] authentication_attempt_result Object to be assigned
+    def authentication_attempt_result=(authentication_attempt_result)
       validator = EnumAttributeValidator.new('String', ['Y', 'N', 'U', 'A'])
-      unless validator.valid?(payer_authentication_response)
-        fail ArgumentError, 'invalid value for "payer_authentication_response", must be one of #{validator.allowable_values}.'
+      unless validator.valid?(authentication_attempt_result)
+        fail ArgumentError, 'invalid value for "authentication_attempt_result", must be one of #{validator.allowable_values}.'
       end
-      @payer_authentication_response = payer_authentication_response
+      @authentication_attempt_result = authentication_attempt_result
     end
 
     # Custom attribute writer method with validation
@@ -205,9 +198,9 @@ module OpenapiClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          type == o.type &&
+          request_type == o.request_type &&
           verification_response == o.verification_response &&
-          payer_authentication_response == o.payer_authentication_response &&
+          authentication_attempt_result == o.authentication_attempt_result &&
           authentication_value == o.authentication_value &&
           xid == o.xid
     end
@@ -221,7 +214,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [type, verification_response, payer_authentication_response, authentication_value, xid].hash
+      [request_type, verification_response, authentication_attempt_result, authentication_value, xid].hash
     end
 
     # Builds the object from hash

data/lib/openapi_client/models/secure3d_authentication_verification_request.rb

@@ -0,0 +1,264 @@
+=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.
+
+OpenAPI spec version: 6.6.0.20190329.001
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: unset
+
+=end
+
+require 'date'
+
+module OpenapiClient
+  # Authentication verification request specific to 3DSecure transactions.
+  class Secure3dAuthenticationVerificationRequest
+    # An optional Outlet ID for clients that support multiple stores in the same developer app.
+    attr_accessor :store_id
+
+    # Object name of the authentication verification request.
+    attr_accessor :request_type
+
+    # Card security code if required by merchant.
+    attr_accessor :security_code
+
+    attr_accessor :billing_address
+
+    # 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
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'store_id' => :'storeId',
+        :'request_type' => :'requestType',
+        :'security_code' => :'securityCode',
+        :'billing_address' => :'billingAddress',
+        :'payer_authentication_response' => :'payerAuthenticationResponse',
+        :'merchant_data' => :'merchantData'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'store_id' => :'String',
+        :'request_type' => :'String',
+        :'security_code' => :'String',
+        :'billing_address' => :'Address',
+        :'payer_authentication_response' => :'String',
+        :'merchant_data' => :'String'
+      }
+    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?(:'storeId')
+        self.store_id = attributes[:'storeId']
+      end
+
+      if attributes.has_key?(:'requestType')
+        self.request_type = attributes[:'requestType']
+      end
+
+      if attributes.has_key?(:'securityCode')
+        self.security_code = attributes[:'securityCode']
+      end
+
+      if attributes.has_key?(:'billingAddress')
+        self.billing_address = attributes[:'billingAddress']
+      end
+
+      if attributes.has_key?(:'payerAuthenticationResponse')
+        self.payer_authentication_response = attributes[:'payerAuthenticationResponse']
+      end
+
+      if attributes.has_key?(:'merchantData')
+        self.merchant_data = attributes[:'merchantData']
+      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 = Array.new
+      if !@store_id.nil? && @store_id.to_s.length > 20
+        invalid_properties.push('invalid value for "store_id", the character length must be smaller than or equal to 20.')
+      end
+
+      if @request_type.nil?
+        invalid_properties.push('invalid value for "request_type", request_type cannot be nil.')
+      end
+
+      if @payer_authentication_response.nil?
+        invalid_properties.push('invalid value for "payer_authentication_response", payer_authentication_response cannot be nil.')
+      end
+
+      if @merchant_data.nil?
+        invalid_properties.push('invalid value for "merchant_data", merchant_data 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 !@store_id.nil? && @store_id.to_s.length > 20
+      return false if @request_type.nil?
+      return false if @payer_authentication_response.nil?
+      return false if @merchant_data.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] store_id Value to be assigned
+    def store_id=(store_id)
+      if !store_id.nil? && store_id.to_s.length > 20
+        fail ArgumentError, 'invalid value for "store_id", the character length must be smaller than or equal to 20.'
+      end
+
+      @store_id = store_id
+    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 &&
+          store_id == o.store_id &&
+          request_type == o.request_type &&
+          security_code == o.security_code &&
+          billing_address == o.billing_address &&
+          payer_authentication_response == o.payer_authentication_response &&
+          merchant_data == o.merchant_data
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [store_id, request_type, security_code, billing_address, payer_authentication_response, merchant_data].hash
+    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)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the 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) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.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
+        temp_model = OpenapiClient.const_get(type).new
+        temp_model.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
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        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

data/lib/openapi_client/models/secure3d_response.rb

@@ -1,9 +1,9 @@
 =begin
 #Payment Gateway API Specification.
 
-#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
+#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.4.0.20181018.001
+OpenAPI spec version: 6.6.0.20190329.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset
@@ -13,8 +13,9 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
+  # Contains 3DSecure response code.
   class Secure3dResponse
-    # Code received after successful payer-auth verification
+    # Code received after successful payer-auth verification.
     attr_accessor :response_code3d_secure
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/openapi_client/models/sepa.rb

@@ -1,9 +1,9 @@
 =begin
 #Payment Gateway API Specification.
 
-#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
+#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.4.0.20181018.001
+OpenAPI spec version: 6.6.0.20190329.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset
@@ -15,16 +15,16 @@ require 'date'
 module OpenapiClient
   # The payment object for SEPA Local Payment.
   class Sepa
-    # Bank account in IBAN format
+    # Bank account in IBAN format.
     attr_accessor :iban
 
-    # The name of the payer
+    # The name of the payer.
     attr_accessor :name
 
-    # Country of residence of the payer using the ISO 3166 standard (http://en.wikipedia.org/wiki/ISO_3166)
+    # Country of residence of the payer using the ISO 3166 standard.
     attr_accessor :country
 
-    # The email address of the payer
+    # The email address of the payer.
     attr_accessor :email
 
     attr_accessor :mandate