first_data_gateway 1.0.3 → 1.1.0

data/lib/{swagger_client → openapi_client}/models/transaction_error_response.rb

@@ -1,29 +1,28 @@
 =begin
-#Payment Gateway API Specification
+#Payment Gateway API Specification.
 
-#Payment Gateway API for payment processing. 
+#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
 
-OpenAPI spec version: 0.0.1
+OpenAPI spec version: 6.4.0.20181018.001
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: unset
 
 =end
 
 require 'date'
 
-module SwaggerClient
-
+module OpenapiClient
+  # Transaction response with error field included.
   class TransactionErrorResponse
-    # The schema type returned in the response.
-    attr_accessor :response_type
-
-    # Echoes back the value in the Request header
+    # Echoes back the value in the request header for tracking.
     attr_accessor :client_request_id
 
-    # Echoes back the value in the Request header
+    # Request identifier in API, can be used to request logs from the support team.
     attr_accessor :api_trace_id
 
+    attr_accessor :response_type
+
     # The Response Transaction ID
     attr_accessor :ipg_transaction_id
 
@@ -32,17 +31,11 @@ module SwaggerClient
 
     attr_accessor :transaction_type
 
-    # The processor approval code for compliance.
-    attr_accessor :authorization_code
-
-    # The processor address validation response for compliance.
-    attr_accessor :avs_response
+    attr_accessor :payment_token
 
-    # The processor card verification validation response for compliance.
-    attr_accessor :security_code_response
+    attr_accessor :transaction_origin
 
-    # Card brand of the payment instrument
-    attr_accessor :brand
+    attr_accessor :payment_method
 
     # Country of the card issuer
     attr_accessor :country
@@ -50,8 +43,8 @@ module SwaggerClient
     # The terminal that is processing the transaction
     attr_accessor :terminal_id
 
-    # The unique client Transaction ID from the Request header, if supplied
-    attr_accessor :client_transaction_id
+    # The unique merchant Transaction ID from the Request header, if supplied
+    attr_accessor :merchant_transaction_id
 
     # The transaction time in seconds since Epoch
     attr_accessor :transaction_time
@@ -64,13 +57,20 @@ module SwaggerClient
     # The state of the transaction.
     attr_accessor :transaction_state
 
+    attr_accessor :secure3d_response
+
+    # The endpoint redirection URL.
+    attr_accessor :redirect_url
+
     attr_accessor :authentication_redirect
 
-    # The transaction id received from schemes for the initial transaction, returned for the transactions marked as \"FIRST\"
+    # The transaction ID received from schemes for the initial transaction of card on file flows.
     attr_accessor :scheme_transaction_id
 
     attr_accessor :processor
 
+    attr_accessor :additional_details
+
     attr_accessor :error
 
     class EnumAttributeValidator
@@ -98,53 +98,57 @@ module SwaggerClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'response_type' => :'responseType',
         :'client_request_id' => :'clientRequestId',
         :'api_trace_id' => :'apiTraceId',
+        :'response_type' => :'responseType',
         :'ipg_transaction_id' => :'ipgTransactionId',
         :'order_id' => :'orderId',
         :'transaction_type' => :'transactionType',
-        :'authorization_code' => :'authorizationCode',
-        :'avs_response' => :'avsResponse',
-        :'security_code_response' => :'securityCodeResponse',
-        :'brand' => :'brand',
+        :'payment_token' => :'paymentToken',
+        :'transaction_origin' => :'transactionOrigin',
+        :'payment_method' => :'paymentMethod',
         :'country' => :'country',
         :'terminal_id' => :'terminalId',
-        :'client_transaction_id' => :'clientTransactionId',
+        :'merchant_transaction_id' => :'merchantTransactionId',
         :'transaction_time' => :'transactionTime',
         :'approved_amount' => :'approvedAmount',
         :'transaction_status' => :'transactionStatus',
         :'transaction_state' => :'transactionState',
+        :'secure3d_response' => :'secure3dResponse',
+        :'redirect_url' => :'redirectURL',
         :'authentication_redirect' => :'authenticationRedirect',
         :'scheme_transaction_id' => :'schemeTransactionId',
         :'processor' => :'processor',
+        :'additional_details' => :'additionalDetails',
         :'error' => :'error'
       }
     end
 
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
-        :'response_type' => :'ResponseType',
         :'client_request_id' => :'String',
         :'api_trace_id' => :'String',
+        :'response_type' => :'ResponseType',
         :'ipg_transaction_id' => :'String',
         :'order_id' => :'String',
         :'transaction_type' => :'TransactionType',
-        :'authorization_code' => :'String',
-        :'avs_response' => :'String',
-        :'security_code_response' => :'String',
-        :'brand' => :'String',
+        :'payment_token' => :'PaymentTokenization',
+        :'transaction_origin' => :'TransactionOrigin',
+        :'payment_method' => :'PaymentMethod',
         :'country' => :'String',
         :'terminal_id' => :'String',
-        :'client_transaction_id' => :'String',
+        :'merchant_transaction_id' => :'String',
         :'transaction_time' => :'Integer',
         :'approved_amount' => :'Amount',
         :'transaction_status' => :'String',
         :'transaction_state' => :'String',
-        :'authentication_redirect' => :'TransactionResponseAuthenticationRedirect',
+        :'secure3d_response' => :'Secure3dResponse',
+        :'redirect_url' => :'String',
+        :'authentication_redirect' => :'Object',
         :'scheme_transaction_id' => :'String',
         :'processor' => :'ProcessorData',
+        :'additional_details' => :'AdditionalTransactionDetails',
         :'error' => :'Error'
       }
     end
@@ -155,11 +159,7 @@ module SwaggerClient
       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?(:'responseType')
-        self.response_type = attributes[:'responseType']
-      end
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
       if attributes.has_key?(:'clientRequestId')
         self.client_request_id = attributes[:'clientRequestId']
@@ -169,6 +169,10 @@ module SwaggerClient
         self.api_trace_id = attributes[:'apiTraceId']
       end
 
+      if attributes.has_key?(:'responseType')
+        self.response_type = attributes[:'responseType']
+      end
+
       if attributes.has_key?(:'ipgTransactionId')
         self.ipg_transaction_id = attributes[:'ipgTransactionId']
       end
@@ -181,20 +185,16 @@ module SwaggerClient
         self.transaction_type = attributes[:'transactionType']
       end
 
-      if attributes.has_key?(:'authorizationCode')
-        self.authorization_code = attributes[:'authorizationCode']
-      end
-
-      if attributes.has_key?(:'avsResponse')
-        self.avs_response = attributes[:'avsResponse']
+      if attributes.has_key?(:'paymentToken')
+        self.payment_token = attributes[:'paymentToken']
       end
 
-      if attributes.has_key?(:'securityCodeResponse')
-        self.security_code_response = attributes[:'securityCodeResponse']
+      if attributes.has_key?(:'transactionOrigin')
+        self.transaction_origin = attributes[:'transactionOrigin']
       end
 
-      if attributes.has_key?(:'brand')
-        self.brand = attributes[:'brand']
+      if attributes.has_key?(:'paymentMethod')
+        self.payment_method = attributes[:'paymentMethod']
       end
 
       if attributes.has_key?(:'country')
@@ -205,8 +205,8 @@ module SwaggerClient
         self.terminal_id = attributes[:'terminalId']
       end
 
-      if attributes.has_key?(:'clientTransactionId')
-        self.client_transaction_id = attributes[:'clientTransactionId']
+      if attributes.has_key?(:'merchantTransactionId')
+        self.merchant_transaction_id = attributes[:'merchantTransactionId']
       end
 
       if attributes.has_key?(:'transactionTime')
@@ -225,6 +225,14 @@ module SwaggerClient
         self.transaction_state = attributes[:'transactionState']
       end
 
+      if attributes.has_key?(:'secure3dResponse')
+        self.secure3d_response = attributes[:'secure3dResponse']
+      end
+
+      if attributes.has_key?(:'redirectURL')
+        self.redirect_url = attributes[:'redirectURL']
+      end
+
       if attributes.has_key?(:'authenticationRedirect')
         self.authentication_redirect = attributes[:'authenticationRedirect']
       end
@@ -237,40 +245,63 @@ module SwaggerClient
         self.processor = attributes[:'processor']
       end
 
+      if attributes.has_key?(:'additionalDetails')
+        self.additional_details = attributes[:'additionalDetails']
+      end
+
       if attributes.has_key?(:'error')
         self.error = attributes[:'error']
       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 @response_type.nil?
+        invalid_properties.push('invalid value for "response_type", response_type cannot be nil.')
+      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 !@scheme_transaction_id.nil? && @scheme_transaction_id.to_s.length > 40
-        invalid_properties.push("invalid value for 'scheme_transaction_id', the character length must be smaller than or equal to 40.")
+        invalid_properties.push('invalid value for "scheme_transaction_id", the character length must be smaller than or equal to 40.')
       end
 
-      return invalid_properties
+      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?
-      transaction_status_validator = EnumAttributeValidator.new('String', ["APPROVED", "WAITING", "VALIDATION_FAILED", "DECLINED"])
+      return false if @response_type.nil?
+      return false if !@merchant_transaction_id.nil? && @merchant_transaction_id.to_s.length > 40
+      transaction_status_validator = EnumAttributeValidator.new('String', ['APPROVED', 'WAITING', 'VALIDATION_FAILED', 'PROCESSING_FAILED', 'DECLINED'])
       return false unless transaction_status_validator.valid?(@transaction_status)
-      transaction_state_validator = EnumAttributeValidator.new('String', ["AUTHORIZED", "CAPTURED", "COMPLETED_GET", "DECLINED", "CHECKED", "INITIALIZED", "PENDING_AUTHORIZATION", "PENDING_AUTOVOID", "PENDING_CAPTURE", "PENDING_CREDIT", "PENDING_GIROPAY_INIT", "PENDING_IDEAL_INIT", "PENDING_INIT", "PENDING_READY", "PENDING_RETURN", "PENDING_SETTLEMENT", "PENDING_SOFORT_INIT", "PENDING_VOID", "READY", "SETTLED", "VOIDED", "WAITING", "WAITING_AUTHENTICATION", "WAITING_3D_SECURE", "WAITING_CLICK_AND_BUY", "WAITING_GIROPAY", "WAITING_IDEAL", "WAITING_KLARNA", "WAITING_PAYPAL", "WAITING_PAYPAL_EVENT", "WAITING_PPRO_LONG_WAITING", "WAITING_SOFORT", "WAITING_T_PAY", "WAITING_ALIPAY_PAYSECURE"])
+      transaction_state_validator = EnumAttributeValidator.new('String', ['AUTHORIZED', 'CAPTURED', 'DECLINED', 'CHECKED', 'INITIALIZED', 'PENDING', 'READY', 'SETTLED', 'VOIDED', 'WAITING'])
       return false unless transaction_state_validator.valid?(@transaction_state)
       return false if !@scheme_transaction_id.nil? && @scheme_transaction_id.to_s.length > 40
-      return true
+      true
+    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
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] transaction_status Object to be assigned
     def transaction_status=(transaction_status)
-      validator = EnumAttributeValidator.new('String', ["APPROVED", "WAITING", "VALIDATION_FAILED", "DECLINED"])
+      validator = EnumAttributeValidator.new('String', ['APPROVED', 'WAITING', 'VALIDATION_FAILED', 'PROCESSING_FAILED', 'DECLINED'])
       unless validator.valid?(transaction_status)
-        fail ArgumentError, "invalid value for 'transaction_status', must be one of #{validator.allowable_values}."
+        fail ArgumentError, 'invalid value for "transaction_status", must be one of #{validator.allowable_values}.'
       end
       @transaction_status = transaction_status
     end
@@ -278,9 +309,9 @@ module SwaggerClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] transaction_state Object to be assigned
     def transaction_state=(transaction_state)
-      validator = EnumAttributeValidator.new('String', ["AUTHORIZED", "CAPTURED", "COMPLETED_GET", "DECLINED", "CHECKED", "INITIALIZED", "PENDING_AUTHORIZATION", "PENDING_AUTOVOID", "PENDING_CAPTURE", "PENDING_CREDIT", "PENDING_GIROPAY_INIT", "PENDING_IDEAL_INIT", "PENDING_INIT", "PENDING_READY", "PENDING_RETURN", "PENDING_SETTLEMENT", "PENDING_SOFORT_INIT", "PENDING_VOID", "READY", "SETTLED", "VOIDED", "WAITING", "WAITING_AUTHENTICATION", "WAITING_3D_SECURE", "WAITING_CLICK_AND_BUY", "WAITING_GIROPAY", "WAITING_IDEAL", "WAITING_KLARNA", "WAITING_PAYPAL", "WAITING_PAYPAL_EVENT", "WAITING_PPRO_LONG_WAITING", "WAITING_SOFORT", "WAITING_T_PAY", "WAITING_ALIPAY_PAYSECURE"])
+      validator = EnumAttributeValidator.new('String', ['AUTHORIZED', 'CAPTURED', 'DECLINED', 'CHECKED', 'INITIALIZED', 'PENDING', 'READY', 'SETTLED', 'VOIDED', 'WAITING'])
       unless validator.valid?(transaction_state)
-        fail ArgumentError, "invalid value for 'transaction_state', must be one of #{validator.allowable_values}."
+        fail ArgumentError, 'invalid value for "transaction_state", must be one of #{validator.allowable_values}.'
       end
       @transaction_state = transaction_state
     end
@@ -288,9 +319,8 @@ module SwaggerClient
     # Custom attribute writer method with validation
     # @param [Object] scheme_transaction_id Value to be assigned
     def scheme_transaction_id=(scheme_transaction_id)
-
       if !scheme_transaction_id.nil? && scheme_transaction_id.to_s.length > 40
-        fail ArgumentError, "invalid value for 'scheme_transaction_id', the character length must be smaller than or equal to 40."
+        fail ArgumentError, 'invalid value for "scheme_transaction_id", the character length must be smaller than or equal to 40.'
       end
 
       @scheme_transaction_id = scheme_transaction_id
@@ -301,26 +331,28 @@ module SwaggerClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          response_type == o.response_type &&
           client_request_id == o.client_request_id &&
           api_trace_id == o.api_trace_id &&
+          response_type == o.response_type &&
           ipg_transaction_id == o.ipg_transaction_id &&
           order_id == o.order_id &&
           transaction_type == o.transaction_type &&
-          authorization_code == o.authorization_code &&
-          avs_response == o.avs_response &&
-          security_code_response == o.security_code_response &&
-          brand == o.brand &&
+          payment_token == o.payment_token &&
+          transaction_origin == o.transaction_origin &&
+          payment_method == o.payment_method &&
           country == o.country &&
           terminal_id == o.terminal_id &&
-          client_transaction_id == o.client_transaction_id &&
+          merchant_transaction_id == o.merchant_transaction_id &&
           transaction_time == o.transaction_time &&
           approved_amount == o.approved_amount &&
           transaction_status == o.transaction_status &&
           transaction_state == o.transaction_state &&
+          secure3d_response == o.secure3d_response &&
+          redirect_url == o.redirect_url &&
           authentication_redirect == o.authentication_redirect &&
           scheme_transaction_id == o.scheme_transaction_id &&
           processor == o.processor &&
+          additional_details == o.additional_details &&
           error == o.error
     end
 
@@ -333,7 +365,7 @@ module SwaggerClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [response_type, client_request_id, api_trace_id, ipg_transaction_id, order_id, transaction_type, authorization_code, avs_response, security_code_response, brand, country, terminal_id, client_transaction_id, transaction_time, approved_amount, transaction_status, transaction_state, authentication_redirect, scheme_transaction_id, processor, error].hash
+      [client_request_id, api_trace_id, response_type, ipg_transaction_id, order_id, transaction_type, payment_token, transaction_origin, payment_method, country, terminal_id, merchant_transaction_id, transaction_time, approved_amount, transaction_status, transaction_state, secure3d_response, redirect_url, authentication_redirect, scheme_transaction_id, processor, additional_details, error].hash
     end
 
     # Builds the object from hash
@@ -341,12 +373,12 @@ module SwaggerClient
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      self.class.swagger_types.each_pair do |key, type|
+      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) } )
+            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]]))
@@ -393,7 +425,7 @@ module SwaggerClient
           end
         end
       else # model
-        temp_model = SwaggerClient.const_get(type).new
+        temp_model = OpenapiClient.const_get(type).new
         temp_model.build_from_hash(value)
       end
     end
@@ -428,7 +460,7 @@ module SwaggerClient
     # @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) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -439,7 +471,5 @@ module SwaggerClient
         value
       end
     end
-
   end
-
 end

data/lib/openapi_client/models/transaction_origin.rb

@@ -0,0 +1,32 @@
+=begin
+#Payment Gateway API Specification.
+
+#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
+
+OpenAPI spec version: 6.4.0.20181018.001
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: unset
+
+=end
+
+require 'date'
+
+module OpenapiClient
+  class TransactionOrigin
+    
+    ECOM = 'ECOM'.freeze
+    MAIL = 'MAIL'.freeze
+    PHONE = 'PHONE'.freeze
+    RETAIL = 'RETAIL'.freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = TransactionOrigin.constants.select { |c| TransactionOrigin::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #TransactionOrigin" if constantValues.empty?
+      value
+    end
+  end
+end