fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/transaction_split.rb

@@ -0,0 +1,127 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # TransactionSplit Model.
+  class TransactionSplit < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Transaction ID
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # Contact ID
+    # @return [String]
+    attr_accessor :contact_id
+
+    # Amount
+    # @return [Integer]
+    attr_accessor :amount
+
+    # Transaction Splits ID
+    # @return [String]
+    attr_accessor :id
+
+    # Created Time Stamp
+    # @return [Integer]
+    attr_accessor :created_ts
+
+    # User ID Created the register
+    # @return [String]
+    attr_accessor :created_user_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_id'] = 'transaction_id'
+      @_hash['contact_id'] = 'contact_id'
+      @_hash['amount'] = 'amount'
+      @_hash['id'] = 'id'
+      @_hash['created_ts'] = 'created_ts'
+      @_hash['created_user_id'] = 'created_user_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_id
+        contact_id
+        amount
+        id
+        created_ts
+        created_user_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        created_user_id
+      ]
+    end
+
+    def initialize(transaction_id = SKIP, contact_id = SKIP, amount = SKIP,
+                   id = SKIP, created_ts = SKIP, created_user_id = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @contact_id = contact_id unless contact_id == SKIP
+      @amount = amount unless amount == SKIP
+      @id = id unless id == SKIP
+      @created_ts = created_ts unless created_ts == SKIP
+      @created_user_id = created_user_id unless created_user_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.
+      transaction_id =
+        hash.key?('transaction_id') ? hash['transaction_id'] : SKIP
+      contact_id = hash.key?('contact_id') ? hash['contact_id'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      created_ts = hash.key?('created_ts') ? hash['created_ts'] : SKIP
+      created_user_id =
+        hash.key?('created_user_id') ? hash['created_user_id'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      TransactionSplit.new(transaction_id,
+                           contact_id,
+                           amount,
+                           id,
+                           created_ts,
+                           created_user_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} transaction_id: #{@transaction_id}, contact_id: #{@contact_id}, amount:"\
+      " #{@amount}, id: #{@id}, created_ts: #{@created_ts}, created_user_id: #{@created_user_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} transaction_id: #{@transaction_id.inspect}, contact_id:"\
+      " #{@contact_id.inspect}, amount: #{@amount.inspect}, id: #{@id.inspect}, created_ts:"\
+      " #{@created_ts.inspect}, created_user_id: #{@created_user_id.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/transaction_status_enum.rb

@@ -0,0 +1,73 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Indicates whether a transaction qualifies as an authenticated transaction.
+  # >Y - Authentication / Account verification successful > >N - Not
+  # authenticated / Account not verified; Transaction denied > >U -
+  # Authentication / Account verification could not be performed; technical or
+  # other problem > >C - In order to complete the authentication, a challenge is
+  # required > >R - Authentication / Account verification Rejected. Issuer is
+  # rejecting authentication/verification and request that authorization not be
+  # attempted > >A - Attempts processing performed; Not authenticated /
+  # verified, but a proof of attempt authentication / verification is provided >
+  # >D - In order to complete the authentication, a challenge is required.
+  # Decoupled Authentication confirmed. (Only if the 3DS Server has initiated
+  # authentication with EMV 3DS 2.2.0 version or greater) > >I - Informational
+  # Only; 3DS Requestor challenge preference acknowledged. (Only if the 3DS
+  # Server has initiated authentication with EMV 3DS 2.2.0 version or greater) >
+  class TransactionStatusEnum
+    TRANSACTION_STATUS_ENUM = [
+      # TODO: Write general description for Y
+      Y = 'Y'.freeze,
+
+      # TODO: Write general description for N
+      N = 'N'.freeze,
+
+      # TODO: Write general description for U
+      U = 'U'.freeze,
+
+      # TODO: Write general description for C
+      C = 'C'.freeze,
+
+      # TODO: Write general description for R
+      R = 'R'.freeze,
+
+      # TODO: Write general description for A
+      A = 'A'.freeze,
+
+      # TODO: Write general description for D
+      D = 'D'.freeze,
+
+      # TODO: Write general description for I
+      I = 'I'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TRANSACTION_STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = Y)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'y' then Y
+      when 'n' then N
+      when 'u' then U
+      when 'c' then C
+      when 'r' then R
+      when 'a' then A
+      when 'd' then D
+      when 'i' then I
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/transaction_type_enum.rb

@@ -0,0 +1,52 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Identifies the type of transaction being authenticated. The values are
+  # derived from ISO 8583. This field is required in some markets. Otherwise,
+  # the field is optional. >01 - Goods / Service purchase > >03 - Check
+  # Acceptance > >10 - Account Funding > >11 - Quasi-Cash Transaction > >28 -
+  # Prepaid activation and Loan >
+  class TransactionTypeEnum
+    TRANSACTION_TYPE_ENUM = [
+      # TODO: Write general description for ENUM_01
+      ENUM_01 = '01'.freeze,
+
+      # TODO: Write general description for ENUM_03
+      ENUM_03 = '03'.freeze,
+
+      # TODO: Write general description for ENUM_10
+      ENUM_10 = '10'.freeze,
+
+      # TODO: Write general description for ENUM_11
+      ENUM_11 = '11'.freeze,
+
+      # TODO: Write general description for ENUM_28
+      ENUM_28 = '28'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TRANSACTION_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_01)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_01' then ENUM_01
+      when 'enum_03' then ENUM_03
+      when 'enum_10' then ENUM_10
+      when 'enum_11' then ENUM_11
+      when 'enum_28' then ENUM_28
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/trx_source_code_enum.rb

@@ -0,0 +1,143 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # How the transaction was obtained by the API. >1 - Unknown - The origination
+  # of this transaction could not be determined. > >2 - Mobile - The origination
+  # of this transaction is through the mobile application. This is always a
+  # merchant submitted payment. > >3 - Web - The origination of this transaction
+  # is through a web browser. This is always a merchant submitted payment.
+  # Examples include Virtual Terminal, Contact Charge, and Transaction Details -
+  # Run Again pages. > >4 - IVR Transaction - The origination of this
+  # transaction is over the phone. This payment is submitted by an automated
+  # system initiated by the cardholder. > >5 - Contact Statement - The
+  # orignation of this transaction is through a Vericle statement. > >6 -
+  # Contact Payment Mobile - The origination of this transaction is through the
+  # mobile application. This is always submitted by a contact user.  > >7 -
+  # Contact Payment - The origination of this transaction is through a web
+  # browser. This is always submitted by a contact user. > >8 - Quick Invoice -
+  # The orignation of this transaction is through a Quick Invoice. This is
+  # typically submitted by a contact user, however the transaction can also be
+  # submitted by a merchant. > >9 - Payform - The origination of this
+  # transaction is through a Payform. This is typically a merchant submitted
+  # transaction, and is always from an internal developer. > >10 - Hosted
+  # Payment Page - The orignation of this transaction is through a Hosted
+  # Payment Page. This is typically a cardholder submitted transaction. > >11 -
+  # Emulator -  The origination of this transaction is through Auth.Net
+  # emulator. This is typically submitted through an integration to a website or
+  # a shopping cart. > >12 - Integration - The orignation of this transaction is
+  # through an integrated solution. This will always be from an external
+  # developer. > >13 - Recurring Billing - The orignation of this transaction is
+  # through a scheduled recurring payment. This payment is system-initiated
+  # based on a payment schedule that has been configured. > >14 - Recurring
+  # Secondary - This feature has not been implented yet. > >15 - Declined
+  # Recurring Email - The orignation of this transaction is through the email
+  # notification sent when a recurring payment has been declined. This is
+  # typically submitted by a cardholder. > >16 - Paylink - The orignation of
+  # this transaction is through a Paylink. This is typically submitted by a
+  # contact user, however the transaction can also be submitted by a merchant. >
+  # >17 - Elements - The origination of this transaction is through the Elements
+  # payments page. This can be a cardholder submitted or a merchant submitted
+  # transaction. > >18 - ACH Import - The origination of this transaction is
+  # through an ACH file import. This is a merchant initiated process. >
+  class TrxSourceCodeEnum
+    TRX_SOURCE_CODE_ENUM = [
+      # TODO: Write general description for ENUM_1
+      ENUM_1 = 1,
+
+      # TODO: Write general description for ENUM_2
+      ENUM_2 = 2,
+
+      # TODO: Write general description for ENUM_3
+      ENUM_3 = 3,
+
+      # TODO: Write general description for ENUM_4
+      ENUM_4 = 4,
+
+      # TODO: Write general description for ENUM_5
+      ENUM_5 = 5,
+
+      # TODO: Write general description for ENUM_6
+      ENUM_6 = 6,
+
+      # TODO: Write general description for ENUM_7
+      ENUM_7 = 7,
+
+      # TODO: Write general description for ENUM_8
+      ENUM_8 = 8,
+
+      # TODO: Write general description for ENUM_9
+      ENUM_9 = 9,
+
+      # TODO: Write general description for ENUM_10
+      ENUM_10 = 10,
+
+      # TODO: Write general description for ENUM_11
+      ENUM_11 = 11,
+
+      # TODO: Write general description for ENUM_12
+      ENUM_12 = 12,
+
+      # TODO: Write general description for ENUM_13
+      ENUM_13 = 13,
+
+      # TODO: Write general description for ENUM_14
+      ENUM_14 = 14,
+
+      # TODO: Write general description for ENUM_15
+      ENUM_15 = 15,
+
+      # TODO: Write general description for ENUM_16
+      ENUM_16 = 16,
+
+      # TODO: Write general description for ENUM_17
+      ENUM_17 = 17,
+
+      # TODO: Write general description for ENUM_18
+      ENUM_18 = 18
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TRX_SOURCE_CODE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_1)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+      if str.match?(/\A\d+\z/)
+        num = str.to_i
+        return num if TRX_SOURCE_CODE_ENUM.include?(num)
+
+        return default_value
+      end
+
+      case str.downcase
+      when 'enum_1' then ENUM_1
+      when 'enum_2' then ENUM_2
+      when 'enum_3' then ENUM_3
+      when 'enum_4' then ENUM_4
+      when 'enum_5' then ENUM_5
+      when 'enum_6' then ENUM_6
+      when 'enum_7' then ENUM_7
+      when 'enum_8' then ENUM_8
+      when 'enum_9' then ENUM_9
+      when 'enum_10' then ENUM_10
+      when 'enum_11' then ENUM_11
+      when 'enum_12' then ENUM_12
+      when 'enum_13' then ENUM_13
+      when 'enum_14' then ENUM_14
+      when 'enum_15' then ENUM_15
+      when 'enum_16' then ENUM_16
+      when 'enum_17' then ENUM_17
+      when 'enum_18' then ENUM_18
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/trx_source_id_enum.rb

@@ -0,0 +1,143 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # How the transaction was obtained by the API. >1 - Unknown - The origination
+  # of this transaction could not be determined. > >2 - Mobile - The origination
+  # of this transaction is through the mobile application. This is always a
+  # merchant submitted payment. > >3 - Web - The origination of this transaction
+  # is through a web browser. This is always a merchant submitted payment.
+  # Examples include Virtual Terminal, Contact Charge, and Transaction Details -
+  # Run Again pages. > >4 - IVR Transaction - The origination of this
+  # transaction is over the phone. This payment is submitted by an automated
+  # system initiated by the cardholder. > >5 - Contact Statement - The
+  # orignation of this transaction is through a Vericle statement. > >6 -
+  # Contact Payment Mobile - The origination of this transaction is through the
+  # mobile application. This is always submitted by a contact user.  > >7 -
+  # Contact Payment - The origination of this transaction is through a web
+  # browser. This is always submitted by a contact user. > >8 - Quick Invoice -
+  # The orignation of this transaction is through a Quick Invoice. This is
+  # typically submitted by a contact user, however the transaction can also be
+  # submitted by a merchant. > >9 - Payform - The origination of this
+  # transaction is through a Payform. This is typically a merchant submitted
+  # transaction, and is always from an internal developer. > >10 - Hosted
+  # Payment Page - The orignation of this transaction is through a Hosted
+  # Payment Page. This is typically a cardholder submitted transaction. > >11 -
+  # Emulator -  The origination of this transaction is through Auth.Net
+  # emulator. This is typically submitted through an integration to a website or
+  # a shopping cart. > >12 - Integration - The orignation of this transaction is
+  # through an integrated solution. This will always be from an external
+  # developer. > >13 - Recurring Billing - The orignation of this transaction is
+  # through a scheduled recurring payment. This payment is system-initiated
+  # based on a payment schedule that has been configured. > >14 - Recurring
+  # Secondary - This feature has not been implented yet. > >15 - Declined
+  # Recurring Email - The orignation of this transaction is through the email
+  # notification sent when a recurring payment has been declined. This is
+  # typically submitted by a cardholder. > >16 - Paylink - The orignation of
+  # this transaction is through a Paylink. This is typically submitted by a
+  # contact user, however the transaction can also be submitted by a merchant. >
+  # >17 - Elements - The origination of this transaction is through the Elements
+  # payments page. This can be a cardholder submitted or a merchant submitted
+  # transaction. > >18 - ACH Import - The origination of this transaction is
+  # through an ACH file import. This is a merchant initiated process. >
+  class TrxSourceIdEnum
+    TRX_SOURCE_ID_ENUM = [
+      # TODO: Write general description for ENUM_1
+      ENUM_1 = 1,
+
+      # TODO: Write general description for ENUM_2
+      ENUM_2 = 2,
+
+      # TODO: Write general description for ENUM_3
+      ENUM_3 = 3,
+
+      # TODO: Write general description for ENUM_4
+      ENUM_4 = 4,
+
+      # TODO: Write general description for ENUM_5
+      ENUM_5 = 5,
+
+      # TODO: Write general description for ENUM_6
+      ENUM_6 = 6,
+
+      # TODO: Write general description for ENUM_7
+      ENUM_7 = 7,
+
+      # TODO: Write general description for ENUM_8
+      ENUM_8 = 8,
+
+      # TODO: Write general description for ENUM_9
+      ENUM_9 = 9,
+
+      # TODO: Write general description for ENUM_10
+      ENUM_10 = 10,
+
+      # TODO: Write general description for ENUM_11
+      ENUM_11 = 11,
+
+      # TODO: Write general description for ENUM_12
+      ENUM_12 = 12,
+
+      # TODO: Write general description for ENUM_13
+      ENUM_13 = 13,
+
+      # TODO: Write general description for ENUM_14
+      ENUM_14 = 14,
+
+      # TODO: Write general description for ENUM_15
+      ENUM_15 = 15,
+
+      # TODO: Write general description for ENUM_16
+      ENUM_16 = 16,
+
+      # TODO: Write general description for ENUM_17
+      ENUM_17 = 17,
+
+      # TODO: Write general description for ENUM_18
+      ENUM_18 = 18
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TRX_SOURCE_ID_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_1)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+      if str.match?(/\A\d+\z/)
+        num = str.to_i
+        return num if TRX_SOURCE_ID_ENUM.include?(num)
+
+        return default_value
+      end
+
+      case str.downcase
+      when 'enum_1' then ENUM_1
+      when 'enum_2' then ENUM_2
+      when 'enum_3' then ENUM_3
+      when 'enum_4' then ENUM_4
+      when 'enum_5' then ENUM_5
+      when 'enum_6' then ENUM_6
+      when 'enum_7' then ENUM_7
+      when 'enum_8' then ENUM_8
+      when 'enum_9' then ENUM_9
+      when 'enum_10' then ENUM_10
+      when 'enum_11' then ENUM_11
+      when 'enum_12' then ENUM_12
+      when 'enum_13' then ENUM_13
+      when 'enum_14' then ENUM_14
+      when 'enum_15' then ENUM_15
+      when 'enum_16' then ENUM_16
+      when 'enum_17' then ENUM_17
+      when 'enum_18' then ENUM_18
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/type103_enum.rb

@@ -0,0 +1,26 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Resource Type
+  class Type103Enum
+    TYPE103_ENUM = [
+      # TODO: Write general description for TRANSACTIONACHRETRYSCOLLECTION
+      TRANSACTIONACHRETRYSCOLLECTION = 'TransactionAchRetrysCollection'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE103_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = TRANSACTIONACHRETRYSCOLLECTION)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/fortis_api/models/type10_enum.rb

@@ -0,0 +1,26 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Resource Type
+  class Type10Enum
+    TYPE10_ENUM = [
+      # TODO: Write general description for CONTACT
+      CONTACT = 'Contact'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE10_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = CONTACT)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/fortis_api/models/type110_enum.rb

@@ -0,0 +1,26 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Resource Type
+  class Type110Enum
+    TYPE110_ENUM = [
+      # TODO: Write general description for TRANSACTION
+      TRANSACTION = 'Transaction'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE110_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = TRANSACTION)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end