first_data_gateway 1.3.0 → 1.4.0

data/lib/openapi_client/models/error_response.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/exchange_rate_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/exchange_rate_response.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/expiration.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/{merchant_location_merchant_address.rb → fraud_address.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
@@ -13,24 +13,24 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
-  # Info for the merchant address.
-  class MerchantLocationMerchantAddress
+  # Address fields.
+  class FraudAddress
     # First line of street address.
     attr_accessor :street
 
     # Second line of street address.
     attr_accessor :street2
 
-    # Merchant state or provinceu.
+    # State or province.
     attr_accessor :state_province
 
-    # Merchant city.
+    # City.
     attr_accessor :city
 
-    # Merchant country.
+    # Country.
     attr_accessor :country
 
-    # Merchant ZIP code.
+    # Postal code.
     attr_accessor :zip_postal_code
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -61,13 +61,13 @@ module OpenapiClient
     # @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::MerchantLocationMerchantAddress` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::FraudAddress` 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::MerchantLocationMerchantAddress`. 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::FraudAddress`. 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
       }

data/lib/openapi_client/models/fraud_order.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
@@ -35,7 +35,7 @@ module OpenapiClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'ship_to_address' => :'FraudOrderShipToAddress',
+        :'ship_to_address' => :'ShipToAddress',
         :'items' => :'Array<FraudOrderItems>',
         :'user_defined' => :'Object'
       }

data/lib/openapi_client/models/fraud_order_items.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/fraud_registration.rb

@@ -0,0 +1,259 @@
+=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
+  class FraudRegistration
+    # Merchant reference code. Used by FirstAPI and reflected in settlement records and webhook notifications. Typically, the merchantRef field is the purchase order number or unique sequence value associated to a given transaction.
+    attr_accessor :merchant_ref
+
+    # Type of transaction merchant wants to process.
+    attr_accessor :transaction_type
+
+    attr_accessor :customer
+
+    attr_accessor :merchant
+
+    attr_accessor :device
+
+    # A JSON object that can carry any additional information that might be helpful for fraud detection.
+    attr_accessor :user_defined
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'merchant_ref' => :'merchantRef',
+        :'transaction_type' => :'transactionType',
+        :'customer' => :'customer',
+        :'merchant' => :'merchant',
+        :'device' => :'device',
+        :'user_defined' => :'userDefined'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'merchant_ref' => :'String',
+        :'transaction_type' => :'String',
+        :'customer' => :'Customer',
+        :'merchant' => :'Merchant',
+        :'device' => :'FraudRegistrationDevice',
+        :'user_defined' => :'Object'
+      }
+    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::FraudRegistration` 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::FraudRegistration`. 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?(:'merchant_ref')
+        self.merchant_ref = attributes[:'merchant_ref']
+      end
+
+      if attributes.key?(:'transaction_type')
+        self.transaction_type = attributes[:'transaction_type']
+      end
+
+      if attributes.key?(:'customer')
+        self.customer = attributes[:'customer']
+      end
+
+      if attributes.key?(:'merchant')
+        self.merchant = attributes[:'merchant']
+      end
+
+      if attributes.key?(:'device')
+        self.device = attributes[:'device']
+      end
+
+      if attributes.key?(:'user_defined')
+        self.user_defined = attributes[:'user_defined']
+      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 @transaction_type.nil?
+        invalid_properties.push('invalid value for "transaction_type", transaction_type cannot be nil.')
+      end
+
+      if @customer.nil?
+        invalid_properties.push('invalid value for "customer", customer cannot be nil.')
+      end
+
+      if @merchant.nil?
+        invalid_properties.push('invalid value for "merchant", merchant 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 @transaction_type.nil?
+      return false if @customer.nil?
+      return false if @merchant.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 &&
+          merchant_ref == o.merchant_ref &&
+          transaction_type == o.transaction_type &&
+          customer == o.customer &&
+          merchant == o.merchant &&
+          device == o.device &&
+          user_defined == o.user_defined
+    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
+      [merchant_ref, transaction_type, customer, merchant, device, user_defined].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

data/lib/openapi_client/models/fraud_registration_card.rb

@@ -0,0 +1,248 @@
+=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
+  # A JSON object that holds info about the payment registration card.
+  class FraudRegistrationCard
+    # The cardholder name as it appears on the card.
+    attr_accessor :cardholder_name
+
+    # Use this field to send clear PAN or tokens other than TransArmor Token.
+    attr_accessor :card_number
+
+    # Payment method expiration date. Format is MMYYYY.
+    attr_accessor :exp_date
+
+    # CVV present indicator.
+    attr_accessor :cvv_present
+
+    # The company (usually a bank) that issued the card.
+    attr_accessor :issuer
+
+    # A number that distinguishes between two plastic cards with the same card number in the event of the card being re-issued.
+    attr_accessor :card_reissued_number
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cardholder_name' => :'cardholderName',
+        :'card_number' => :'cardNumber',
+        :'exp_date' => :'expDate',
+        :'cvv_present' => :'cvvPresent',
+        :'issuer' => :'issuer',
+        :'card_reissued_number' => :'cardReissuedNumber'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'cardholder_name' => :'String',
+        :'card_number' => :'String',
+        :'exp_date' => :'String',
+        :'cvv_present' => :'String',
+        :'issuer' => :'String',
+        :'card_reissued_number' => :'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::FraudRegistrationCard` 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::FraudRegistrationCard`. 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?(:'cardholder_name')
+        self.cardholder_name = attributes[:'cardholder_name']
+      end
+
+      if attributes.key?(:'card_number')
+        self.card_number = attributes[:'card_number']
+      end
+
+      if attributes.key?(:'exp_date')
+        self.exp_date = attributes[:'exp_date']
+      end
+
+      if attributes.key?(:'cvv_present')
+        self.cvv_present = attributes[:'cvv_present']
+      end
+
+      if attributes.key?(:'issuer')
+        self.issuer = attributes[:'issuer']
+      end
+
+      if attributes.key?(:'card_reissued_number')
+        self.card_reissued_number = attributes[:'card_reissued_number']
+      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
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      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 &&
+          cardholder_name == o.cardholder_name &&
+          card_number == o.card_number &&
+          exp_date == o.exp_date &&
+          cvv_present == o.cvv_present &&
+          issuer == o.issuer &&
+          card_reissued_number == o.card_reissued_number
+    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
+      [cardholder_name, card_number, exp_date, cvv_present, issuer, card_reissued_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 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