fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/identity_verification.rb

@@ -0,0 +1,112 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Identity Verification
+  class IdentityVerification < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Required for ACH transactions when Driver's License Verification is
+    # enabled on the terminal.  Either dl_number + dl_state OR customer_id will
+    # need to be passed in this scenario.
+    # @return [String]
+    attr_accessor :dl_state
+
+    # Required for ACH transactions when Driver's License Verification is
+    # enabled on the terminal.  Either dl_number + dl_state OR customer_id will
+    # need to be passed in this scenario.
+    # @return [String]
+    attr_accessor :dl_number
+
+    # Required for certain ACH transactions where Identity Verification has been
+    # enabled for the terminal.  Either ssn4 or dob_year will need to be passed
+    # in this scenario but NOT BOTH.
+    # @return [String]
+    attr_accessor :dob_year
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['dl_state'] = 'dl_state'
+      @_hash['dl_number'] = 'dl_number'
+      @_hash['dob_year'] = 'dob_year'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        dl_state
+        dl_number
+        dob_year
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        dl_state
+        dl_number
+        dob_year
+      ]
+    end
+
+    def initialize(dl_state = SKIP, dl_number = SKIP, dob_year = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @dl_state = dl_state unless dl_state == SKIP
+      @dl_number = dl_number unless dl_number == SKIP
+      @dob_year = dob_year unless dob_year == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      dl_state = hash.key?('dl_state') ? hash['dl_state'] : SKIP
+      dl_number = hash.key?('dl_number') ? hash['dl_number'] : SKIP
+      dob_year = hash.key?('dob_year') ? hash['dob_year'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      IdentityVerification.new(dl_state,
+                               dl_number,
+                               dob_year,
+                               additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [IdentityVerification | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} dl_state: #{@dl_state}, dl_number: #{@dl_number}, dob_year: #{@dob_year},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} dl_state: #{@dl_state.inspect}, dl_number: #{@dl_number.inspect}, dob_year:"\
+      " #{@dob_year.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/identity_verification2.rb

@@ -0,0 +1,110 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Identity verification
+  class IdentityVerification2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Used for certain ACH transactions where Driver's License is required by
+    # the terminal being used.
+    # @return [String]
+    attr_accessor :dl_state
+
+    # Used for certain ACH transactions where Driver's License is required by
+    # the terminal being used.
+    # @return [String]
+    attr_accessor :dl_number
+
+    # The last four of the account_holder social security number.
+    # @return [String]
+    attr_accessor :ssn4
+
+    # Used for certain ACH transactions where Identity Verification is enabled
+    # on the terminal being used.
+    # @return [String]
+    attr_accessor :dob_year
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['dl_state'] = 'dl_state'
+      @_hash['dl_number'] = 'dl_number'
+      @_hash['ssn4'] = 'ssn4'
+      @_hash['dob_year'] = 'dob_year'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        dl_state
+        dl_number
+        ssn4
+        dob_year
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        dl_state
+        dl_number
+        ssn4
+        dob_year
+      ]
+    end
+
+    def initialize(dl_state = SKIP, dl_number = SKIP, ssn4 = SKIP,
+                   dob_year = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @dl_state = dl_state unless dl_state == SKIP
+      @dl_number = dl_number unless dl_number == SKIP
+      @ssn4 = ssn4 unless ssn4 == SKIP
+      @dob_year = dob_year unless dob_year == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      dl_state = hash.key?('dl_state') ? hash['dl_state'] : SKIP
+      dl_number = hash.key?('dl_number') ? hash['dl_number'] : SKIP
+      ssn4 = hash.key?('ssn4') ? hash['ssn4'] : SKIP
+      dob_year = hash.key?('dob_year') ? hash['dob_year'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      IdentityVerification2.new(dl_state,
+                                dl_number,
+                                ssn4,
+                                dob_year,
+                                additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} dl_state: #{@dl_state}, dl_number: #{@dl_number}, ssn4: #{@ssn4}, dob_year:"\
+      " #{@dob_year}, additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} dl_state: #{@dl_state.inspect}, dl_number: #{@dl_number.inspect}, ssn4:"\
+      " #{@ssn4.inspect}, dob_year: #{@dob_year.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/identity_verification27.rb

@@ -0,0 +1,110 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Identity Verification
+  class IdentityVerification27 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Required for ACH transactions when Driver's License Verification is
+    # enabled on the terminal.  Either dl_number + dl_state OR customer_id will
+    # need to be passed in this scenario.
+    # @return [String]
+    attr_accessor :dl_state
+
+    # Required for ACH transactions when Driver's License Verification is
+    # enabled on the terminal.  Either dl_number + dl_state OR customer_id will
+    # need to be passed in this scenario.
+    # @return [String]
+    attr_accessor :dl_number
+
+    # For ACH transactions where Identity Verification is enabled for terminal.
+    # Only ssn4 or dob_year should be passed. not both.
+    # @return [String]
+    attr_accessor :ssn4
+
+    # Required for certain ACH transactions where Identity Verification has been
+    # enabled for the terminal.  Either ssn4 or dob_year will need to be passed
+    # in this scenario but NOT BOTH.
+    # @return [String]
+    attr_accessor :dob_year
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['dl_state'] = 'dl_state'
+      @_hash['dl_number'] = 'dl_number'
+      @_hash['ssn4'] = 'ssn4'
+      @_hash['dob_year'] = 'dob_year'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ssn4
+        dob_year
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        ssn4
+        dob_year
+      ]
+    end
+
+    def initialize(dl_state = nil, dl_number = nil, ssn4 = SKIP,
+                   dob_year = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @dl_state = dl_state
+      @dl_number = dl_number
+      @ssn4 = ssn4 unless ssn4 == SKIP
+      @dob_year = dob_year unless dob_year == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      dl_state = hash.key?('dl_state') ? hash['dl_state'] : nil
+      dl_number = hash.key?('dl_number') ? hash['dl_number'] : nil
+      ssn4 = hash.key?('ssn4') ? hash['ssn4'] : SKIP
+      dob_year = hash.key?('dob_year') ? hash['dob_year'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      IdentityVerification27.new(dl_state,
+                                 dl_number,
+                                 ssn4,
+                                 dob_year,
+                                 additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} dl_state: #{@dl_state}, dl_number: #{@dl_number}, ssn4: #{@ssn4}, dob_year:"\
+      " #{@dob_year}, additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} dl_state: #{@dl_state.inspect}, dl_number: #{@dl_number.inspect}, ssn4:"\
+      " #{@ssn4.inspect}, dob_year: #{@dob_year.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/idtype_enum.rb

@@ -0,0 +1,36 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Terminal Manufacturer ID Type
+  class IdtypeEnum
+    IDTYPE_ENUM = [
+      # TODO: Write general description for MAC
+      MAC = 'mac'.freeze,
+
+      # TODO: Write general description for SN
+      SN = 'sn'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      IDTYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = MAC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'mac' then MAC
+      when 'sn' then SN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/iias_ind_enum.rb

@@ -0,0 +1,46 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Possible values are '0', '1','2'
+  class IiasIndEnum
+    IIAS_IND_ENUM = [
+      # TODO: Write general description for ENUM_0
+      ENUM_0 = 0,
+
+      # TODO: Write general description for ENUM_1
+      ENUM_1 = 1,
+
+      # TODO: Write general description for ENUM_2
+      ENUM_2 = 2
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      IIAS_IND_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_0)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+      if str.match?(/\A\d+\z/)
+        num = str.to_i
+        return num if IIAS_IND_ENUM.include?(num)
+
+        return default_value
+      end
+
+      case str.downcase
+      when 'enum_0' then ENUM_0
+      when 'enum_1' then ENUM_1
+      when 'enum_2' then ENUM_2
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/industry_type_enum.rb

@@ -0,0 +1,52 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Industry Type
+  class IndustryTypeEnum
+    INDUSTRY_TYPE_ENUM = [
+      # TODO: Write general description for ECOMMERCE
+      ECOMMERCE = 'ecommerce'.freeze,
+
+      # TODO: Write general description for RESTAURANT
+      RESTAURANT = 'restaurant'.freeze,
+
+      # TODO: Write general description for LODGING
+      LODGING = 'lodging'.freeze,
+
+      # TODO: Write general description for MOTO
+      MOTO = 'moto'.freeze,
+
+      # TODO: Write general description for RETAIL
+      RETAIL = 'retail'.freeze,
+
+      # TODO: Write general description for ENUM_RETAIL_SELF_SERVE
+      ENUM_RETAIL_SELF_SERVE = 'retail self serve'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INDUSTRY_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ECOMMERCE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ecommerce' then ECOMMERCE
+      when 'restaurant' then RESTAURANT
+      when 'lodging' then LODGING
+      when 'moto' then MOTO
+      when 'retail' then RETAIL
+      when 'enum_retail_self_serve' then ENUM_RETAIL_SELF_SERVE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/initiation_type_enum.rb

@@ -0,0 +1,76 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Initiation Type
+  class InitiationTypeEnum
+    INITIATION_TYPE_ENUM = [
+      # TODO: Write general description for C101
+      C101 = 'C101'.freeze,
+
+      # TODO: Write general description for C102
+      C102 = 'C102'.freeze,
+
+      # TODO: Write general description for C103
+      C103 = 'C103'.freeze,
+
+      # TODO: Write general description for C104
+      C104 = 'C104'.freeze,
+
+      # TODO: Write general description for M101
+      M101 = 'M101'.freeze,
+
+      # TODO: Write general description for M102
+      M102 = 'M102'.freeze,
+
+      # TODO: Write general description for M103
+      M103 = 'M103'.freeze,
+
+      # TODO: Write general description for M104
+      M104 = 'M104'.freeze,
+
+      # TODO: Write general description for M205
+      M205 = 'M205'.freeze,
+
+      # TODO: Write general description for M206
+      M206 = 'M206'.freeze,
+
+      # TODO: Write general description for M207
+      M207 = 'M207'.freeze,
+
+      # TODO: Write general description for M208
+      M208 = 'M208'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INITIATION_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = C101)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'c101' then C101
+      when 'c102' then C102
+      when 'c103' then C103
+      when 'c104' then C104
+      when 'm101' then M101
+      when 'm102' then M102
+      when 'm103' then M103
+      when 'm104' then M104
+      when 'm205' then M205
+      when 'm206' then M206
+      when 'm207' then M207
+      when 'm208' then M208
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/interval_type_enum.rb

@@ -0,0 +1,40 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Interval Type
+  class IntervalTypeEnum
+    INTERVAL_TYPE_ENUM = [
+      # TODO: Write general description for D
+      D = 'd'.freeze,
+
+      # TODO: Write general description for W
+      W = 'w'.freeze,
+
+      # TODO: Write general description for M
+      M = 'm'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INTERVAL_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = D)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'd' then D
+      when 'w' then W
+      when 'm' then M
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/item_list.rb

@@ -0,0 +1,82 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # ItemList Model.
+  class ItemList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Item's Name, must be unique on the list
+    # @return [String]
+    attr_accessor :name
+
+    # Item's Amount
+    # @return [Integer]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP, amount = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @name = name unless name == SKIP
+      @amount = amount unless amount == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      ItemList.new(name,
+                   amount,
+                   additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, amount: #{@amount}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, amount: #{@amount.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end