first_data_gateway 1.3.0 → 1.4.0

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

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

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

data/lib/openapi_client/models/payment.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.6.0.20190507.002
+The version of the OpenAPI document: 6.8.0.20190731.002
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset
@@ -86,15 +86,15 @@ module OpenapiClient
     def self.openapi_types
       {
         :'payment_type' => :'String',
-        :'method' => :'PaymentPayMethod',
+        :'method' => :'Method',
         :'pin_present' => :'Boolean',
         :'entry_method' => :'String',
-        :'issuer_response' => :'PaymentIssuerResponse',
+        :'issuer_response' => :'IssuerResponse',
         :'issuer_approved_amount' => :'String',
         :'issuer_card_balance' => :'String',
-        :'verification_avs' => :'PaymentVerificationAvs',
-        :'verification3ds' => :'PaymentVerification3ds',
-        :'verification_cvv' => :'PaymentVerificationCvv',
+        :'verification_avs' => :'VerificationAvs',
+        :'verification3ds' => :'Verification3ds',
+        :'verification_cvv' => :'VerificationCvv',
         :'user_defined' => :'Object'
       }
     end
@@ -118,8 +118,8 @@ module OpenapiClient
         self.payment_type = attributes[:'payment_type']
       end
 
-      if attributes.key?(:'pay_method')
-        self.pay_method = attributes[:'pay_method']
+      if attributes.key?(:'method')
+        self.method = attributes[:'method']
       end
 
       if attributes.key?(:'pin_present')
@@ -191,7 +191,7 @@ module OpenapiClient
       return false if @method.nil?
       return false if @pin_present.nil?
       return false if @entry_method.nil?
-      entry_method_validator = EnumAttributeValidator.new('String', ["manual", "stripe", "ocr", "emv", "nfc", "remote", "pinPresent"])
+      entry_method_validator = EnumAttributeValidator.new('String', ["manual", "stripe", "ocr", "emv", "nfc", "remote", "pin_present"])
       return false unless entry_method_validator.valid?(@entry_method)
       true
     end
@@ -209,7 +209,7 @@ module OpenapiClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] entry_method Object to be assigned
     def entry_method=(entry_method)
-      validator = EnumAttributeValidator.new('String', ["manual", "stripe", "ocr", "emv", "nfc", "remote", "pinPresent"])
+      validator = EnumAttributeValidator.new('String', ["manual", "stripe", "ocr", "emv", "nfc", "remote", "pin_present"])
       unless validator.valid?(entry_method)
         fail ArgumentError, "invalid value for \"entry_method\", must be one of #{validator.allowable_values}."
       end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

data/lib/openapi_client/models/payment_device.rb

@@ -0,0 +1,336 @@
+=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.8.0.20190731.002
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: unset
+
+=end
+
+require 'date'
+
+module OpenapiClient
+  # Information from the payment device including the blob data and its mode of entry.
+  class PaymentDevice
+    # The data format.
+    attr_accessor :device_type
+
+    # Data from device containing, at a minimum, a transaction-unique key serial number (KSN) and track 2 card data.
+    attr_accessor :data
+
+    # Card verification value/number.
+    attr_accessor :security_code
+
+    # Name of cardholder.
+    attr_accessor :cardholder_name
+
+    attr_accessor :card_function
+
+    # The card brand.
+    attr_accessor :brand
+
+    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
+      {
+        :'device_type' => :'deviceType',
+        :'data' => :'data',
+        :'security_code' => :'securityCode',
+        :'cardholder_name' => :'cardholderName',
+        :'card_function' => :'cardFunction',
+        :'brand' => :'brand'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'device_type' => :'String',
+        :'data' => :'String',
+        :'security_code' => :'String',
+        :'cardholder_name' => :'String',
+        :'card_function' => :'CardFunction',
+        :'brand' => :'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::PaymentDevice` 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::PaymentDevice`. 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?(:'device_type')
+        self.device_type = attributes[:'device_type']
+      end
+
+      if attributes.key?(:'data')
+        self.data = attributes[:'data']
+      end
+
+      if attributes.key?(:'security_code')
+        self.security_code = attributes[:'security_code']
+      end
+
+      if attributes.key?(:'cardholder_name')
+        self.cardholder_name = attributes[:'cardholder_name']
+      end
+
+      if attributes.key?(:'card_function')
+        self.card_function = attributes[:'card_function']
+      end
+
+      if attributes.key?(:'brand')
+        self.brand = attributes[:'brand']
+      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 @device_type.nil?
+        invalid_properties.push('invalid value for "device_type", device_type cannot be nil.')
+      end
+
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^(?!\s*$).+/)
+      if @data !~ pattern
+        invalid_properties.push("invalid value for \"data\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@security_code.nil? && @security_code.to_s.length > 4
+        invalid_properties.push('invalid value for "security_code", the character length must be smaller than or equal to 4.')
+      end
+
+      if !@security_code.nil? && @security_code.to_s.length < 3
+        invalid_properties.push('invalid value for "security_code", the character length must be great than or equal to 3.')
+      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 @device_type.nil?
+      device_type_validator = EnumAttributeValidator.new('String', ["SWIPE"])
+      return false unless device_type_validator.valid?(@device_type)
+      return false if @data.nil?
+      return false if @data !~ Regexp.new(/^(?!\s*$).+/)
+      return false if !@security_code.nil? && @security_code.to_s.length > 4
+      return false if !@security_code.nil? && @security_code.to_s.length < 3
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] device_type Object to be assigned
+    def device_type=(device_type)
+      validator = EnumAttributeValidator.new('String', ["SWIPE"])
+      unless validator.valid?(device_type)
+        fail ArgumentError, "invalid value for \"device_type\", must be one of #{validator.allowable_values}."
+      end
+      @device_type = device_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data Value to be assigned
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'data cannot be nil'
+      end
+
+      pattern = Regexp.new(/^(?!\s*$).+/)
+      if data !~ pattern
+        fail ArgumentError, "invalid value for \"data\", must conform to the pattern #{pattern}."
+      end
+
+      @data = data
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] security_code Value to be assigned
+    def security_code=(security_code)
+      if !security_code.nil? && security_code.to_s.length > 4
+        fail ArgumentError, 'invalid value for "security_code", the character length must be smaller than or equal to 4.'
+      end
+
+      if !security_code.nil? && security_code.to_s.length < 3
+        fail ArgumentError, 'invalid value for "security_code", the character length must be great than or equal to 3.'
+      end
+
+      @security_code = security_code
+    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 &&
+          device_type == o.device_type &&
+          data == o.data &&
+          security_code == o.security_code &&
+          cardholder_name == o.cardholder_name &&
+          card_function == o.card_function &&
+          brand == o.brand
+    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
+      [device_type, data, security_code, cardholder_name, card_function, brand].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)
+      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 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
+        OpenapiClient.const_get(type).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