fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/payment_recurring_notification.rb

@@ -0,0 +1,146 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Payment Recurring Notification Information on `expand`
+  class PaymentRecurringNotification < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID
+    # @return [String]
+    attr_accessor :id
+
+    # Declined Transaction ID
+    # @return [String]
+    attr_accessor :declined_transaction_id
+
+    # Payment Transaction ID
+    # @return [String]
+    attr_accessor :payment_transaction_id
+
+    # Created Time Stamp
+    # @return [Integer]
+    attr_accessor :created_ts
+
+    # User ID Created the register
+    # @return [String]
+    attr_accessor :created_user_id
+
+    # Modified Time Stamp
+    # @return [Integer]
+    attr_accessor :modified_ts
+
+    # 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['id'] = 'id'
+      @_hash['declined_transaction_id'] = 'declined_transaction_id'
+      @_hash['payment_transaction_id'] = 'payment_transaction_id'
+      @_hash['created_ts'] = 'created_ts'
+      @_hash['created_user_id'] = 'created_user_id'
+      @_hash['modified_ts'] = 'modified_ts'
+      @_hash['modified_user_id'] = 'modified_user_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        declined_transaction_id
+        payment_transaction_id
+        created_ts
+        created_user_id
+        modified_ts
+        modified_user_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        declined_transaction_id
+        payment_transaction_id
+        created_ts
+        created_user_id
+        modified_ts
+        modified_user_id
+      ]
+    end
+
+    def initialize(id = SKIP, declined_transaction_id = SKIP,
+                   payment_transaction_id = SKIP, created_ts = SKIP,
+                   created_user_id = SKIP, modified_ts = 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
+
+      @id = id unless id == SKIP
+      @declined_transaction_id = declined_transaction_id unless declined_transaction_id == SKIP
+      @payment_transaction_id = payment_transaction_id unless payment_transaction_id == SKIP
+      @created_ts = created_ts unless created_ts == SKIP
+      @created_user_id = created_user_id unless created_user_id == SKIP
+      @modified_ts = modified_ts unless modified_ts == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      declined_transaction_id =
+        hash.key?('declined_transaction_id') ? hash['declined_transaction_id'] : SKIP
+      payment_transaction_id =
+        hash.key?('payment_transaction_id') ? hash['payment_transaction_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
+      modified_ts = hash.key?('modified_ts') ? hash['modified_ts'] : 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.
+      PaymentRecurringNotification.new(id,
+                                       declined_transaction_id,
+                                       payment_transaction_id,
+                                       created_ts,
+                                       created_user_id,
+                                       modified_ts,
+                                       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} id: #{@id}, declined_transaction_id: #{@declined_transaction_id},"\
+      " payment_transaction_id: #{@payment_transaction_id}, created_ts: #{@created_ts},"\
+      " created_user_id: #{@created_user_id}, modified_ts: #{@modified_ts}, 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} id: #{@id.inspect}, declined_transaction_id:"\
+      " #{@declined_transaction_id.inspect}, payment_transaction_id:"\
+      " #{@payment_transaction_id.inspect}, created_ts: #{@created_ts.inspect}, created_user_id:"\
+      " #{@created_user_id.inspect}, modified_ts: #{@modified_ts.inspect}, modified_user_id:"\
+      " #{@modified_user_id.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/postback_log.rb

@@ -0,0 +1,162 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # PostbackLog Model.
+  class PostbackLog < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Postback Status Id
+    # @return [PostbackStatusIdEnum]
+    attr_accessor :postback_status_id
+
+    # Postback Log Id
+    # @return [String]
+    attr_accessor :id
+
+    # Postback Config Id
+    # @return [String]
+    attr_accessor :postback_config_id
+
+    # Changelog Id
+    # @return [String]
+    attr_accessor :changelog_id
+
+    # Http Verb
+    # @return [String]
+    attr_accessor :http_verb
+
+    # Next Run
+    # @return [Integer]
+    attr_accessor :next_run_ts
+
+    # Created Time Stamp
+    # @return [Integer]
+    attr_accessor :created_ts
+
+    # MOdel
+    # @return [String]
+    attr_accessor :model
+
+    # Model Id
+    # @return [String]
+    attr_accessor :model_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['postback_status_id'] = 'postback_status_id'
+      @_hash['id'] = 'id'
+      @_hash['postback_config_id'] = 'postback_config_id'
+      @_hash['changelog_id'] = 'changelog_id'
+      @_hash['http_verb'] = 'http_verb'
+      @_hash['next_run_ts'] = 'next_run_ts'
+      @_hash['created_ts'] = 'created_ts'
+      @_hash['model'] = 'model'
+      @_hash['model_id'] = 'model_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        postback_status_id
+        id
+        postback_config_id
+        changelog_id
+        http_verb
+        next_run_ts
+        created_ts
+        model
+        model_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        postback_status_id
+        http_verb
+        next_run_ts
+        created_ts
+        model
+        model_id
+      ]
+    end
+
+    def initialize(postback_status_id = SKIP, id = SKIP,
+                   postback_config_id = SKIP, changelog_id = SKIP,
+                   http_verb = SKIP, next_run_ts = SKIP, created_ts = SKIP,
+                   model = SKIP, model_id = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @postback_status_id = postback_status_id unless postback_status_id == SKIP
+      @id = id unless id == SKIP
+      @postback_config_id = postback_config_id unless postback_config_id == SKIP
+      @changelog_id = changelog_id unless changelog_id == SKIP
+      @http_verb = http_verb unless http_verb == SKIP
+      @next_run_ts = next_run_ts unless next_run_ts == SKIP
+      @created_ts = created_ts unless created_ts == SKIP
+      @model = model unless model == SKIP
+      @model_id = model_id unless model_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.
+      postback_status_id =
+        hash.key?('postback_status_id') ? hash['postback_status_id'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      postback_config_id =
+        hash.key?('postback_config_id') ? hash['postback_config_id'] : SKIP
+      changelog_id = hash.key?('changelog_id') ? hash['changelog_id'] : SKIP
+      http_verb = hash.key?('http_verb') ? hash['http_verb'] : SKIP
+      next_run_ts = hash.key?('next_run_ts') ? hash['next_run_ts'] : SKIP
+      created_ts = hash.key?('created_ts') ? hash['created_ts'] : SKIP
+      model = hash.key?('model') ? hash['model'] : SKIP
+      model_id = hash.key?('model_id') ? hash['model_id'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      PostbackLog.new(postback_status_id,
+                      id,
+                      postback_config_id,
+                      changelog_id,
+                      http_verb,
+                      next_run_ts,
+                      created_ts,
+                      model,
+                      model_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} postback_status_id: #{@postback_status_id}, id: #{@id}, postback_config_id:"\
+      " #{@postback_config_id}, changelog_id: #{@changelog_id}, http_verb: #{@http_verb},"\
+      " next_run_ts: #{@next_run_ts}, created_ts: #{@created_ts}, model: #{@model}, model_id:"\
+      " #{@model_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} postback_status_id: #{@postback_status_id.inspect}, id: #{@id.inspect},"\
+      " postback_config_id: #{@postback_config_id.inspect}, changelog_id:"\
+      " #{@changelog_id.inspect}, http_verb: #{@http_verb.inspect}, next_run_ts:"\
+      " #{@next_run_ts.inspect}, created_ts: #{@created_ts.inspect}, model: #{@model.inspect},"\
+      " model_id: #{@model_id.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/postback_status_id_enum.rb

@@ -0,0 +1,50 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Postback Status Id
+  class PostbackStatusIdEnum
+    POSTBACK_STATUS_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
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      POSTBACK_STATUS_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 POSTBACK_STATUS_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
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/pre_order_purchase_ind_enum.rb

@@ -0,0 +1,38 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Indicates whether Cardholder is placing an order for merchandise with a
+  # future availability or release date. >01 - Merchandise available > >02 -
+  # Future availability >
+  class PreOrderPurchaseIndEnum
+    PRE_ORDER_PURCHASE_IND_ENUM = [
+      # TODO: Write general description for ENUM_01
+      ENUM_01 = '01'.freeze,
+
+      # TODO: Write general description for ENUM_02
+      ENUM_02 = '02'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PRE_ORDER_PURCHASE_IND_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_02' then ENUM_02
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/preferred_language_enum.rb

@@ -0,0 +1,38 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Merchant preferred language. English(“en-US”) will be used if no value is
+  # supplied. >Merchant preferred language. English(“en-US”) will be used if no
+  # value is supplied. >
+  class PreferredLanguageEnum
+    PREFERRED_LANGUAGE_ENUM = [
+      # TODO: Write general description for ENUS
+      ENUS = 'en-US'.freeze,
+
+      # TODO: Write general description for FRCA
+      FRCA = 'fr-CA'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PREFERRED_LANGUAGE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enus' then ENUS
+      when 'frca' then FRCA
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/preferred_protocol_version_enum.rb

@@ -0,0 +1,51 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Specifies the preferred version of 3D Secure protocol to be utilized while
+  # executing 3D Secure authentication. 3DS Server initiates an authentication
+  # request with the preferred version and if this version is not supported by
+  # other 3D Secure components, it falls back to the next supported version(s)
+  # and continues authentication. If the preferred version is enforced by
+  # setting  #enforcePreferredProtocolVersion flag, but this version is not
+  # supported by one of the 3D Secure components, 3DS Server does not initiate
+  # an authentication and provides corresponding error message to the customer.
+  # If no value is provided, EMV 3DS 2.1.0 version will be used by default.
+  # >2.1.0 - prefer authentication with 2.1.0 version > >2.2.0 - prefer
+  # authentication with 2.2.0 version > >2.3.1 - prefer authentication with
+  # 2.3.1 version >
+  class PreferredProtocolVersionEnum
+    PREFERRED_PROTOCOL_VERSION_ENUM = [
+      # TODO: Write general description for ENUM_210
+      ENUM_210 = '2.1.0'.freeze,
+
+      # TODO: Write general description for ENUM_220
+      ENUM_220 = '2.2.0'.freeze,
+
+      # TODO: Write general description for ENUM_231
+      ENUM_231 = '2.3.1'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PREFERRED_PROTOCOL_VERSION_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_210)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_210' then ENUM_210
+      when 'enum_220' then ENUM_220
+      when 'enum_231' then ENUM_231
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/pricing_element.rb

@@ -0,0 +1,103 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Array of pricing items from template to be changed.
+  class PricingElement < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Item ID.
+    # @return [Integer]
+    attr_accessor :item_id
+
+    # Item value.
+    # @return [Float]
+    attr_accessor :item_value
+
+    # Item term.
+    # @return [Integer]
+    attr_accessor :item_term
+
+    # Item desciption.
+    # @return [String]
+    attr_accessor :item_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['item_id'] = 'item_id'
+      @_hash['item_value'] = 'item_value'
+      @_hash['item_term'] = 'item_term'
+      @_hash['item_description'] = 'item_description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        item_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        item_description
+      ]
+    end
+
+    def initialize(item_id = nil, item_value = nil, item_term = nil,
+                   item_description = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @item_id = item_id
+      @item_value = item_value
+      @item_term = item_term
+      @item_description = item_description unless item_description == 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.
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+      item_value = hash.key?('item_value') ? hash['item_value'] : nil
+      item_term = hash.key?('item_term') ? hash['item_term'] : nil
+      item_description =
+        hash.key?('item_description') ? hash['item_description'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      PricingElement.new(item_id,
+                         item_value,
+                         item_term,
+                         item_description,
+                         additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} item_id: #{@item_id}, item_value: #{@item_value}, item_term: #{@item_term},"\
+      " item_description: #{@item_description}, 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} item_id: #{@item_id.inspect}, item_value: #{@item_value.inspect},"\
+      " item_term: #{@item_term.inspect}, item_description: #{@item_description.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end