first_data_gateway 1.1.0 → 1.2.0

data/lib/openapi_client/models/return_transaction.rb

@@ -0,0 +1,257 @@
+=begin
+#Payment Gateway API Specification.
+
+#The documentation here is designed to provide all of the technical guidance required to consume and integrate with our APIs for payment processing. To learn more about our APIs please visit https://docs.firstdata.com/org/gateway.
+
+OpenAPI spec version: 6.6.0.20190329.001
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: unset
+
+=end
+
+require 'date'
+
+module OpenapiClient
+  # Request to perform return transaction.
+  class ReturnTransaction
+    # 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
+
+    # Comment for the secondary transaction.
+    attr_accessor :comments
+
+    attr_accessor :transaction_amount
+
+    attr_accessor :soft_descriptor
+
+    attr_accessor :currency_conversion
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'request_type' => :'requestType',
+        :'store_id' => :'storeId',
+        :'comments' => :'comments',
+        :'transaction_amount' => :'transactionAmount',
+        :'soft_descriptor' => :'softDescriptor',
+        :'currency_conversion' => :'currencyConversion'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'request_type' => :'String',
+        :'store_id' => :'String',
+        :'comments' => :'String',
+        :'transaction_amount' => :'Amount',
+        :'soft_descriptor' => :'SoftDescriptor',
+        :'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?(:'comments')
+        self.comments = attributes[:'comments']
+      end
+
+      if attributes.has_key?(:'transactionAmount')
+        self.transaction_amount = attributes[:'transactionAmount']
+      end
+
+      if attributes.has_key?(:'softDescriptor')
+        self.soft_descriptor = attributes[:'softDescriptor']
+      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 @transaction_amount.nil?
+        invalid_properties.push('invalid value for "transaction_amount", transaction_amount cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @request_type.nil?
+      return false if !@store_id.nil? && @store_id.to_s.length > 20
+      return false if @transaction_amount.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
+
+    # 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 &&
+          comments == o.comments &&
+          transaction_amount == o.transaction_amount &&
+          soft_descriptor == o.soft_descriptor &&
+          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, comments, transaction_amount, soft_descriptor, 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/score_only_request.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,7 +13,7 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
-  # Fraud Detect request payload
+  # Fraud detect request payload.
   class ScoreOnlyRequest
     # Merchant reference code. Used by FirstAPI and reflected in settlement records and Webhook notifications. Typically, the merchantRef field is the purchase order number or unique sequence value associated to a given transaction.
     attr_accessor :merchant_ref
@@ -24,7 +24,7 @@ module OpenapiClient
     # Defines the type of the original transaction that is being evaluated for the Fraud Score.
     attr_accessor :original_transaction_type
 
-    # The unique ID of this transaction. Must be unique for the entire system (not just within a specific merchant or industry). Subsequent requests related to the same transaction must have the same transactionId (e.g. transaction/deposit or   transaction/authorization-reversal). This field is used formatching transactions with settlement and chargeback information. If there is no such ID available you may wish to compose one from fields available in both systems. Consider including backend, issuer, merchant id, date and time, amount, etc. as necessary.
+    # The unique ID of this transaction. Must be unique for the entire system (not just within a specific merchant or industry). Subsequent requests related to the same transaction must have the same transactionId (e.g. transaction/deposit or transaction/authorization-reversal). This field is used for matching transactions with settlement and chargeback information. If there is no such ID available you may wish to compose one from fields available in both systems. Consider including backend, issuer, merchant id, date and time, amount, etc. as necessary.
     attr_accessor :original_transaction_id
 
     # The amount processed for the original transaction.

data/lib/openapi_client/models/score_only_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
@@ -13,15 +13,15 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
-  # Fraud Detect response
+  # Fraud detect response.
   class ScoreOnlyResponse
-    # Unique trace ID for issue triage
+    # Unique trace ID for issue triage.
     attr_accessor :api_trace_id
 
     # Please refer to \"Errors Section\" for more info.
     attr_accessor :transaction_status
 
-    # If status returned is \"failure\", input validation errors occurred. Please refer to the \"Errors Section\" for more info.
+    # If status returned is \"failure\", input validation errors occurred. Please refer to the \"Errors Section\" for more info. Valid values are 'success' and 'failure'.
     attr_accessor :validation_status
 
     # The transactionType provided in request.
@@ -29,6 +29,7 @@ module OpenapiClient
 
     attr_accessor :fraud_score
 
+    # The action that should be taken for the request that was sent.
     attr_accessor :recommended_decision
 
     class EnumAttributeValidator

data/lib/openapi_client/models/score_only_response_fraud_score.rb

@@ -1,9 +1,9 @@
 =begin
 #Payment Gateway API Specification.
 
-#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
+#The documentation here is designed to provide all of the technical guidance required to consume and integrate with our APIs for payment processing. To learn more about our APIs please visit https://docs.firstdata.com/org/gateway.
 
-OpenAPI spec version: 6.4.0.20181018.001
+OpenAPI spec version: 6.6.0.20190329.001
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset
@@ -13,6 +13,7 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
+  # Fraud likelihood assessment consisting of a score, associated warning(s), and explanation(s) of score received.
   class ScoreOnlyResponseFraudScore
     # The score attributed to this request by our machine learning system, ranging from 0 (less likely to be fraud) to 1000 (more likely to be fraud).
     attr_accessor :score
@@ -20,7 +21,7 @@ module OpenapiClient
     # A list of non-critical warnings raised while processing the request. Warnings included in this list will have integration and data-quality related messages.
     attr_accessor :warnings
 
-    # Type of the explanation to the warning raised
+    # Explanation of the fraud score applied consisting of a description, type of the explanation, and rule (if applicable).
     attr_accessor :explanations
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/openapi_client/models/score_only_response_fraud_score_explanations.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
@@ -14,10 +14,13 @@ require 'date'
 
 module OpenapiClient
   class ScoreOnlyResponseFraudScoreExplanations
+    # Description of the fraud score explanation.
     attr_accessor :description
 
+    # ID of the rule being triggered.
     attr_accessor :rule
 
+    # Type of the explanation (model or rule).
     attr_accessor :type
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/openapi_client/models/secondary_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,37 +13,32 @@ OpenAPI Generator version: unset
 require 'date'
 
 module OpenapiClient
-  # Model for secondary financial transactions
+  # Model for secondary financial transactions. Abstract class, do not use this class directly, use one of its children.
   class SecondaryTransaction
-    attr_accessor :transaction_origin
+    # Object name of the secondary transaction request.
+    attr_accessor :request_type
 
-    attr_accessor :amount
+    # An optional outlet ID for clients that support multiple stores in the same developer app.
+    attr_accessor :store_id
 
-    attr_accessor :split_shipment
-
-    attr_accessor :soft_descriptor
-
-    attr_accessor :additional_details
+    # Comment for the secondary transaction.
+    attr_accessor :comments
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'transaction_origin' => :'transactionOrigin',
-        :'amount' => :'amount',
-        :'split_shipment' => :'splitShipment',
-        :'soft_descriptor' => :'softDescriptor',
-        :'additional_details' => :'additionalDetails'
+        :'request_type' => :'requestType',
+        :'store_id' => :'storeId',
+        :'comments' => :'comments'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'transaction_origin' => :'TransactionOrigin',
-        :'amount' => :'Amount',
-        :'split_shipment' => :'SplitShipment',
-        :'soft_descriptor' => :'SoftDescriptor',
-        :'additional_details' => :'SecondaryTransactionAdditionalDetails'
+        :'request_type' => :'String',
+        :'store_id' => :'String',
+        :'comments' => :'String'
       }
     end
 
@@ -55,24 +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?(:'transactionOrigin')
-        self.transaction_origin = attributes[:'transactionOrigin']
-      end
-
-      if attributes.has_key?(:'amount')
-        self.amount = attributes[:'amount']
+      if attributes.has_key?(:'requestType')
+        self.request_type = attributes[:'requestType']
       end
 
-      if attributes.has_key?(:'splitShipment')
-        self.split_shipment = attributes[:'splitShipment']
+      if attributes.has_key?(:'storeId')
+        self.store_id = attributes[:'storeId']
       end
 
-      if attributes.has_key?(:'softDescriptor')
-        self.soft_descriptor = attributes[:'softDescriptor']
-      end
-
-      if attributes.has_key?(:'additionalDetails')
-        self.additional_details = attributes[:'additionalDetails']
+      if attributes.has_key?(:'comments')
+        self.comments = attributes[:'comments']
       end
     end
 
@@ -80,25 +67,43 @@ module OpenapiClient
     # @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
+
       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
       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
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          transaction_origin == o.transaction_origin &&
-          amount == o.amount &&
-          split_shipment == o.split_shipment &&
-          soft_descriptor == o.soft_descriptor &&
-          additional_details == o.additional_details
+          request_type == o.request_type &&
+          store_id == o.store_id &&
+          comments == o.comments
     end
 
     # @see the `==` method
@@ -110,7 +115,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [transaction_origin, amount, split_shipment, soft_descriptor, additional_details].hash
+      [request_type, store_id, comments].hash
     end
 
     # Builds the object from hash