first_data_gateway 1.7.0 → 1.10.0

data/lib/openapi_client/models/secure3_d_authentication_result_all_of.rb

@@ -0,0 +1,340 @@
+=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
+  class Secure3DAuthenticationResultAllOf
+    # 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
+
+    # The transaction identifier (XID) is a unique tracking number set by the merchant.
+    attr_accessor :xid
+
+    # The response transaction UUID from the DS (directory server)
+    attr_accessor :ds_transaction_id
+
+    # The result of authentication attempt returned by the 3D Secure authentication process (ARes).
+    attr_accessor :authentication_response
+
+    # The transaction status as returned by the 3D Secure authentication process. (CRes)
+    attr_accessor :transaction_status
+
+    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
+      {
+        :'cavv' => :'cavv',
+        :'xid' => :'xid',
+        :'ds_transaction_id' => :'dsTransactionId',
+        :'authentication_response' => :'authenticationResponse',
+        :'transaction_status' => :'transactionStatus'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'cavv' => :'String',
+        :'xid' => :'String',
+        :'ds_transaction_id' => :'String',
+        :'authentication_response' => :'String',
+        :'transaction_status' => :'String'
+      }
+    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::Secure3DAuthenticationResultAllOf` 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::Secure3DAuthenticationResultAllOf`. 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?(:'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
+    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 !@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
+
+    # 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 !@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)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @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 !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
+
+    # Custom attribute writer method with validation
+    # @param [Object] xid Value to be assigned
+    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
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] authentication_response Object to be assigned
+    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
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] transaction_status Object to be assigned
+    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
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    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
+    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
+      [cavv, xid, ds_transaction_id, authentication_response, transaction_status].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)
+      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 = {}
+      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

data/lib/openapi_client/models/{payment_schedules_response_all_of.rb → secure3_d_authentication_update_request.rb}

@@ -3,24 +3,22 @@
 
 #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
+The version of the OpenAPI document: 21.1.0.20210122.001
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: unset
+OpenAPI Generator version: 4.1.1
 
 =end
 
 require 'date'
 
 module OpenapiClient
-  class PaymentSchedulesResponseAllOf
-    # Result of requested operation. If it's anything other than 'SUCCESS', please refer to 400s HTTP error codes or decline. See Error object for details.
-    attr_accessor :request_status
+  # Authentication update request specific to 3DSecure 2.x transactions.
+  class Secure3DAuthenticationUpdateRequest < AuthenticationUpdateRequest
+    # Indicates how the merchant received the 3DS method.
+    attr_accessor :method_notification_status
 
-    # Client order ID if supplied by client, otherwise the order ID.
-    attr_accessor :order_id
-
-    attr_accessor :transaction_response
+    attr_accessor :acs_response
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -47,78 +45,77 @@ module OpenapiClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'request_status' => :'requestStatus',
-        :'order_id' => :'orderId',
-        :'transaction_response' => :'transactionResponse'
+        :'method_notification_status' => :'methodNotificationStatus',
+        :'acs_response' => :'acsResponse'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'request_status' => :'String',
-        :'order_id' => :'String',
-        :'transaction_response' => :'TransactionResponse'
+        :'method_notification_status' => :'String',
+        :'acs_response' => :'ACSResponse'
       }
     end
 
-    # List of attributes with nullable: true
-    def self.openapi_nullable
-      Set.new([
-      ])
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'AuthenticationUpdateRequest',
+      :'Secure3D21AuthenticationUpdateRequestAllOf'
+      ]
     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::PaymentSchedulesResponseAllOf` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Secure3DAuthenticationUpdateRequest` 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::PaymentSchedulesResponseAllOf`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Secure3DAuthenticationUpdateRequest`. 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?(:'request_status')
-        self.request_status = attributes[:'request_status']
-      end
+      # call parent's initialize
+      super(attributes)
 
-      if attributes.key?(:'order_id')
-        self.order_id = attributes[:'order_id']
+      if attributes.key?(:'method_notification_status')
+        self.method_notification_status = attributes[:'method_notification_status']
       end
 
-      if attributes.key?(:'transaction_response')
-        self.transaction_response = attributes[:'transaction_response']
+      if attributes.key?(:'acs_response')
+        self.acs_response = attributes[:'acs_response']
       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
+      invalid_properties = super
       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?
-      request_status_validator = EnumAttributeValidator.new('String', ["SUCCESS", "VALIDATION_FAILED", "PROCESSING_FAILED", "FAILURE", "DECLINED"])
-      return false unless request_status_validator.valid?(@request_status)
-      true
+      method_notification_status_validator = EnumAttributeValidator.new('String', ["RECEIVED", "EXPECTED_BUT_NOT_RECEIVED", "NOT_EXPECTED"])
+      return false unless method_notification_status_validator.valid?(@method_notification_status)
+      true && super
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] request_status Object to be assigned
-    def request_status=(request_status)
-      validator = EnumAttributeValidator.new('String', ["SUCCESS", "VALIDATION_FAILED", "PROCESSING_FAILED", "FAILURE", "DECLINED"])
-      unless validator.valid?(request_status)
-        fail ArgumentError, "invalid value for \"request_status\", must be one of #{validator.allowable_values}."
+    # @param [Object] method_notification_status Object to be assigned
+    def method_notification_status=(method_notification_status)
+      validator = EnumAttributeValidator.new('String', ["RECEIVED", "EXPECTED_BUT_NOT_RECEIVED", "NOT_EXPECTED"])
+      unless validator.valid?(method_notification_status)
+        fail ArgumentError, "invalid value for \"method_notification_status\", must be one of #{validator.allowable_values}."
       end
-      @request_status = request_status
+      @method_notification_status = method_notification_status
     end
 
     # Checks equality by comparing each attribute.
@@ -126,9 +123,8 @@ module OpenapiClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          request_status == o.request_status &&
-          order_id == o.order_id &&
-          transaction_response == o.transaction_response
+          method_notification_status == o.method_notification_status &&
+          acs_response == o.acs_response && super(o)
     end
 
     # @see the `==` method
@@ -140,7 +136,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [request_status, order_id, transaction_response].hash
+      [method_notification_status, acs_response].hash
     end
 
     # Builds the object from hash
@@ -155,6 +151,7 @@ module OpenapiClient
     # @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
@@ -230,8 +227,8 @@ module OpenapiClient
 
     # 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 = {}
+    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?