first_data_gateway 1.1.0 → 1.2.0

data/lib/openapi_client/models/use_payment_token.rb

@@ -0,0 +1,233 @@
+=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
+  # Payment token usage details.
+  class UsePaymentToken
+    # Client-supplied payment token value.
+    attr_accessor :value
+
+    attr_accessor :function
+
+    # Card verification value/number.
+    attr_accessor :security_code
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'value' => :'value',
+        :'function' => :'function',
+        :'security_code' => :'securityCode'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'value' => :'String',
+        :'function' => :'CardFunction',
+        :'security_code' => :'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?(:'value')
+        self.value = attributes[:'value']
+      end
+
+      if attributes.has_key?(:'function')
+        self.function = attributes[:'function']
+      end
+
+      if attributes.has_key?(:'securityCode')
+        self.security_code = attributes[:'securityCode']
+      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 @value.nil?
+        invalid_properties.push('invalid value for "value", value cannot be nil.')
+      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 @value.nil?
+      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 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 &&
+          value == o.value &&
+          function == o.function &&
+          security_code == o.security_code
+    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
+      [value, function, security_code].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/{card_verifications_transaction.rb → void_transaction.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,26 +13,32 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
-  # Model for card verifcation transactions
-  class CardVerificationsTransaction
-    # Optional outlet ID for clients that support multiple store in the same app
+  # Request to perform void transaction.
+  class VoidTransaction
+    # Object name of the secondary transaction request.
+    attr_accessor :request_type
+
+    # An optional outlet ID for clients that support multiple stores in the same developer app.
     attr_accessor :store_id
 
-    attr_accessor :payment_method
+    # Comment for the secondary transaction.
+    attr_accessor :comments
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'request_type' => :'requestType',
         :'store_id' => :'storeId',
-        :'payment_method' => :'paymentMethod'
+        :'comments' => :'comments'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'request_type' => :'String',
         :'store_id' => :'String',
-        :'payment_method' => :'PaymentMethod'
+        :'comments' => :'String'
       }
     end
 
@@ -44,12 +50,16 @@ 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?(:'requestType')
+        self.request_type = attributes[:'requestType']
+      end
+
       if attributes.has_key?(:'storeId')
         self.store_id = attributes[:'storeId']
       end
 
-      if attributes.has_key?(:'paymentMethod')
-        self.payment_method = attributes[:'paymentMethod']
+      if attributes.has_key?(:'comments')
+        self.comments = attributes[:'comments']
       end
     end
 
@@ -57,12 +67,12 @@ module OpenapiClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      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.')
+      if @request_type.nil?
+        invalid_properties.push('invalid value for "request_type", request_type cannot be nil.')
       end
 
-      if @payment_method.nil?
-        invalid_properties.push('invalid value for "payment_method", payment_method cannot be nil.')
+      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
 
       invalid_properties
@@ -71,8 +81,8 @@ module OpenapiClient
     # 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 @payment_method.nil?
       true
     end
 
@@ -91,8 +101,9 @@ module OpenapiClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          request_type == o.request_type &&
           store_id == o.store_id &&
-          payment_method == o.payment_method
+          comments == o.comments
     end
 
     # @see the `==` method
@@ -104,7 +115,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [store_id, payment_method].hash
+      [request_type, store_id, comments].hash
     end
 
     # Builds the object from hash

data/lib/openapi_client/version.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
@@ -11,5 +11,5 @@ OpenAPI Generator version: unset
 =end
 
 module OpenapiClient
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/lib/openapi_client.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
@@ -19,41 +19,52 @@ require 'openapi_client/configuration'
 # Models
 require 'openapi_client/models/avs_response'
 require 'openapi_client/models/access_token_response'
+require 'openapi_client/models/account_updater_response'
 require 'openapi_client/models/additional_amount_rate'
+require 'openapi_client/models/additional_details'
 require 'openapi_client/models/additional_transaction_details'
 require 'openapi_client/models/address'
 require 'openapi_client/models/airline'
 require 'openapi_client/models/airline_ancillary_service_category'
 require 'openapi_client/models/airline_travel_route'
 require 'openapi_client/models/ali_pay'
+require 'openapi_client/models/ali_pay_payment_method'
+require 'openapi_client/models/ali_pay_sale_transaction'
 require 'openapi_client/models/amount'
 require 'openapi_client/models/amount_components'
-require 'openapi_client/models/authentication_request'
-require 'openapi_client/models/authentication_response_verification'
-require 'openapi_client/models/authentication_response_verification_request'
+require 'openapi_client/models/authentication'
+require 'openapi_client/models/authentication_redirect'
+require 'openapi_client/models/authentication_redirect_params'
+require 'openapi_client/models/authentication_verification_request'
 require 'openapi_client/models/basic_response'
-require 'openapi_client/models/basket_item'
 require 'openapi_client/models/billing'
 require 'openapi_client/models/billing_address'
 require 'openapi_client/models/billing_address_phone'
 require 'openapi_client/models/car_rental'
 require 'openapi_client/models/car_rental_extra_charges'
 require 'openapi_client/models/card'
+require 'openapi_client/models/card_function'
 require 'openapi_client/models/card_info'
 require 'openapi_client/models/card_info_lookup_request'
 require 'openapi_client/models/card_info_lookup_response'
 require 'openapi_client/models/card_verification_request'
-require 'openapi_client/models/card_verifications_transaction'
 require 'openapi_client/models/china_domestic'
+require 'openapi_client/models/china_domestic_payment_method'
+require 'openapi_client/models/china_pn_r_sale_transaction'
 require 'openapi_client/models/client_locale'
 require 'openapi_client/models/contact'
+require 'openapi_client/models/create_payment_token'
+require 'openapi_client/models/currency_conversion'
 require 'openapi_client/models/customer'
 require 'openapi_client/models/customer_address'
 require 'openapi_client/models/customer_address_phone'
+require 'openapi_client/models/dcc_exchange_rate_request'
 require 'openapi_client/models/dcc'
 require 'openapi_client/models/device'
 require 'openapi_client/models/device_networks'
 require 'openapi_client/models/document'
+require 'openapi_client/models/dynamic_pricing'
+require 'openapi_client/models/dynamic_pricing_exchange_rate_request'
 require 'openapi_client/models/error'
 require 'openapi_client/models/error_details'
 require 'openapi_client/models/error_response'
@@ -76,17 +87,31 @@ require 'openapi_client/models/order'
 require 'openapi_client/models/order_error_response'
 require 'openapi_client/models/order_response'
 require 'openapi_client/models/pay_pal'
+require 'openapi_client/models/pay_pal_payment_method'
 require 'openapi_client/models/payment'
 require 'openapi_client/models/payment_card'
-require 'openapi_client/models/payment_card_authentication_result'
+require 'openapi_client/models/payment_card_credit_transaction'
+require 'openapi_client/models/payment_card_forced_ticket_transaction'
+require 'openapi_client/models/payment_card_payer_auth_transaction'
+require 'openapi_client/models/payment_card_payment_method'
+require 'openapi_client/models/payment_card_payment_tokenization_request'
+require 'openapi_client/models/payment_card_pre_auth_transaction'
+require 'openapi_client/models/payment_card_sale_transaction'
 require 'openapi_client/models/payment_facilitator'
 require 'openapi_client/models/payment_issuer_response'
 require 'openapi_client/models/payment_method'
+require 'openapi_client/models/payment_method_details'
+require 'openapi_client/models/payment_method_payment_schedules_request'
+require 'openapi_client/models/payment_method_type'
 require 'openapi_client/models/payment_pay_method'
 require 'openapi_client/models/payment_schedules_error_response'
 require 'openapi_client/models/payment_schedules_request'
 require 'openapi_client/models/payment_schedules_response'
-require 'openapi_client/models/payment_tokenization'
+require 'openapi_client/models/payment_token_credit_transaction'
+require 'openapi_client/models/payment_token_details'
+require 'openapi_client/models/payment_token_payment_method'
+require 'openapi_client/models/payment_token_pre_auth_transaction'
+require 'openapi_client/models/payment_token_sale_transaction'
 require 'openapi_client/models/payment_tokenization_error_response'
 require 'openapi_client/models/payment_tokenization_request'
 require 'openapi_client/models/payment_tokenization_response'
@@ -96,8 +121,9 @@ require 'openapi_client/models/payment_url_response'
 require 'openapi_client/models/payment_verification3ds'
 require 'openapi_client/models/payment_verification_avs'
 require 'openapi_client/models/payment_verification_cvv'
+require 'openapi_client/models/paypal_credit_transaction'
+require 'openapi_client/models/post_auth_transaction'
 require 'openapi_client/models/primary_transaction'
-require 'openapi_client/models/primary_transaction_additional_details'
 require 'openapi_client/models/processor_data'
 require 'openapi_client/models/purchase_cards'
 require 'openapi_client/models/purchase_cards_level2'
@@ -105,27 +131,39 @@ require 'openapi_client/models/purchase_cards_level3'
 require 'openapi_client/models/purchase_cards_level3_line_items'
 require 'openapi_client/models/recurring_payment_details'
 require 'openapi_client/models/recurring_payment_details_response'
-require 'openapi_client/models/referenced_order'
+require 'openapi_client/models/referenced_order_payment_schedules_request'
+require 'openapi_client/models/referenced_order_payment_tokenization_request'
+require 'openapi_client/models/response_amount_components'
 require 'openapi_client/models/response_type'
+require 'openapi_client/models/return_transaction'
 require 'openapi_client/models/score_only_request'
 require 'openapi_client/models/score_only_response'
 require 'openapi_client/models/score_only_response_fraud_score'
 require 'openapi_client/models/score_only_response_fraud_score_explanations'
 require 'openapi_client/models/secondary_transaction'
-require 'openapi_client/models/secondary_transaction_additional_details'
+require 'openapi_client/models/secure3d_authentication_request'
+require 'openapi_client/models/secure3d_authentication_result'
+require 'openapi_client/models/secure3d_authentication_verification_request'
 require 'openapi_client/models/secure3d_response'
 require 'openapi_client/models/sepa'
 require 'openapi_client/models/sepa_mandate'
+require 'openapi_client/models/sepa_payment_method'
+require 'openapi_client/models/sepa_sale_transaction'
 require 'openapi_client/models/shipping'
 require 'openapi_client/models/soft_descriptor'
 require 'openapi_client/models/split_shipment'
 require 'openapi_client/models/stored_credential'
 require 'openapi_client/models/sub_merchant_data'
+require 'openapi_client/models/sub_merchant_split'
 require 'openapi_client/models/transaction'
 require 'openapi_client/models/transaction_error_response'
 require 'openapi_client/models/transaction_origin'
 require 'openapi_client/models/transaction_response'
 require 'openapi_client/models/transaction_type'
+require 'openapi_client/models/union_pay_authentication_request'
+require 'openapi_client/models/union_pay_authentication_verification_request'
+require 'openapi_client/models/use_payment_token'
+require 'openapi_client/models/void_transaction'
 
 # APIs
 require 'openapi_client/api/authentication_api'

data/lib/simple/gateway.rb

@@ -27,7 +27,7 @@ module SimpleClient
 		def request_access_token
 			signature_service = get_signature_service
 			message_signature = signature_service.sign
-			return @authentication_api.v1_authentication_access_tokens_post(
+			return @authentication_api.authentication_access_tokens_post(
 				CONTENT_TYPE, 
 				signature_service.client_request_id, 
 				get_api_key, 
@@ -42,7 +42,7 @@ module SimpleClient
 			opts[:region] = region if region
 			signature_service = get_signature_service
 			opts[:message_signature] = signature_service.sign(payload)
-			return @payment_api.primary_payment_transaction(
+			return @payment_api.submit_primary_transaction(
 				CONTENT_TYPE, 
 				signature_service.client_request_id, 
 				get_api_key, 
@@ -52,30 +52,13 @@ module SimpleClient
 			)
 		end
 
-		def perform_payment_authorization_by_transaction(transaction_id:, payload:, store_id: nil, region: nil)
+		def secondary_payment_transaction(transaction_id:, payload:, store_id: nil, region: nil)
 			opts = {}
 			opts[:store_id] = store_id if store_id
 			opts[:region] = region if region
 			signature_service = get_signature_service
 			opts[:message_signature] = signature_service.sign(payload)
-			return @payment_api.perform_payment_post_authorisation(
-				CONTENT_TYPE, 
-				signature_service.client_request_id, 
-				get_api_key, 
-				signature_service.timestamp, 
-				transaction_id,
-				payload,
-				opts
-			)
-		end
-
-		def return_transaction(transaction_id:, payload:, store_id: nil, region: nil)
-			opts = {}
-			opts[:store_id] = store_id if store_id
-			opts[:region] = region if region
-			signature_service = get_signature_service
-			opts[:message_signature] = signature_service.sign(payload)
-			return @payment_api.return_transaction(
+			return @payment_api.submit_secondary_transaction(
 				CONTENT_TYPE, 
 				signature_service.client_request_id, 
 				get_api_key, 
@@ -102,23 +85,7 @@ module SimpleClient
 			)
 		end
 
-		def void_transaction(transaction_id:, store_id: nil, region: nil)
-			opts = {}
-			opts[:store_id] = store_id if store_id
-			opts[:region] = region if region
-			signature_service = get_signature_service
-			opts[:message_signature] = signature_service.sign
-			return @payment_api.void_transaction(
-				CONTENT_TYPE, 
-				signature_service.client_request_id, 
-				get_api_key, 
-				signature_service.timestamp, 
-				transaction_id,
-				opts
-			)
-		end
-
-		def update_transaction(transaction_id:, payload:, region: nil)
+		def finalize_secure_transaction(transaction_id:, payload:, region: nil)
 			opts = {}
 			opts[:region] = region if region
 			signature_service = get_signature_service
@@ -152,30 +119,12 @@ module SimpleClient
 			)
 		end
 
-		def perform_payment_post_authorization_by_order(order_id:, payload:, store_id: nil, region: nil)
-			opts = {}
-			opts[:store_id] = store_id if store_id
-			opts[:region] = region if region
-			signature_service = get_signature_service
-			opts[:message_signature] = signature_service.sign(payload)
-			return @order_api.order_post_auth(
-				CONTENT_TYPE, 
-				signature_service.client_request_id, 
-				get_api_key, 
-				signature_service.timestamp, 
-				order_id,
-				payload,
-				opts
-			)
-		end
-
-		def return_transaction_by_order(order_id:, payload:, store_id: nil, region: nil)
+		def secondary_payment_transaction_by_order(order_id:, payload:, region: nil)
 			opts = {}
-			opts[:store_id] = store_id if store_id
 			opts[:region] = region if region
 			signature_service = get_signature_service
 			opts[:message_signature] = signature_service.sign(payload)
-			return @order_api.order_return_transaction(
+			return @order_api.submit_secondary_transaction_from_order(
 				CONTENT_TYPE, 
 				signature_service.client_request_id, 
 				get_api_key, 
@@ -282,7 +231,7 @@ module SimpleClient
 			)	
 		end		
 
-		def update_payment_schedule(payload:, order_id:, store_id: nil, region: nil)
+		def update_payment_schedule(order_id:, payload:, store_id: nil, region: nil)
 			opts = {}
 			opts[:store_id] = store_id if store_id
 			opts[:region] = region if region

data/lib/simple_client.rb

@@ -1,4 +1,4 @@
-require 'simple/gateway'
-require 'simple/client_context'
-require 'simple/merchant_credentials'
-require 'simple/signature'
+require_relative 'simple/gateway'
+require_relative 'simple/client_context'
+require_relative 'simple/merchant_credentials'
+require_relative 'simple/signature'