first_data_gateway 1.10.0 → 1.14.0

data/lib/openapi_client/models/additional_response_data.rb

@@ -0,0 +1,347 @@
+=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.5.0.20211029.001
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.1
+
+=end
+
+require 'date'
+
+module OpenapiClient
+  # Additional Response Data.
+  class AdditionalResponseData
+    # Issuing Bank Name.
+    attr_accessor :issuing_bank_name
+
+    # Country of Issuance.
+    attr_accessor :country_of_issuance
+
+    # Card Product ID.
+    attr_accessor :card_product_id
+
+    # Detailed Product ID.
+    attr_accessor :detailed_product_id
+
+    # Association Response Code.
+    attr_accessor :association_response_code_adtl
+
+    # Card Brand.
+    attr_accessor :card_brand
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'issuing_bank_name' => :'issuingBankName',
+        :'country_of_issuance' => :'countryOfIssuance',
+        :'card_product_id' => :'cardProductID',
+        :'detailed_product_id' => :'detailedProductID',
+        :'association_response_code_adtl' => :'associationResponseCodeAdtl',
+        :'card_brand' => :'cardBrand'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'issuing_bank_name' => :'String',
+        :'country_of_issuance' => :'String',
+        :'card_product_id' => :'String',
+        :'detailed_product_id' => :'String',
+        :'association_response_code_adtl' => :'String',
+        :'card_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::AdditionalResponseData` 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::AdditionalResponseData`. 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?(:'issuing_bank_name')
+        self.issuing_bank_name = attributes[:'issuing_bank_name']
+      end
+
+      if attributes.key?(:'country_of_issuance')
+        self.country_of_issuance = attributes[:'country_of_issuance']
+      end
+
+      if attributes.key?(:'card_product_id')
+        self.card_product_id = attributes[:'card_product_id']
+      end
+
+      if attributes.key?(:'detailed_product_id')
+        self.detailed_product_id = attributes[:'detailed_product_id']
+      end
+
+      if attributes.key?(:'association_response_code_adtl')
+        self.association_response_code_adtl = attributes[:'association_response_code_adtl']
+      end
+
+      if attributes.key?(:'card_brand')
+        self.card_brand = attributes[:'card_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 !@issuing_bank_name.nil? && @issuing_bank_name.to_s.length > 18
+        invalid_properties.push('invalid value for "issuing_bank_name", the character length must be smaller than or equal to 18.')
+      end
+
+      if !@country_of_issuance.nil? && @country_of_issuance.to_s.length > 3
+        invalid_properties.push('invalid value for "country_of_issuance", the character length must be smaller than or equal to 3.')
+      end
+
+      if !@card_product_id.nil? && @card_product_id.to_s.length > 1
+        invalid_properties.push('invalid value for "card_product_id", the character length must be smaller than or equal to 1.')
+      end
+
+      if !@detailed_product_id.nil? && @detailed_product_id.to_s.length > 3
+        invalid_properties.push('invalid value for "detailed_product_id", the character length must be smaller than or equal to 3.')
+      end
+
+      if !@association_response_code_adtl.nil? && @association_response_code_adtl.to_s.length > 3
+        invalid_properties.push('invalid value for "association_response_code_adtl", the character length must be smaller than or equal to 3.')
+      end
+
+      if !@card_brand.nil? && @card_brand.to_s.length > 1
+        invalid_properties.push('invalid value for "card_brand", the character length must be smaller than or equal to 1.')
+      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 !@issuing_bank_name.nil? && @issuing_bank_name.to_s.length > 18
+      return false if !@country_of_issuance.nil? && @country_of_issuance.to_s.length > 3
+      return false if !@card_product_id.nil? && @card_product_id.to_s.length > 1
+      return false if !@detailed_product_id.nil? && @detailed_product_id.to_s.length > 3
+      return false if !@association_response_code_adtl.nil? && @association_response_code_adtl.to_s.length > 3
+      return false if !@card_brand.nil? && @card_brand.to_s.length > 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] issuing_bank_name Value to be assigned
+    def issuing_bank_name=(issuing_bank_name)
+      if !issuing_bank_name.nil? && issuing_bank_name.to_s.length > 18
+        fail ArgumentError, 'invalid value for "issuing_bank_name", the character length must be smaller than or equal to 18.'
+      end
+
+      @issuing_bank_name = issuing_bank_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country_of_issuance Value to be assigned
+    def country_of_issuance=(country_of_issuance)
+      if !country_of_issuance.nil? && country_of_issuance.to_s.length > 3
+        fail ArgumentError, 'invalid value for "country_of_issuance", the character length must be smaller than or equal to 3.'
+      end
+
+      @country_of_issuance = country_of_issuance
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] card_product_id Value to be assigned
+    def card_product_id=(card_product_id)
+      if !card_product_id.nil? && card_product_id.to_s.length > 1
+        fail ArgumentError, 'invalid value for "card_product_id", the character length must be smaller than or equal to 1.'
+      end
+
+      @card_product_id = card_product_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] detailed_product_id Value to be assigned
+    def detailed_product_id=(detailed_product_id)
+      if !detailed_product_id.nil? && detailed_product_id.to_s.length > 3
+        fail ArgumentError, 'invalid value for "detailed_product_id", the character length must be smaller than or equal to 3.'
+      end
+
+      @detailed_product_id = detailed_product_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] association_response_code_adtl Value to be assigned
+    def association_response_code_adtl=(association_response_code_adtl)
+      if !association_response_code_adtl.nil? && association_response_code_adtl.to_s.length > 3
+        fail ArgumentError, 'invalid value for "association_response_code_adtl", the character length must be smaller than or equal to 3.'
+      end
+
+      @association_response_code_adtl = association_response_code_adtl
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] card_brand Value to be assigned
+    def card_brand=(card_brand)
+      if !card_brand.nil? && card_brand.to_s.length > 1
+        fail ArgumentError, 'invalid value for "card_brand", the character length must be smaller than or equal to 1.'
+      end
+
+      @card_brand = card_brand
+    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 &&
+          issuing_bank_name == o.issuing_bank_name &&
+          country_of_issuance == o.country_of_issuance &&
+          card_product_id == o.card_product_id &&
+          detailed_product_id == o.detailed_product_id &&
+          association_response_code_adtl == o.association_response_code_adtl &&
+          card_brand == o.card_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
+      [issuing_bank_name, country_of_issuance, card_product_id, detailed_product_id, association_response_code_adtl, card_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, 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/additional_transaction_details.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: 21.1.0.20210122.001
+The version of the OpenAPI document: 21.5.0.20211029.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1
@@ -33,6 +33,8 @@ module OpenapiClient
     # Provides receipt response data, if it has been requested.
     attr_accessor :receipts
 
+    attr_accessor :additional_response_data
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -63,7 +65,8 @@ module OpenapiClient
         :'purchase_order_number' => :'purchaseOrderNumber',
         :'disbursement_trans_type' => :'disbursementTransType',
         :'wallet_provider' => :'walletProvider',
-        :'receipts' => :'receipts'
+        :'receipts' => :'receipts',
+        :'additional_response_data' => :'additionalResponseData'
       }
     end
 
@@ -75,7 +78,8 @@ module OpenapiClient
         :'purchase_order_number' => :'String',
         :'disbursement_trans_type' => :'String',
         :'wallet_provider' => :'String',
-        :'receipts' => :'Array<Receipt>'
+        :'receipts' => :'Array<Receipt>',
+        :'additional_response_data' => :'AdditionalResponseData'
       }
     end
 
@@ -119,6 +123,10 @@ module OpenapiClient
           self.receipts = value
         end
       end
+
+      if attributes.key?(:'additional_response_data')
+        self.additional_response_data = attributes[:'additional_response_data']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -213,7 +221,8 @@ module OpenapiClient
           purchase_order_number == o.purchase_order_number &&
           disbursement_trans_type == o.disbursement_trans_type &&
           wallet_provider == o.wallet_provider &&
-          receipts == o.receipts
+          receipts == o.receipts &&
+          additional_response_data == o.additional_response_data
     end
 
     # @see the `==` method
@@ -225,7 +234,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [comments, invoice_number, purchase_order_number, disbursement_trans_type, wallet_provider, receipts].hash
+      [comments, invoice_number, purchase_order_number, disbursement_trans_type, wallet_provider, receipts, additional_response_data].hash
     end
 
     # Builds the object from hash

data/lib/openapi_client/models/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: 21.1.0.20210122.001
+The version of the OpenAPI document: 21.5.0.20211029.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1
@@ -33,7 +33,7 @@ module OpenapiClient
     # ZIP code or postal code.
     attr_accessor :postal_code
 
-    # ISO-3166-1  ALPHA-2, ALPHA-3, numeric or full country name. In the case of PaySecure endpoints, pass the country code in an ISO format.
+    # ISO-3166-1  ALPHA-2, ALPHA-3, numeric or full country name. In the case of PaySecure endpoints, pass the country code in an ISO format. NOTE: Country required for following listed SEPA transactions:  - SEPA DD transaction done with Local Payments (aka PPRO).  - SEPA DD transaction done via POSEIDON and the IBAN belongs to the 'SE' country group.
     attr_accessor :country
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/openapi_client/models/airline.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: 21.1.0.20210122.001
+The version of the OpenAPI document: 21.5.0.20211029.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1

data/lib/openapi_client/models/airline_ancillary_service_category.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: 21.1.0.20210122.001
+The version of the OpenAPI document: 21.5.0.20211029.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1

data/lib/openapi_client/models/airline_travel_route.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: 21.1.0.20210122.001
+The version of the OpenAPI document: 21.5.0.20211029.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1

data/lib/openapi_client/models/ali_pay.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: 21.1.0.20210122.001
+The version of the OpenAPI document: 21.5.0.20211029.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1

data/lib/openapi_client/models/ali_pay_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: 21.1.0.20210122.001
+The version of the OpenAPI document: 21.5.0.20211029.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1

data/lib/openapi_client/models/ali_pay_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: 21.1.0.20210122.001
+The version of the OpenAPI document: 21.5.0.20211029.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1

data/lib/openapi_client/models/ali_pay_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: 21.1.0.20210122.001
+The version of the OpenAPI document: 21.5.0.20211029.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1

data/lib/openapi_client/models/ali_pay_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: 21.1.0.20210122.001
+The version of the OpenAPI document: 21.5.0.20211029.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1

data/lib/openapi_client/models/amount.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: 21.1.0.20210122.001
+The version of the OpenAPI document: 21.5.0.20211029.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1

data/lib/openapi_client/models/amount_components.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: 21.1.0.20210122.001
+The version of the OpenAPI document: 21.5.0.20211029.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.1.1
@@ -33,6 +33,9 @@ module OpenapiClient
     # Tip amount.
     attr_accessor :tip
 
+    # Surcharge amount.
+    attr_accessor :surcharge
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -41,7 +44,8 @@ module OpenapiClient
         :'local_tax' => :'localTax',
         :'shipping' => :'shipping',
         :'cashback' => :'cashback',
-        :'tip' => :'tip'
+        :'tip' => :'tip',
+        :'surcharge' => :'surcharge'
       }
     end
 
@@ -53,7 +57,8 @@ module OpenapiClient
         :'local_tax' => :'Float',
         :'shipping' => :'Float',
         :'cashback' => :'Float',
-        :'tip' => :'Float'
+        :'tip' => :'Float',
+        :'surcharge' => :'Float'
       }
     end
 
@@ -95,6 +100,10 @@ module OpenapiClient
       if attributes.key?(:'tip')
         self.tip = attributes[:'tip']
       end
+
+      if attributes.key?(:'surcharge')
+        self.surcharge = attributes[:'surcharge']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -120,7 +129,8 @@ module OpenapiClient
           local_tax == o.local_tax &&
           shipping == o.shipping &&
           cashback == o.cashback &&
-          tip == o.tip
+          tip == o.tip &&
+          surcharge == o.surcharge
     end
 
     # @see the `==` method
@@ -132,7 +142,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [subtotal, vat_amount, local_tax, shipping, cashback, tip].hash
+      [subtotal, vat_amount, local_tax, shipping, cashback, tip, surcharge].hash
     end
 
     # Builds the object from hash