first_data_gateway 1.1.0 → 1.2.0

data/lib/openapi_client/models/payment_card_sale_transaction.rb

@@ -0,0 +1,325 @@
+=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 create sale transaction using payment card.
+  class PaymentCardSaleTransaction
+    # Object name of the primary transaction request.
+    attr_accessor :request_type
+
+    # An optional outlet ID for clients that support multiple stores in the same app.
+    attr_accessor :store_id
+
+    # The unique merchant transaction ID from the request header, if supplied.
+    attr_accessor :merchant_transaction_id
+
+    attr_accessor :transaction_amount
+
+    attr_accessor :transaction_origin
+
+    attr_accessor :order
+
+    attr_accessor :payment_method
+
+    attr_accessor :stored_credentials
+
+    # Settle with multiple sub-merchants, sale and preAuth only.
+    attr_accessor :settlement_split
+
+    attr_accessor :create_token
+
+    attr_accessor :currency_conversion
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'request_type' => :'requestType',
+        :'store_id' => :'storeId',
+        :'merchant_transaction_id' => :'merchantTransactionId',
+        :'transaction_amount' => :'transactionAmount',
+        :'transaction_origin' => :'transactionOrigin',
+        :'order' => :'order',
+        :'payment_method' => :'paymentMethod',
+        :'stored_credentials' => :'storedCredentials',
+        :'settlement_split' => :'settlementSplit',
+        :'create_token' => :'createToken',
+        :'currency_conversion' => :'currencyConversion'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'request_type' => :'String',
+        :'store_id' => :'String',
+        :'merchant_transaction_id' => :'String',
+        :'transaction_amount' => :'Amount',
+        :'transaction_origin' => :'TransactionOrigin',
+        :'order' => :'Order',
+        :'payment_method' => :'PaymentCardPaymentMethod',
+        :'stored_credentials' => :'StoredCredential',
+        :'settlement_split' => :'Array<SubMerchantSplit>',
+        :'create_token' => :'CreatePaymentToken',
+        :'currency_conversion' => :'CurrencyConversion'
+      }
+    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?(:'storeId')
+        self.store_id = attributes[:'storeId']
+      end
+
+      if attributes.has_key?(:'merchantTransactionId')
+        self.merchant_transaction_id = attributes[:'merchantTransactionId']
+      end
+
+      if attributes.has_key?(:'transactionAmount')
+        self.transaction_amount = attributes[:'transactionAmount']
+      end
+
+      if attributes.has_key?(:'transactionOrigin')
+        self.transaction_origin = attributes[:'transactionOrigin']
+      end
+
+      if attributes.has_key?(:'order')
+        self.order = attributes[:'order']
+      end
+
+      if attributes.has_key?(:'paymentMethod')
+        self.payment_method = attributes[:'paymentMethod']
+      end
+
+      if attributes.has_key?(:'storedCredentials')
+        self.stored_credentials = attributes[:'storedCredentials']
+      end
+
+      if attributes.has_key?(:'settlementSplit')
+        if (value = attributes[:'settlementSplit']).is_a?(Array)
+          self.settlement_split = value
+        end
+      end
+
+      if attributes.has_key?(:'createToken')
+        self.create_token = attributes[:'createToken']
+      end
+
+      if attributes.has_key?(:'currencyConversion')
+        self.currency_conversion = attributes[:'currencyConversion']
+      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 !@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 !@merchant_transaction_id.nil? && @merchant_transaction_id.to_s.length > 40
+        invalid_properties.push('invalid value for "merchant_transaction_id", the character length must be smaller than or equal to 40.')
+      end
+
+      if @transaction_amount.nil?
+        invalid_properties.push('invalid value for "transaction_amount", transaction_amount cannot be nil.')
+      end
+
+      if @payment_method.nil?
+        invalid_properties.push('invalid value for "payment_method", payment_method 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 @request_type.nil?
+      return false if !@store_id.nil? && @store_id.to_s.length > 20
+      return false if !@merchant_transaction_id.nil? && @merchant_transaction_id.to_s.length > 40
+      return false if @transaction_amount.nil?
+      return false if @payment_method.nil?
+      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] merchant_transaction_id Value to be assigned
+    def merchant_transaction_id=(merchant_transaction_id)
+      if !merchant_transaction_id.nil? && merchant_transaction_id.to_s.length > 40
+        fail ArgumentError, 'invalid value for "merchant_transaction_id", the character length must be smaller than or equal to 40.'
+      end
+
+      @merchant_transaction_id = merchant_transaction_id
+    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 &&
+          store_id == o.store_id &&
+          merchant_transaction_id == o.merchant_transaction_id &&
+          transaction_amount == o.transaction_amount &&
+          transaction_origin == o.transaction_origin &&
+          order == o.order &&
+          payment_method == o.payment_method &&
+          stored_credentials == o.stored_credentials &&
+          settlement_split == o.settlement_split &&
+          create_token == o.create_token &&
+          currency_conversion == o.currency_conversion
+    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, store_id, merchant_transaction_id, transaction_amount, transaction_origin, order, payment_method, stored_credentials, settlement_split, create_token, currency_conversion].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/payment_facilitator.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,18 +13,18 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
-  # Payment Facilitator details provided by the Merchant.
+  # Payment facilitator details provided by the merchant.
   class PaymentFacilitator
-    # External Merchant ID of the payment facilitator
+    # External merchant ID of the payment facilitator.
     attr_accessor :external_merchant_id
 
-    # Payment Facilitator ID supplied during boarding
+    # Payment facilitator ID supplied during boarding.
     attr_accessor :payment_facilitator_id
 
-    # Independent Sales Organization (ISO) ID provided by Mastercard
+    # Independent sales organization (ISO) ID provided by Mastercard.
     attr_accessor :sale_organization_id
 
-    # Payment facilitator Name
+    # Payment facilitator name.
     attr_accessor :name
 
     attr_accessor :sub_merchant_data

data/lib/openapi_client/models/payment_issuer_response.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

data/lib/openapi_client/models/payment_method.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,68 +13,17 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
-  # Various payment methods the Gateway supports
+  # Various payment methods the Gateway supports. Abstract class, do not use this class directly, use one of its children.
   class PaymentMethod
-    # The type of payment method. Note that PayPal can only process a 'CREDIT' transaction. Note that for requests we are now supporting only PAYMENT_CARD, SEPA, PAYPAL, ALIPAY. All this types are supported for response.
-    attr_accessor :type
-
-    attr_accessor :payment_card
-
-    attr_accessor :payment_token
-
-    attr_accessor :sepa
-
-    attr_accessor :pay_pal
-
-    attr_accessor :ali_pay
-
-    attr_accessor :china_domestic
-
-    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
       {
-        :'type' => :'type',
-        :'payment_card' => :'paymentCard',
-        :'payment_token' => :'paymentToken',
-        :'sepa' => :'sepa',
-        :'pay_pal' => :'payPal',
-        :'ali_pay' => :'aliPay',
-        :'china_domestic' => :'chinaDomestic'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'type' => :'String',
-        :'payment_card' => :'PaymentCard',
-        :'payment_token' => :'PaymentTokenization',
-        :'sepa' => :'Sepa',
-        :'pay_pal' => :'PayPal',
-        :'ali_pay' => :'AliPay',
-        :'china_domestic' => :'ChinaDomestic'
       }
     end
 
@@ -85,78 +34,26 @@ module OpenapiClient
 
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
-
-      if attributes.has_key?(:'type')
-        self.type = attributes[:'type']
-      end
-
-      if attributes.has_key?(:'paymentCard')
-        self.payment_card = attributes[:'paymentCard']
-      end
-
-      if attributes.has_key?(:'paymentToken')
-        self.payment_token = attributes[:'paymentToken']
-      end
-
-      if attributes.has_key?(:'sepa')
-        self.sepa = attributes[:'sepa']
-      end
-
-      if attributes.has_key?(:'payPal')
-        self.pay_pal = attributes[:'payPal']
-      end
-
-      if attributes.has_key?(:'aliPay')
-        self.ali_pay = attributes[:'aliPay']
-      end
-
-      if attributes.has_key?(:'chinaDomestic')
-        self.china_domestic = attributes[:'chinaDomestic']
-      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 @type.nil?
-        invalid_properties.push('invalid value for "type", type 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 @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ['ALIPAY', 'ALIPAY_PAYSECURE_US', 'ALIPAY_DOMESTIC', 'APM', 'CUP_DOMESTIC', 'DEBITDE', 'EMI', 'GIROPAY', 'IDEAL', 'INDIAWALLET', 'KLARNA', 'NETBANKING', 'PAYMENT_CARD', 'PAYMENT_TOKEN', 'PAYPAL', 'SEPA', 'SOFORT', 'WALLET', 'WECHAT_DOMESTIC'])
-      return false unless type_validator.valid?(@type)
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] type Object to be assigned
-    def type=(type)
-      validator = EnumAttributeValidator.new('String', ['ALIPAY', 'ALIPAY_PAYSECURE_US', 'ALIPAY_DOMESTIC', 'APM', 'CUP_DOMESTIC', 'DEBITDE', 'EMI', 'GIROPAY', 'IDEAL', 'INDIAWALLET', 'KLARNA', 'NETBANKING', 'PAYMENT_CARD', 'PAYMENT_TOKEN', 'PAYPAL', 'SEPA', 'SOFORT', 'WALLET', 'WECHAT_DOMESTIC'])
-      unless validator.valid?(type)
-        fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
-      end
-      @type = type
-    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 &&
-          type == o.type &&
-          payment_card == o.payment_card &&
-          payment_token == o.payment_token &&
-          sepa == o.sepa &&
-          pay_pal == o.pay_pal &&
-          ali_pay == o.ali_pay &&
-          china_domestic == o.china_domestic
+      self.class == o.class
     end
 
     # @see the `==` method
@@ -168,7 +65,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [type, payment_card, payment_token, sepa, pay_pal, ali_pay, china_domestic].hash
+      [].hash
     end
 
     # Builds the object from hash

data/lib/openapi_client/models/{basket_item.rb → payment_method_details.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,36 +13,25 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
-  # Model for basket items
-  class BasketItem
-    # Item ID
-    attr_accessor :id
+  # Provides details of the payment method used.
+  class PaymentMethodDetails
+    attr_accessor :payment_card
 
-    # Item in the basket
-    attr_accessor :description
-
-    attr_accessor :unit_price
-
-    # Total quantity of items
-    attr_accessor :count
+    attr_accessor :payment_method_type
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'description' => :'description',
-        :'unit_price' => :'unitPrice',
-        :'count' => :'count'
+        :'payment_card' => :'paymentCard',
+        :'payment_method_type' => :'paymentMethodType'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id' => :'String',
-        :'description' => :'String',
-        :'unit_price' => :'Amount',
-        :'count' => :'Integer'
+        :'payment_card' => :'PaymentCard',
+        :'payment_method_type' => :'PaymentMethodType'
       }
     end
 
@@ -54,20 +43,12 @@ module OpenapiClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'id')
-        self.id = attributes[:'id']
-      end
-
-      if attributes.has_key?(:'description')
-        self.description = attributes[:'description']
-      end
-
-      if attributes.has_key?(:'unitPrice')
-        self.unit_price = attributes[:'unitPrice']
+      if attributes.has_key?(:'paymentCard')
+        self.payment_card = attributes[:'paymentCard']
       end
 
-      if attributes.has_key?(:'count')
-        self.count = attributes[:'count']
+      if attributes.has_key?(:'paymentMethodType')
+        self.payment_method_type = attributes[:'paymentMethodType']
       end
     end
 
@@ -89,10 +70,8 @@ module OpenapiClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
-          description == o.description &&
-          unit_price == o.unit_price &&
-          count == o.count
+          payment_card == o.payment_card &&
+          payment_method_type == o.payment_method_type
     end
 
     # @see the `==` method
@@ -104,7 +83,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, description, unit_price, count].hash
+      [payment_card, payment_method_type].hash
     end
 
     # Builds the object from hash