first_data_gateway 1.1.0 → 1.2.0

data/lib/openapi_client/models/dcc_exchange_rate_request.rb

@@ -0,0 +1,273 @@
+=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 to perform a DCC exchange rate inquiry.
+  class DCCExchangeRateRequest
+    # Object name of the exchange rate request.
+    attr_accessor :request_type
+
+    # The original amount of the merchant currency for calculation.
+    attr_accessor :base_amount
+
+    # An optional outlet ID for clients that support multiple stores in the same app.
+    attr_accessor :store_id
+
+    # A bank identification number (BIN) of the card to be used for DCC.
+    attr_accessor :bin
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'request_type' => :'requestType',
+        :'base_amount' => :'baseAmount',
+        :'store_id' => :'storeId',
+        :'bin' => :'bin'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'request_type' => :'String',
+        :'base_amount' => :'Float',
+        :'store_id' => :'String',
+        :'bin' => :'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
+
+      if attributes.has_key?(:'baseAmount')
+        self.base_amount = attributes[:'baseAmount']
+      end
+
+      if attributes.has_key?(:'storeId')
+        self.store_id = attributes[:'storeId']
+      end
+
+      if attributes.has_key?(:'bin')
+        self.bin = attributes[:'bin']
+      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
+
+      if @base_amount.nil?
+        invalid_properties.push('invalid value for "base_amount", base_amount cannot be nil.')
+      end
+
+      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 @bin.nil?
+        invalid_properties.push('invalid value for "bin", bin cannot be nil.')
+      end
+
+      if @bin.to_s.length > 6
+        invalid_properties.push('invalid value for "bin", the character length must be smaller than or equal to 6.')
+      end
+
+      if @bin !~ Regexp.new(/[0-9]{6}/)
+        invalid_properties.push('invalid value for "bin", must conform to the pattern /[0-9]{6}/.')
+      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?
+      return false if @base_amount.nil?
+      return false if !@store_id.nil? && @store_id.to_s.length > 20
+      return false if @bin.nil?
+      return false if @bin.to_s.length > 6
+      return false if @bin !~ Regexp.new(/[0-9]{6}/)
+      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
+
+    # Custom attribute writer method with validation
+    # @param [Object] bin Value to be assigned
+    def bin=(bin)
+      if bin.nil?
+        fail ArgumentError, 'bin cannot be nil'
+      end
+
+      if bin.to_s.length > 6
+        fail ArgumentError, 'invalid value for "bin", the character length must be smaller than or equal to 6.'
+      end
+
+      if bin !~ Regexp.new(/[0-9]{6}/)
+        fail ArgumentError, 'invalid value for "bin", must conform to the pattern /[0-9]{6}/.'
+      end
+
+      @bin = bin
+    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 &&
+          base_amount == o.base_amount &&
+          store_id == o.store_id &&
+          bin == o.bin
+    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, base_amount, store_id, bin].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/device.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
@@ -21,6 +21,7 @@ module OpenapiClient
     # The unique ID of the device. Must be unique for the entire system (not just within a specific merchant or industry).
     attr_accessor :device_id
 
+    # Information about the networks associated with the device.
     attr_accessor :networks
 
     # The GPS decimal latitude, ranging from (-90.0 to 90.0) where positive numbers indicate locations North of the equator.
@@ -29,7 +30,7 @@ module OpenapiClient
     # The GPS decimal longitude, ranging from (-180.0 to 180.0) where positive numbers indicate locations East of the IERS Reference Meridian.
     attr_accessor :longitude
 
-    # The device's International Mobile Equipment Identity (IMEI) as described in IETFs RFC7254.
+    # The device's International Mobile Equipment Identity (IMEI) as described in IETF RFC7254.
     attr_accessor :imei
 
     # The device's model name.

data/lib/openapi_client/models/device_networks.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,6 +13,7 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
+  # Network information.
   class DeviceNetworks
     # Defines the type of network associated with the device.
     attr_accessor :network_type
@@ -35,7 +36,7 @@ module OpenapiClient
     # The Mobile Subscription Identification Number code (MSIN) as described in the ITUs E.212 specification.
     attr_accessor :subscription_identification_number
 
-    # The Location Area Code (LAC) is a16-bit identifier for a region that is covered by a set of network antennas.
+    # The Location Area Code (LAC) is a 16-bit identifier for a region that is covered by a set of network antennas.
     attr_accessor :location_area_code
 
     # The Cell ID (CID) is identifier for a specific Base Transceiver Station (BTS) within a specific Location Area Code (LAC).

data/lib/openapi_client/models/document.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,10 +15,10 @@ require 'date'
 module OpenapiClient
   # Document information.
   class Document
-    # Document type
+    # Document type.
     attr_accessor :type
 
-    # Document number
+    # Document number.
     attr_accessor :number
 
     class EnumAttributeValidator

data/lib/openapi_client/models/dynamic_pricing.rb

@@ -0,0 +1,235 @@
+=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 to perform a dynamic pricing exchange rate inquiry.
+  class DynamicPricing
+    # Type of currency conversion.
+    attr_accessor :conversion_type
+
+    # Inquiry rate id.
+    attr_accessor :inquiry_rate_id
+
+    # The currency code to convert for dynamic pricing in ISO 4217 currency code format.
+    attr_accessor :foreign_currency
+
+    # Foreign amount.
+    attr_accessor :foreign_amount
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'conversion_type' => :'conversionType',
+        :'inquiry_rate_id' => :'inquiryRateId',
+        :'foreign_currency' => :'foreignCurrency',
+        :'foreign_amount' => :'foreignAmount'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'conversion_type' => :'String',
+        :'inquiry_rate_id' => :'String',
+        :'foreign_currency' => :'String',
+        :'foreign_amount' => :'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?(:'conversionType')
+        self.conversion_type = attributes[:'conversionType']
+      end
+
+      if attributes.has_key?(:'inquiryRateId')
+        self.inquiry_rate_id = attributes[:'inquiryRateId']
+      end
+
+      if attributes.has_key?(:'foreignCurrency')
+        self.foreign_currency = attributes[:'foreignCurrency']
+      end
+
+      if attributes.has_key?(:'foreignAmount')
+        self.foreign_amount = attributes[:'foreignAmount']
+      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 @conversion_type.nil?
+        invalid_properties.push('invalid value for "conversion_type", conversion_type cannot be nil.')
+      end
+
+      if @inquiry_rate_id.nil?
+        invalid_properties.push('invalid value for "inquiry_rate_id", inquiry_rate_id cannot be nil.')
+      end
+
+      if @foreign_currency.nil?
+        invalid_properties.push('invalid value for "foreign_currency", foreign_currency cannot be nil.')
+      end
+
+      if @foreign_amount.nil?
+        invalid_properties.push('invalid value for "foreign_amount", foreign_amount 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 @conversion_type.nil?
+      return false if @inquiry_rate_id.nil?
+      return false if @foreign_currency.nil?
+      return false if @foreign_amount.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 &&
+          conversion_type == o.conversion_type &&
+          inquiry_rate_id == o.inquiry_rate_id &&
+          foreign_currency == o.foreign_currency &&
+          foreign_amount == o.foreign_amount
+    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
+      [conversion_type, inquiry_rate_id, foreign_currency, foreign_amount].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