fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/ach_sec_code1_enum.rb

@@ -0,0 +1,52 @@
+# 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.
+  class AchSecCode1Enum
+    ACH_SEC_CODE1_ENUM = [
+      # TODO: Write general description for CCD
+      CCD = 'CCD'.freeze,
+
+      # TODO: Write general description for PPD
+      PPD = 'PPD'.freeze,
+
+      # TODO: Write general description for TEL
+      TEL = 'TEL'.freeze,
+
+      # TODO: Write general description for WEB
+      WEB = 'WEB'.freeze,
+
+      # TODO: Write general description for POP
+      POP = 'POP'.freeze,
+
+      # TODO: Write general description for C21
+      C21 = 'C21'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACH_SEC_CODE1_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = CCD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ccd' then CCD
+      when 'ppd' then PPD
+      when 'tel' then TEL
+      when 'web' then WEB
+      when 'pop' then POP
+      when 'c21' then C21
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/ach_sec_code31_enum.rb

@@ -0,0 +1,53 @@
+# 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. >Only
+  # CCD, PPD, TEL, and WEB are supported for FortisAch. >
+  class AchSecCode31Enum
+    ACH_SEC_CODE31_ENUM = [
+      # TODO: Write general description for CCD
+      CCD = 'CCD'.freeze,
+
+      # TODO: Write general description for PPD
+      PPD = 'PPD'.freeze,
+
+      # TODO: Write general description for TEL
+      TEL = 'TEL'.freeze,
+
+      # TODO: Write general description for WEB
+      WEB = 'WEB'.freeze,
+
+      # TODO: Write general description for POP
+      POP = 'POP'.freeze,
+
+      # TODO: Write general description for C21
+      C21 = 'C21'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACH_SEC_CODE31_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = CCD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ccd' then CCD
+      when 'ppd' then PPD
+      when 'tel' then TEL
+      when 'web' then WEB
+      when 'pop' then POP
+      when 'c21' then C21
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/ach_sec_code3_enum.rb

@@ -0,0 +1,52 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # SEC code for the account
+  class AchSecCode3Enum
+    ACH_SEC_CODE3_ENUM = [
+      # TODO: Write general description for WEB
+      WEB = 'WEB'.freeze,
+
+      # TODO: Write general description for CCD
+      CCD = 'CCD'.freeze,
+
+      # TODO: Write general description for PPD
+      PPD = 'PPD'.freeze,
+
+      # TODO: Write general description for C21
+      C21 = 'C21'.freeze,
+
+      # TODO: Write general description for POP
+      POP = 'POP'.freeze,
+
+      # TODO: Write general description for TEL
+      TEL = 'TEL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACH_SEC_CODE3_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = WEB)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'web' then WEB
+      when 'ccd' then CCD
+      when 'ppd' then PPD
+      when 'c21' then C21
+      when 'pop' then POP
+      when 'tel' then TEL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/ach_sec_code_enum.rb

@@ -0,0 +1,44 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # SEC code for the transaction if it's an ACH transaction.
+  class AchSecCodeEnum
+    ACH_SEC_CODE_ENUM = [
+      # TODO: Write general description for WEB
+      WEB = 'WEB'.freeze,
+
+      # TODO: Write general description for CCD
+      CCD = 'CCD'.freeze,
+
+      # TODO: Write general description for PPD
+      PPD = 'PPD'.freeze,
+
+      # TODO: Write general description for TEL
+      TEL = 'TEL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACH_SEC_CODE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = WEB)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'web' then WEB
+      when 'ccd' then CCD
+      when 'ppd' then PPD
+      when 'tel' then TEL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/acs_challenge_mandated_enum.rb

@@ -0,0 +1,38 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Indication of whether a challenge is required for the transaction to be
+  # authorised due to local/regional mandates or other variable. >Y - Challenge
+  # is mandated > >N - Challenge is not mandated >
+  class AcsChallengeMandatedEnum
+    ACS_CHALLENGE_MANDATED_ENUM = [
+      # TODO: Write general description for Y
+      Y = 'Y'.freeze,
+
+      # TODO: Write general description for N
+      N = 'N'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACS_CHALLENGE_MANDATED_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
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/action_enum.rb

@@ -0,0 +1,49 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # The transaction action to be performed with the transaction intention.
+  # `sale`, `auth-only`, `avs-only`, `tokenization`.
+  class ActionEnum
+    ACTION_ENUM = [
+      # TODO: Write general description for SALE
+      SALE = 'sale'.freeze,
+
+      # TODO: Write general description for AUTHONLY
+      AUTHONLY = 'auth-only'.freeze,
+
+      # TODO: Write general description for AVSONLY
+      AVSONLY = 'avs-only'.freeze,
+
+      # TODO: Write general description for REFUND
+      REFUND = 'refund'.freeze,
+
+      # TODO: Write general description for TOKENIZATION
+      TOKENIZATION = 'tokenization'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACTION_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = SALE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sale' then SALE
+      when 'authonly' then AUTHONLY
+      when 'avsonly' then AVSONLY
+      when 'refund' then REFUND
+      when 'tokenization' then TOKENIZATION
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/active_notification_alert.rb

@@ -0,0 +1,239 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # ActiveNotificationAlert Model.
+  class ActiveNotificationAlert < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Location ID
+    # @return [String]
+    attr_accessor :location_id
+
+    # Location Api ID
+    # @return [String]
+    attr_accessor :location_api_id
+
+    # Date Start
+    # @return [String]
+    attr_accessor :date_start
+
+    # Date End
+    # @return [String]
+    attr_accessor :date_end
+
+    # User Location
+    # @return [TrueClass | FalseClass]
+    attr_accessor :user_location
+
+    # User Contact
+    # @return [TrueClass | FalseClass]
+    attr_accessor :user_contact
+
+    # Include Children
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_children
+
+    # Alert Type
+    # @return [AlertTypeEnum]
+    attr_accessor :alert_type
+
+    # Alert Type ID
+    # @return [AlertTypeIdEnum]
+    attr_accessor :alert_type_id
+
+    # Description
+    # @return [String]
+    attr_accessor :description
+
+    # Alert Message
+    # @return [String]
+    attr_accessor :alert_message
+
+    # Notification Alert ID
+    # @return [String]
+    attr_accessor :id
+
+    # Created Time Stamp
+    # @return [Integer]
+    attr_accessor :created_ts
+
+    # Modified Time Stamp
+    # @return [Integer]
+    attr_accessor :modified_ts
+
+    # User ID Created the register
+    # @return [String]
+    attr_accessor :created_user_id
+
+    # Last User ID that updated the register
+    # @return [String]
+    attr_accessor :modified_user_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['location_id'] = 'location_id'
+      @_hash['location_api_id'] = 'location_api_id'
+      @_hash['date_start'] = 'date_start'
+      @_hash['date_end'] = 'date_end'
+      @_hash['user_location'] = 'user_location'
+      @_hash['user_contact'] = 'user_contact'
+      @_hash['include_children'] = 'include_children'
+      @_hash['alert_type'] = 'alert_type'
+      @_hash['alert_type_id'] = 'alert_type_id'
+      @_hash['description'] = 'description'
+      @_hash['alert_message'] = 'alert_message'
+      @_hash['id'] = 'id'
+      @_hash['created_ts'] = 'created_ts'
+      @_hash['modified_ts'] = 'modified_ts'
+      @_hash['created_user_id'] = 'created_user_id'
+      @_hash['modified_user_id'] = 'modified_user_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        location_id
+        location_api_id
+        date_start
+        date_end
+        user_location
+        user_contact
+        include_children
+        alert_type
+        alert_type_id
+        description
+        alert_message
+        id
+        created_ts
+        modified_ts
+        created_user_id
+        modified_user_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        location_id
+        location_api_id
+        alert_type
+        alert_type_id
+        description
+        alert_message
+        created_user_id
+        modified_user_id
+      ]
+    end
+
+    def initialize(location_id = SKIP, location_api_id = SKIP,
+                   date_start = SKIP, date_end = SKIP, user_location = SKIP,
+                   user_contact = SKIP, include_children = SKIP,
+                   alert_type = SKIP, alert_type_id = SKIP, description = SKIP,
+                   alert_message = SKIP, id = SKIP, created_ts = SKIP,
+                   modified_ts = SKIP, created_user_id = SKIP,
+                   modified_user_id = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @location_id = location_id unless location_id == SKIP
+      @location_api_id = location_api_id unless location_api_id == SKIP
+      @date_start = date_start unless date_start == SKIP
+      @date_end = date_end unless date_end == SKIP
+      @user_location = user_location unless user_location == SKIP
+      @user_contact = user_contact unless user_contact == SKIP
+      @include_children = include_children unless include_children == SKIP
+      @alert_type = alert_type unless alert_type == SKIP
+      @alert_type_id = alert_type_id unless alert_type_id == SKIP
+      @description = description unless description == SKIP
+      @alert_message = alert_message unless alert_message == SKIP
+      @id = id unless id == SKIP
+      @created_ts = created_ts unless created_ts == SKIP
+      @modified_ts = modified_ts unless modified_ts == SKIP
+      @created_user_id = created_user_id unless created_user_id == SKIP
+      @modified_user_id = modified_user_id unless modified_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.
+      location_id = hash.key?('location_id') ? hash['location_id'] : SKIP
+      location_api_id =
+        hash.key?('location_api_id') ? hash['location_api_id'] : SKIP
+      date_start = hash.key?('date_start') ? hash['date_start'] : SKIP
+      date_end = hash.key?('date_end') ? hash['date_end'] : SKIP
+      user_location = hash.key?('user_location') ? hash['user_location'] : SKIP
+      user_contact = hash.key?('user_contact') ? hash['user_contact'] : SKIP
+      include_children =
+        hash.key?('include_children') ? hash['include_children'] : SKIP
+      alert_type = hash.key?('alert_type') ? hash['alert_type'] : SKIP
+      alert_type_id = hash.key?('alert_type_id') ? hash['alert_type_id'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      alert_message = hash.key?('alert_message') ? hash['alert_message'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      created_ts = hash.key?('created_ts') ? hash['created_ts'] : SKIP
+      modified_ts = hash.key?('modified_ts') ? hash['modified_ts'] : SKIP
+      created_user_id =
+        hash.key?('created_user_id') ? hash['created_user_id'] : SKIP
+      modified_user_id =
+        hash.key?('modified_user_id') ? hash['modified_user_id'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      ActiveNotificationAlert.new(location_id,
+                                  location_api_id,
+                                  date_start,
+                                  date_end,
+                                  user_location,
+                                  user_contact,
+                                  include_children,
+                                  alert_type,
+                                  alert_type_id,
+                                  description,
+                                  alert_message,
+                                  id,
+                                  created_ts,
+                                  modified_ts,
+                                  created_user_id,
+                                  modified_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} location_id: #{@location_id}, location_api_id: #{@location_api_id},"\
+      " date_start: #{@date_start}, date_end: #{@date_end}, user_location: #{@user_location},"\
+      " user_contact: #{@user_contact}, include_children: #{@include_children}, alert_type:"\
+      " #{@alert_type}, alert_type_id: #{@alert_type_id}, description: #{@description},"\
+      " alert_message: #{@alert_message}, id: #{@id}, created_ts: #{@created_ts}, modified_ts:"\
+      " #{@modified_ts}, created_user_id: #{@created_user_id}, modified_user_id:"\
+      " #{@modified_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} location_id: #{@location_id.inspect}, location_api_id:"\
+      " #{@location_api_id.inspect}, date_start: #{@date_start.inspect}, date_end:"\
+      " #{@date_end.inspect}, user_location: #{@user_location.inspect}, user_contact:"\
+      " #{@user_contact.inspect}, include_children: #{@include_children.inspect}, alert_type:"\
+      " #{@alert_type.inspect}, alert_type_id: #{@alert_type_id.inspect}, description:"\
+      " #{@description.inspect}, alert_message: #{@alert_message.inspect}, id: #{@id.inspect},"\
+      " created_ts: #{@created_ts.inspect}, modified_ts: #{@modified_ts.inspect}, created_user_id:"\
+      " #{@created_user_id.inspect}, modified_user_id: #{@modified_user_id.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end