first_data_gateway 1.11.0 → 1.12.0

data/lib/openapi_client/models/split_shipment.rb

@@ -3,10 +3,10 @@
 
 #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.2.0.20210406.001
+The version of the OpenAPI document: 21.3.0.20210608.001
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: unset
+OpenAPI Generator version: 4.1.1
 
 =end
 

data/lib/openapi_client/models/stand_in_details.rb

@@ -0,0 +1,373 @@
+=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.3.0.20210608.001
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.1
+
+=end
+
+require 'date'
+
+module OpenapiClient
+  # Indicates standin transaction.
+  class StandInDetails
+    # Indicates standin instruction type.
+    attr_accessor :stand_in_type
+
+    # Indicates number of standin instruction debits.Possible values can be two digit number or UN (Until it is cancelled) or ND (Not defined).
+    attr_accessor :number_of_debits
+
+    # Indicates standin instruction validation flag, it can be true or false. \"false\" - Not validated, \"true\" - Validated.
+    attr_accessor :si_validated
+
+    # Maximum debit amount per standin instruction transaction.
+    attr_accessor :maximum_transaction_amount
+
+    # Unique identifier for standin instruction.
+    attr_accessor :si_hub_id
+
+    # Indicates frequency of the standin instruction debit.
+    attr_accessor :frequency
+
+    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
+      {
+        :'stand_in_type' => :'standInType',
+        :'number_of_debits' => :'numberOfDebits',
+        :'si_validated' => :'siValidated',
+        :'maximum_transaction_amount' => :'maximumTransactionAmount',
+        :'si_hub_id' => :'siHubId',
+        :'frequency' => :'frequency'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'stand_in_type' => :'String',
+        :'number_of_debits' => :'String',
+        :'si_validated' => :'Boolean',
+        :'maximum_transaction_amount' => :'Float',
+        :'si_hub_id' => :'String',
+        :'frequency' => :'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::StandInDetails` 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::StandInDetails`. 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?(:'stand_in_type')
+        self.stand_in_type = attributes[:'stand_in_type']
+      end
+
+      if attributes.key?(:'number_of_debits')
+        self.number_of_debits = attributes[:'number_of_debits']
+      end
+
+      if attributes.key?(:'si_validated')
+        self.si_validated = attributes[:'si_validated']
+      end
+
+      if attributes.key?(:'maximum_transaction_amount')
+        self.maximum_transaction_amount = attributes[:'maximum_transaction_amount']
+      end
+
+      if attributes.key?(:'si_hub_id')
+        self.si_hub_id = attributes[:'si_hub_id']
+      end
+
+      if attributes.key?(:'frequency')
+        self.frequency = attributes[:'frequency']
+      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 @stand_in_type.nil?
+        invalid_properties.push('invalid value for "stand_in_type", stand_in_type cannot be nil.')
+      end
+
+      if @number_of_debits.nil?
+        invalid_properties.push('invalid value for "number_of_debits", number_of_debits cannot be nil.')
+      end
+
+      pattern = Regexp.new(/(UN)|(ND)|([0-9]{2})/)
+      if @number_of_debits !~ pattern
+        invalid_properties.push("invalid value for \"number_of_debits\", must conform to the pattern #{pattern}.")
+      end
+
+      if @si_validated.nil?
+        invalid_properties.push('invalid value for "si_validated", si_validated cannot be nil.')
+      end
+
+      if @maximum_transaction_amount.nil?
+        invalid_properties.push('invalid value for "maximum_transaction_amount", maximum_transaction_amount cannot be nil.')
+      end
+
+      if @si_hub_id.nil?
+        invalid_properties.push('invalid value for "si_hub_id", si_hub_id cannot be nil.')
+      end
+
+      if @si_hub_id.to_s.length > 10
+        invalid_properties.push('invalid value for "si_hub_id", the character length must be smaller than or equal to 10.')
+      end
+
+      if @frequency.nil?
+        invalid_properties.push('invalid value for "frequency", frequency 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 @stand_in_type.nil?
+      stand_in_type_validator = EnumAttributeValidator.new('String', ["FIXED_AMOUNT", "MAXIMUM_AMOUNT"])
+      return false unless stand_in_type_validator.valid?(@stand_in_type)
+      return false if @number_of_debits.nil?
+      return false if @number_of_debits !~ Regexp.new(/(UN)|(ND)|([0-9]{2})/)
+      return false if @si_validated.nil?
+      return false if @maximum_transaction_amount.nil?
+      return false if @si_hub_id.nil?
+      return false if @si_hub_id.to_s.length > 10
+      return false if @frequency.nil?
+      frequency_validator = EnumAttributeValidator.new('String', ["WEEKLY", "FORTNIGHTLY", "MONTHLY", "QUARTERLY", "HALFYEARLY", "YEARLY", "UNSCHEDULED"])
+      return false unless frequency_validator.valid?(@frequency)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] stand_in_type Object to be assigned
+    def stand_in_type=(stand_in_type)
+      validator = EnumAttributeValidator.new('String', ["FIXED_AMOUNT", "MAXIMUM_AMOUNT"])
+      unless validator.valid?(stand_in_type)
+        fail ArgumentError, "invalid value for \"stand_in_type\", must be one of #{validator.allowable_values}."
+      end
+      @stand_in_type = stand_in_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] number_of_debits Value to be assigned
+    def number_of_debits=(number_of_debits)
+      if number_of_debits.nil?
+        fail ArgumentError, 'number_of_debits cannot be nil'
+      end
+
+      pattern = Regexp.new(/(UN)|(ND)|([0-9]{2})/)
+      if number_of_debits !~ pattern
+        fail ArgumentError, "invalid value for \"number_of_debits\", must conform to the pattern #{pattern}."
+      end
+
+      @number_of_debits = number_of_debits
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] si_hub_id Value to be assigned
+    def si_hub_id=(si_hub_id)
+      if si_hub_id.nil?
+        fail ArgumentError, 'si_hub_id cannot be nil'
+      end
+
+      if si_hub_id.to_s.length > 10
+        fail ArgumentError, 'invalid value for "si_hub_id", the character length must be smaller than or equal to 10.'
+      end
+
+      @si_hub_id = si_hub_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] frequency Object to be assigned
+    def frequency=(frequency)
+      validator = EnumAttributeValidator.new('String', ["WEEKLY", "FORTNIGHTLY", "MONTHLY", "QUARTERLY", "HALFYEARLY", "YEARLY", "UNSCHEDULED"])
+      unless validator.valid?(frequency)
+        fail ArgumentError, "invalid value for \"frequency\", must be one of #{validator.allowable_values}."
+      end
+      @frequency = frequency
+    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 &&
+          stand_in_type == o.stand_in_type &&
+          number_of_debits == o.number_of_debits &&
+          si_validated == o.si_validated &&
+          maximum_transaction_amount == o.maximum_transaction_amount &&
+          si_hub_id == o.si_hub_id &&
+          frequency == o.frequency
+    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
+      [stand_in_type, number_of_debits, si_validated, maximum_transaction_amount, si_hub_id, frequency].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/standin_response_details.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.
+
+The version of the OpenAPI document: 21.3.0.20210608.001
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.1
+
+=end
+
+require 'date'
+
+module OpenapiClient
+  # Contains Standin response details.
+  class StandinResponseDetails
+    # Secure 3D Enrolment Status.
+    attr_accessor :secure3_d_enrolment_status
+
+    # Secure 3D ECI.
+    attr_accessor :secure3_deci
+
+    # Secure 3D Authentication Response.
+    attr_accessor :secure3_d_authentication_response
+
+    # Secure 3D Authentication Value.
+    attr_accessor :authentication_value
+
+    # Secure 3D XID.
+    attr_accessor :x_id
+
+    # Secure 3D Authentication Algorithm.
+    attr_accessor :authentication_algorithm
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'secure3_d_enrolment_status' => :'secure3DEnrolmentStatus',
+        :'secure3_deci' => :'secure3DECI',
+        :'secure3_d_authentication_response' => :'secure3DAuthenticationResponse',
+        :'authentication_value' => :'authenticationValue',
+        :'x_id' => :'xID',
+        :'authentication_algorithm' => :'authenticationAlgorithm'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'secure3_d_enrolment_status' => :'String',
+        :'secure3_deci' => :'String',
+        :'secure3_d_authentication_response' => :'String',
+        :'authentication_value' => :'String',
+        :'x_id' => :'String',
+        :'authentication_algorithm' => :'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::StandinResponseDetails` 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::StandinResponseDetails`. 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?(:'secure3_d_enrolment_status')
+        self.secure3_d_enrolment_status = attributes[:'secure3_d_enrolment_status']
+      end
+
+      if attributes.key?(:'secure3_deci')
+        self.secure3_deci = attributes[:'secure3_deci']
+      end
+
+      if attributes.key?(:'secure3_d_authentication_response')
+        self.secure3_d_authentication_response = attributes[:'secure3_d_authentication_response']
+      end
+
+      if attributes.key?(:'authentication_value')
+        self.authentication_value = attributes[:'authentication_value']
+      end
+
+      if attributes.key?(:'x_id')
+        self.x_id = attributes[:'x_id']
+      end
+
+      if attributes.key?(:'authentication_algorithm')
+        self.authentication_algorithm = attributes[:'authentication_algorithm']
+      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
+      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?
+      true
+    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 &&
+          secure3_d_enrolment_status == o.secure3_d_enrolment_status &&
+          secure3_deci == o.secure3_deci &&
+          secure3_d_authentication_response == o.secure3_d_authentication_response &&
+          authentication_value == o.authentication_value &&
+          x_id == o.x_id &&
+          authentication_algorithm == o.authentication_algorithm
+    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
+      [secure3_d_enrolment_status, secure3_deci, secure3_d_authentication_response, authentication_value, x_id, authentication_algorithm].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