first_data_gateway 1.2.0 → 1.7.0

data/lib/openapi_client/models/processor_data.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
@@ -41,6 +41,12 @@ module OpenapiClient
     # Code to map merchant advice code to ISO specification.
     attr_accessor :merchant_advice_code_indicator
 
+    # Indicates whether the transaction was routed through the payment card's own network or through a different network.
+    attr_accessor :response_indicator
+
+    # Receipt number from debit network provider.
+    attr_accessor :debit_receipt_number
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -74,7 +80,9 @@ module OpenapiClient
         :'response_message' => :'responseMessage',
         :'avs_response' => :'avsResponse',
         :'security_code_response' => :'securityCodeResponse',
-        :'merchant_advice_code_indicator' => :'merchantAdviceCodeIndicator'
+        :'merchant_advice_code_indicator' => :'merchantAdviceCodeIndicator',
+        :'response_indicator' => :'responseIndicator',
+        :'debit_receipt_number' => :'debitReceiptNumber'
       }
     end
 
@@ -89,52 +97,75 @@ module OpenapiClient
         :'response_message' => :'String',
         :'avs_response' => :'AVSResponse',
         :'security_code_response' => :'String',
-        :'merchant_advice_code_indicator' => :'String'
+        :'merchant_advice_code_indicator' => :'String',
+        :'response_indicator' => :'String',
+        :'debit_receipt_number' => :'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)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::ProcessorData` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # 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::ProcessorData`. 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.has_key?(:'referenceNumber')
-        self.reference_number = attributes[:'referenceNumber']
+      if attributes.key?(:'reference_number')
+        self.reference_number = attributes[:'reference_number']
       end
 
-      if attributes.has_key?(:'authorizationCode')
-        self.authorization_code = attributes[:'authorizationCode']
+      if attributes.key?(:'authorization_code')
+        self.authorization_code = attributes[:'authorization_code']
       end
 
-      if attributes.has_key?(:'responseCode')
-        self.response_code = attributes[:'responseCode']
+      if attributes.key?(:'response_code')
+        self.response_code = attributes[:'response_code']
       end
 
-      if attributes.has_key?(:'network')
+      if attributes.key?(:'network')
         self.network = attributes[:'network']
       end
 
-      if attributes.has_key?(:'associationResponseCode')
-        self.association_response_code = attributes[:'associationResponseCode']
+      if attributes.key?(:'association_response_code')
+        self.association_response_code = attributes[:'association_response_code']
+      end
+
+      if attributes.key?(:'response_message')
+        self.response_message = attributes[:'response_message']
       end
 
-      if attributes.has_key?(:'responseMessage')
-        self.response_message = attributes[:'responseMessage']
+      if attributes.key?(:'avs_response')
+        self.avs_response = attributes[:'avs_response']
       end
 
-      if attributes.has_key?(:'avsResponse')
-        self.avs_response = attributes[:'avsResponse']
+      if attributes.key?(:'security_code_response')
+        self.security_code_response = attributes[:'security_code_response']
       end
 
-      if attributes.has_key?(:'securityCodeResponse')
-        self.security_code_response = attributes[:'securityCodeResponse']
+      if attributes.key?(:'merchant_advice_code_indicator')
+        self.merchant_advice_code_indicator = attributes[:'merchant_advice_code_indicator']
       end
 
-      if attributes.has_key?(:'merchantAdviceCodeIndicator')
-        self.merchant_advice_code_indicator = attributes[:'merchantAdviceCodeIndicator']
+      if attributes.key?(:'response_indicator')
+        self.response_indicator = attributes[:'response_indicator']
+      end
+
+      if attributes.key?(:'debit_receipt_number')
+        self.debit_receipt_number = attributes[:'debit_receipt_number']
       end
     end
 
@@ -142,8 +173,9 @@ module OpenapiClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if !@merchant_advice_code_indicator.nil? && @merchant_advice_code_indicator !~ Regexp.new(/[0-9]{2}/)
-        invalid_properties.push('invalid value for "merchant_advice_code_indicator", must conform to the pattern /[0-9]{2}/.')
+      pattern = Regexp.new(/[0-9]{2}/)
+      if !@merchant_advice_code_indicator.nil? && @merchant_advice_code_indicator !~ pattern
+        invalid_properties.push("invalid value for \"merchant_advice_code_indicator\", must conform to the pattern #{pattern}.")
       end
 
       invalid_properties
@@ -152,7 +184,7 @@ module OpenapiClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      security_code_response_validator = EnumAttributeValidator.new('String', ['MATCHED', 'NOT_MATCHED', 'NOT_PROCESSED', 'NOT_PRESENT', 'NOT_CERTIFIED'])
+      security_code_response_validator = EnumAttributeValidator.new('String', ["MATCHED", "NOT_MATCHED", "NOT_PROCESSED", "NOT_PRESENT", "NOT_CERTIFIED", "NOT_CHECKED"])
       return false unless security_code_response_validator.valid?(@security_code_response)
       return false if !@merchant_advice_code_indicator.nil? && @merchant_advice_code_indicator !~ Regexp.new(/[0-9]{2}/)
       true
@@ -161,9 +193,9 @@ module OpenapiClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] security_code_response Object to be assigned
     def security_code_response=(security_code_response)
-      validator = EnumAttributeValidator.new('String', ['MATCHED', 'NOT_MATCHED', 'NOT_PROCESSED', 'NOT_PRESENT', 'NOT_CERTIFIED'])
+      validator = EnumAttributeValidator.new('String', ["MATCHED", "NOT_MATCHED", "NOT_PROCESSED", "NOT_PRESENT", "NOT_CERTIFIED", "NOT_CHECKED"])
       unless validator.valid?(security_code_response)
-        fail ArgumentError, 'invalid value for "security_code_response", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"security_code_response\", must be one of #{validator.allowable_values}."
       end
       @security_code_response = security_code_response
     end
@@ -171,8 +203,9 @@ module OpenapiClient
     # Custom attribute writer method with validation
     # @param [Object] merchant_advice_code_indicator Value to be assigned
     def merchant_advice_code_indicator=(merchant_advice_code_indicator)
-      if !merchant_advice_code_indicator.nil? && merchant_advice_code_indicator !~ Regexp.new(/[0-9]{2}/)
-        fail ArgumentError, 'invalid value for "merchant_advice_code_indicator", must conform to the pattern /[0-9]{2}/.'
+      pattern = Regexp.new(/[0-9]{2}/)
+      if !merchant_advice_code_indicator.nil? && merchant_advice_code_indicator !~ pattern
+        fail ArgumentError, "invalid value for \"merchant_advice_code_indicator\", must conform to the pattern #{pattern}."
       end
 
       @merchant_advice_code_indicator = merchant_advice_code_indicator
@@ -191,7 +224,9 @@ module OpenapiClient
           response_message == o.response_message &&
           avs_response == o.avs_response &&
           security_code_response == o.security_code_response &&
-          merchant_advice_code_indicator == o.merchant_advice_code_indicator
+          merchant_advice_code_indicator == o.merchant_advice_code_indicator &&
+          response_indicator == o.response_indicator &&
+          debit_receipt_number == o.debit_receipt_number
     end
 
     # @see the `==` method
@@ -201,25 +236,32 @@ module OpenapiClient
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [reference_number, authorization_code, response_code, network, association_response_code, response_message, avs_response, security_code_response, merchant_advice_code_indicator].hash
+      [reference_number, authorization_code, response_code, network, association_response_code, response_message, avs_response, security_code_response, merchant_advice_code_indicator, response_indicator, debit_receipt_number].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)
+    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)
-      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
 
@@ -242,7 +284,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
@@ -263,8 +305,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
 
@@ -282,11 +328,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/properties.rb

@@ -0,0 +1,285 @@
+=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
+  # Object contains font and color properties.
+  class Properties
+    attr_accessor :font_face
+
+    # Font size property.
+    attr_accessor :font_size
+
+    attr_accessor :font_weight
+
+    # Hexadecimal color value.
+    attr_accessor :font_color
+
+    # Hexadecimal color value.
+    attr_accessor :color
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'font_face' => :'fontFace',
+        :'font_size' => :'fontSize',
+        :'font_weight' => :'fontWeight',
+        :'font_color' => :'fontColor',
+        :'color' => :'color'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'font_face' => :'FontFace',
+        :'font_size' => :'String',
+        :'font_weight' => :'FontWeight',
+        :'font_color' => :'String',
+        :'color' => :'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 = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Properties` 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::Properties`. 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?(:'font_face')
+        self.font_face = attributes[:'font_face']
+      end
+
+      if attributes.key?(:'font_size')
+        self.font_size = attributes[:'font_size']
+      end
+
+      if attributes.key?(:'font_weight')
+        self.font_weight = attributes[:'font_weight']
+      end
+
+      if attributes.key?(:'font_color')
+        self.font_color = attributes[:'font_color']
+      end
+
+      if attributes.key?(:'color')
+        self.color = attributes[:'color']
+      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
+      pattern = Regexp.new(/(^(0[xX]){1}[A-Fa-f0-9]+$)|(^#[A-Fa-f0-9]{6}$)/)
+      if !@font_color.nil? && @font_color !~ pattern
+        invalid_properties.push("invalid value for \"font_color\", must conform to the pattern #{pattern}.")
+      end
+
+      pattern = Regexp.new(/(^(0[xX]){1}[A-Fa-f0-9]+$)|(^#[A-Fa-f0-9]{6}$)/)
+      if !@color.nil? && @color !~ pattern
+        invalid_properties.push("invalid value for \"color\", 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 !@font_color.nil? && @font_color !~ Regexp.new(/(^(0[xX]){1}[A-Fa-f0-9]+$)|(^#[A-Fa-f0-9]{6}$)/)
+      return false if !@color.nil? && @color !~ Regexp.new(/(^(0[xX]){1}[A-Fa-f0-9]+$)|(^#[A-Fa-f0-9]{6}$)/)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] font_color Value to be assigned
+    def font_color=(font_color)
+      pattern = Regexp.new(/(^(0[xX]){1}[A-Fa-f0-9]+$)|(^#[A-Fa-f0-9]{6}$)/)
+      if !font_color.nil? && font_color !~ pattern
+        fail ArgumentError, "invalid value for \"font_color\", must conform to the pattern #{pattern}."
+      end
+
+      @font_color = font_color
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] color Value to be assigned
+    def color=(color)
+      pattern = Regexp.new(/(^(0[xX]){1}[A-Fa-f0-9]+$)|(^#[A-Fa-f0-9]{6}$)/)
+      if !color.nil? && color !~ pattern
+        fail ArgumentError, "invalid value for \"color\", must conform to the pattern #{pattern}."
+      end
+
+      @color = color
+    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 &&
+          font_face == o.font_face &&
+          font_size == o.font_size &&
+          font_weight == o.font_weight &&
+          font_color == o.font_color &&
+          color == o.color
+    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
+      [font_face, font_size, font_weight, font_color, color].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 = self.class.openapi_nullable)
+      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