fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/account_info.rb

@@ -0,0 +1,338 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # This field contains additional information about the Cardholder's account
+  # provided by the 3DS Requestor. The field is optional but recommended to
+  # include.
+  class AccountInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Length of time that the cardholder has had the account with the 3DS
+    # Requestor.
+    # >01 - No account
+    # >
+    # >02 - Created during this transaction
+    # >
+    # >03 - Less than 30 days
+    # >
+    # >04 - Between 30 and 60 days
+    # >
+    # >05 - More than 60 days
+    # >
+    # @return [ChAccAgeIndEnum]
+    attr_accessor :ch_acc_age_ind
+
+    # Date converted into UTC that the cardholder opened the account with the
+    # 3DS Requestor. Date format = YYYYMMDD.
+    # @return [String]
+    attr_accessor :ch_acc_date
+
+    # Length of time since the cardholder's account information with the 3DS
+    # Requestor was last changed. Includes Billing or Shipping address, new
+    # payment account, or new user(s) added.
+    # >01 - Changed during this transaction
+    # >
+    # >02 - Less than 30 days
+    # >
+    # >03 - 30 - 60 days
+    # >
+    # >04 - More than 60 days
+    # >
+    # @return [ChAccChangeIndEnum]
+    attr_accessor :ch_acc_change_ind
+
+    # Date converted into UTC that the cardholder's account with the 3DS
+    # Requestor was last changed. Including Billing or Shipping address, new
+    # payment account, or new user(s) added. Date format = YYYYMMDD.
+    # @return [String]
+    attr_accessor :ch_acc_change
+
+    # Length of time since the cardholder's account with the 3DS Requestor had a
+    # password change or account reset.
+    # >01 - No change
+    # >
+    # >02 - Changed during this transaction
+    # >
+    # >03 - Less than 30 days
+    # >
+    # >04 - 30 - 60 days
+    # >
+    # >05 - More than 60 days
+    # >
+    # @return [ChAccPwChangeIndEnum]
+    attr_accessor :ch_acc_pw_change_ind
+
+    # Date converted into UTC that cardholder's account with the 3DS Requestor
+    # had a password change or account reset. Date format must be YYYYMMDD.
+    # @return [String]
+    attr_accessor :ch_acc_pw_change
+
+    # Indicates when the shipping address used for this transaction was first
+    # used with the 3DS Requestor.
+    # >01 - This transaction
+    # >
+    # >02 - Less than 30 days
+    # >
+    # >03 - 30 - 60 days
+    # >
+    # >04 - More than 60 days
+    # >
+    # @return [ShipAddressUsageIndEnum]
+    attr_accessor :ship_address_usage_ind
+
+    # Date converted into UTC when the shipping address used for this
+    # transaction was first used with the 3DS Requestor. Date format must be
+    # YYYYMMDD.
+    # @return [String]
+    attr_accessor :ship_address_usage
+
+    # Number of transactions (successful and abandoned) for this cardholder
+    # account with the 3DS Requestor across all payment accounts in the previous
+    # 24 hours.
+    # @return [Integer]
+    attr_accessor :txn_activity_day
+
+    # Number of transactions (successful and abandoned) for this cardholder
+    # account with the 3DS Requestor across all payment accounts in the previous
+    # year.
+    # @return [Integer]
+    attr_accessor :txn_activity_year
+
+    # Number of Add Card attempts in the last 24 hours.
+    # @return [Integer]
+    attr_accessor :provision_attempts_day
+
+    # Number of purchases with this cardholder account during the previous six
+    # months.
+    # @return [Integer]
+    attr_accessor :nb_purchase_account
+
+    # Indicates whether the 3DS Requestor has experienced suspicious activity
+    # including previous fraud) on the cardholder account.
+    # >01 - No suspicious activity has been observed
+    # >
+    # >02 - Suspicious activity has been observed
+    # >
+    # @return [SuspiciousAccActivityEnum]
+    attr_accessor :suspicious_acc_activity
+
+    # Indicates if the Cardholder Name on the account is identical to the
+    # shipping Name used for this transaction.
+    # >01 - Account Name identical to shipping Name
+    # >
+    # >02 - Account Name different than shipping Name
+    # >
+    # @return [ShipNameIndicatorEnum]
+    attr_accessor :ship_name_indicator
+
+    # Indicates the length of time that the payment account was enrolled in the
+    # cardholder's account with the 3DS Requestor.
+    # >01 - No account (guest check-out)
+    # >
+    # >02 - During this transaction
+    # >
+    # >03 - Less than 30 days
+    # >
+    # >04 - 30 - 60 days
+    # >
+    # >05 - More than 60 days
+    # >
+    # @return [PaymentAccIndEnum]
+    attr_accessor :payment_acc_ind
+
+    # Date converted into UTC that the payment account was enrolled in the
+    # cardholder's account with the 3DS Requestor. Date format must be YYYYMMDD.
+    # @return [String]
+    attr_accessor :payment_acc_age
+
+    # The 3DS Requestor assigned account identifier of the transacting
+    # Cardholder. This identifier is a unique representation of the account
+    # identifier for the 3DS Requestor and is provided as a String.
+    # This field is supported in Starting from EMV 3DS 2.3.1 and later.
+    # @return [String]
+    attr_accessor :ch_acc_req_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ch_acc_age_ind'] = 'ch_acc_age_ind'
+      @_hash['ch_acc_date'] = 'ch_acc_date'
+      @_hash['ch_acc_change_ind'] = 'ch_acc_change_ind'
+      @_hash['ch_acc_change'] = 'ch_acc_change'
+      @_hash['ch_acc_pw_change_ind'] = 'ch_acc_pw_change_ind'
+      @_hash['ch_acc_pw_change'] = 'ch_acc_pw_change'
+      @_hash['ship_address_usage_ind'] = 'ship_address_usage_ind'
+      @_hash['ship_address_usage'] = 'ship_address_usage'
+      @_hash['txn_activity_day'] = 'txn_activity_day'
+      @_hash['txn_activity_year'] = 'txn_activity_year'
+      @_hash['provision_attempts_day'] = 'provision_attempts_day'
+      @_hash['nb_purchase_account'] = 'nb_purchase_account'
+      @_hash['suspicious_acc_activity'] = 'suspicious_acc_activity'
+      @_hash['ship_name_indicator'] = 'ship_name_indicator'
+      @_hash['payment_acc_ind'] = 'payment_acc_ind'
+      @_hash['payment_acc_age'] = 'payment_acc_age'
+      @_hash['ch_acc_req_id'] = 'ch_acc_req_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ch_acc_age_ind
+        ch_acc_date
+        ch_acc_change_ind
+        ch_acc_change
+        ch_acc_pw_change_ind
+        ch_acc_pw_change
+        ship_address_usage_ind
+        ship_address_usage
+        txn_activity_day
+        txn_activity_year
+        provision_attempts_day
+        nb_purchase_account
+        suspicious_acc_activity
+        ship_name_indicator
+        payment_acc_ind
+        payment_acc_age
+        ch_acc_req_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        ch_acc_req_id
+      ]
+    end
+
+    def initialize(ch_acc_age_ind = SKIP, ch_acc_date = SKIP,
+                   ch_acc_change_ind = SKIP, ch_acc_change = SKIP,
+                   ch_acc_pw_change_ind = SKIP, ch_acc_pw_change = SKIP,
+                   ship_address_usage_ind = SKIP, ship_address_usage = SKIP,
+                   txn_activity_day = SKIP, txn_activity_year = SKIP,
+                   provision_attempts_day = SKIP, nb_purchase_account = SKIP,
+                   suspicious_acc_activity = SKIP, ship_name_indicator = SKIP,
+                   payment_acc_ind = SKIP, payment_acc_age = SKIP,
+                   ch_acc_req_id = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @ch_acc_age_ind = ch_acc_age_ind unless ch_acc_age_ind == SKIP
+      @ch_acc_date = ch_acc_date unless ch_acc_date == SKIP
+      @ch_acc_change_ind = ch_acc_change_ind unless ch_acc_change_ind == SKIP
+      @ch_acc_change = ch_acc_change unless ch_acc_change == SKIP
+      @ch_acc_pw_change_ind = ch_acc_pw_change_ind unless ch_acc_pw_change_ind == SKIP
+      @ch_acc_pw_change = ch_acc_pw_change unless ch_acc_pw_change == SKIP
+      @ship_address_usage_ind = ship_address_usage_ind unless ship_address_usage_ind == SKIP
+      @ship_address_usage = ship_address_usage unless ship_address_usage == SKIP
+      @txn_activity_day = txn_activity_day unless txn_activity_day == SKIP
+      @txn_activity_year = txn_activity_year unless txn_activity_year == SKIP
+      @provision_attempts_day = provision_attempts_day unless provision_attempts_day == SKIP
+      @nb_purchase_account = nb_purchase_account unless nb_purchase_account == SKIP
+      @suspicious_acc_activity = suspicious_acc_activity unless suspicious_acc_activity == SKIP
+      @ship_name_indicator = ship_name_indicator unless ship_name_indicator == SKIP
+      @payment_acc_ind = payment_acc_ind unless payment_acc_ind == SKIP
+      @payment_acc_age = payment_acc_age unless payment_acc_age == SKIP
+      @ch_acc_req_id = ch_acc_req_id unless ch_acc_req_id == 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.
+      ch_acc_age_ind =
+        hash.key?('ch_acc_age_ind') ? hash['ch_acc_age_ind'] : SKIP
+      ch_acc_date = hash.key?('ch_acc_date') ? hash['ch_acc_date'] : SKIP
+      ch_acc_change_ind =
+        hash.key?('ch_acc_change_ind') ? hash['ch_acc_change_ind'] : SKIP
+      ch_acc_change = hash.key?('ch_acc_change') ? hash['ch_acc_change'] : SKIP
+      ch_acc_pw_change_ind =
+        hash.key?('ch_acc_pw_change_ind') ? hash['ch_acc_pw_change_ind'] : SKIP
+      ch_acc_pw_change =
+        hash.key?('ch_acc_pw_change') ? hash['ch_acc_pw_change'] : SKIP
+      ship_address_usage_ind =
+        hash.key?('ship_address_usage_ind') ? hash['ship_address_usage_ind'] : SKIP
+      ship_address_usage =
+        hash.key?('ship_address_usage') ? hash['ship_address_usage'] : SKIP
+      txn_activity_day =
+        hash.key?('txn_activity_day') ? hash['txn_activity_day'] : SKIP
+      txn_activity_year =
+        hash.key?('txn_activity_year') ? hash['txn_activity_year'] : SKIP
+      provision_attempts_day =
+        hash.key?('provision_attempts_day') ? hash['provision_attempts_day'] : SKIP
+      nb_purchase_account =
+        hash.key?('nb_purchase_account') ? hash['nb_purchase_account'] : SKIP
+      suspicious_acc_activity =
+        hash.key?('suspicious_acc_activity') ? hash['suspicious_acc_activity'] : SKIP
+      ship_name_indicator =
+        hash.key?('ship_name_indicator') ? hash['ship_name_indicator'] : SKIP
+      payment_acc_ind =
+        hash.key?('payment_acc_ind') ? hash['payment_acc_ind'] : SKIP
+      payment_acc_age =
+        hash.key?('payment_acc_age') ? hash['payment_acc_age'] : SKIP
+      ch_acc_req_id = hash.key?('ch_acc_req_id') ? hash['ch_acc_req_id'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      AccountInfo.new(ch_acc_age_ind,
+                      ch_acc_date,
+                      ch_acc_change_ind,
+                      ch_acc_change,
+                      ch_acc_pw_change_ind,
+                      ch_acc_pw_change,
+                      ship_address_usage_ind,
+                      ship_address_usage,
+                      txn_activity_day,
+                      txn_activity_year,
+                      provision_attempts_day,
+                      nb_purchase_account,
+                      suspicious_acc_activity,
+                      ship_name_indicator,
+                      payment_acc_ind,
+                      payment_acc_age,
+                      ch_acc_req_id,
+                      additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ch_acc_age_ind: #{@ch_acc_age_ind}, ch_acc_date: #{@ch_acc_date},"\
+      " ch_acc_change_ind: #{@ch_acc_change_ind}, ch_acc_change: #{@ch_acc_change},"\
+      " ch_acc_pw_change_ind: #{@ch_acc_pw_change_ind}, ch_acc_pw_change: #{@ch_acc_pw_change},"\
+      " ship_address_usage_ind: #{@ship_address_usage_ind}, ship_address_usage:"\
+      " #{@ship_address_usage}, txn_activity_day: #{@txn_activity_day}, txn_activity_year:"\
+      " #{@txn_activity_year}, provision_attempts_day: #{@provision_attempts_day},"\
+      " nb_purchase_account: #{@nb_purchase_account}, suspicious_acc_activity:"\
+      " #{@suspicious_acc_activity}, ship_name_indicator: #{@ship_name_indicator},"\
+      " payment_acc_ind: #{@payment_acc_ind}, payment_acc_age: #{@payment_acc_age}, ch_acc_req_id:"\
+      " #{@ch_acc_req_id}, 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} ch_acc_age_ind: #{@ch_acc_age_ind.inspect}, ch_acc_date:"\
+      " #{@ch_acc_date.inspect}, ch_acc_change_ind: #{@ch_acc_change_ind.inspect}, ch_acc_change:"\
+      " #{@ch_acc_change.inspect}, ch_acc_pw_change_ind: #{@ch_acc_pw_change_ind.inspect},"\
+      " ch_acc_pw_change: #{@ch_acc_pw_change.inspect}, ship_address_usage_ind:"\
+      " #{@ship_address_usage_ind.inspect}, ship_address_usage: #{@ship_address_usage.inspect},"\
+      " txn_activity_day: #{@txn_activity_day.inspect}, txn_activity_year:"\
+      " #{@txn_activity_year.inspect}, provision_attempts_day: #{@provision_attempts_day.inspect},"\
+      " nb_purchase_account: #{@nb_purchase_account.inspect}, suspicious_acc_activity:"\
+      " #{@suspicious_acc_activity.inspect}, ship_name_indicator: #{@ship_name_indicator.inspect},"\
+      " payment_acc_ind: #{@payment_acc_ind.inspect}, payment_acc_age:"\
+      " #{@payment_acc_age.inspect}, ch_acc_req_id: #{@ch_acc_req_id.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/account_type12_enum.rb

@@ -0,0 +1,36 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Account type. Either "checking" or "savings"
+  class AccountType12Enum
+    ACCOUNT_TYPE12_ENUM = [
+      # TODO: Write general description for CHECKING
+      CHECKING = 'checking'.freeze,
+
+      # TODO: Write general description for SAVINGS
+      SAVINGS = 'savings'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCOUNT_TYPE12_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = CHECKING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'checking' then CHECKING
+      when 'savings' then SAVINGS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/account_type13_enum.rb

@@ -0,0 +1,39 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Account type >For ACH, must be provided as either 'checking' or 'savings'.
+  # For CC, field is read only. System will identify card_type and generate a
+  # value for this field automatically. i.e. visa, mc, disc, amex, jcb, diners.
+  # >
+  class AccountType13Enum
+    ACCOUNT_TYPE13_ENUM = [
+      # TODO: Write general description for SAVINGS
+      SAVINGS = 'savings'.freeze,
+
+      # TODO: Write general description for CHECKING
+      CHECKING = 'checking'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCOUNT_TYPE13_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = SAVINGS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'savings' then SAVINGS
+      when 'checking' then CHECKING
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/account_type16_enum.rb

@@ -0,0 +1,40 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Required for ACH transactions if account_vault_id is not provided. >For ACH,
+  # allowed values are 'checking' or 'savings'. For CC, this field is read only.
+  # The system will identify card type and generate a value for this field
+  # automatically. possible values are: visa, mc, disc, amex, jcb, diners, and
+  # debit. >
+  class AccountType16Enum
+    ACCOUNT_TYPE16_ENUM = [
+      # TODO: Write general description for CHECKING
+      CHECKING = 'checking'.freeze,
+
+      # TODO: Write general description for SAVINGS
+      SAVINGS = 'savings'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCOUNT_TYPE16_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = CHECKING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'checking' then CHECKING
+      when 'savings' then SAVINGS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/account_type_enum.rb

@@ -0,0 +1,64 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Account Type
+  class AccountTypeEnum
+    ACCOUNT_TYPE_ENUM = [
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'unknown'.freeze,
+
+      # TODO: Write general description for CHECKING
+      CHECKING = 'checking'.freeze,
+
+      # TODO: Write general description for CREDIT
+      CREDIT = 'credit'.freeze,
+
+      # TODO: Write general description for CASH_BENEFIT
+      CASH_BENEFIT = 'cash_benefit'.freeze,
+
+      # TODO: Write general description for SNAP
+      SNAP = 'snap'.freeze,
+
+      # TODO: Write general description for PREPAID
+      PREPAID = 'prepaid'.freeze,
+
+      # TODO: Write general description for SAVINGS
+      SAVINGS = 'savings'.freeze,
+
+      # TODO: Write general description for SPENDING_POWER
+      SPENDING_POWER = 'spending_power'.freeze,
+
+      # TODO: Write general description for UNIVERSAL
+      UNIVERSAL = 'universal'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCOUNT_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = UNKNOWN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'unknown' then UNKNOWN
+      when 'checking' then CHECKING
+      when 'credit' then CREDIT
+      when 'cash_benefit' then CASH_BENEFIT
+      when 'snap' then SNAP
+      when 'prepaid' then PREPAID
+      when 'savings' then SAVINGS
+      when 'spending_power' then SPENDING_POWER
+      when 'universal' then UNIVERSAL
+      else
+        default_value
+      end
+    end
+  end
+end