fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/merchant_risk_indicator.rb

@@ -0,0 +1,237 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Contains purchase information
+  class MerchantRiskIndicator < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates shipping method chosen for the transaction. Merchants must
+    # choose the Shipping Indicator code that most accurately describes the
+    # cardholder's specific transaction. If one or more items are included in
+    # the sale, use the Shipping Indicator code for the physical goods, or if
+    # all digital goods, use the code that describes the most expensive item.
+    # >01 - Ship to cardholder's billing address
+    # >
+    # >02 - Ship to another verified address on file with merchant
+    # >
+    # >03 - Ship to address that is different than the cardholder's billing
+    # address
+    # >
+    # >04 - "Ship to Store" / Pick-up at local store (Store address shall be
+    # populated in shipping address fields)
+    # >
+    # >05 - Digital goods (includes online services, electronic gift cards and
+    # redemption codes)
+    # >
+    # >06 - Travel and Event tickets, not shipped
+    # >
+    # >07 - Other (for example, Gaming, digital services not shipped, e-media
+    # subscriptions, etc.)
+    # >
+    # >08 - Pick-up and go delivery. Availble in EMV 3DS 2.3.1 and later
+    # >
+    # >09 - Locker delivery (or other automated pick-up). Availble in EMV 3DS
+    # 2.3.1 and later
+    # >
+    # >80 - PS-specific value (dependent on the payment scheme type)
+    # >
+    # >81 - PS-specific value (dependent on the payment scheme type)
+    # >
+    # @return [ShipIndicatorEnum]
+    attr_accessor :ship_indicator
+
+    # Indicates the merchandise delivery timeframe.
+    # >01 - Electronic Delivery
+    # >
+    # >02 - Same day shipping
+    # >
+    # >03 - Overnight shipping
+    # >
+    # >04 - Two-day or more shipping
+    # >
+    # @return [DeliveryTimeframeEnum]
+    attr_accessor :delivery_timeframe
+
+    # For electronic delivery, the email address to which the merchandise was
+    # delivered.
+    # @return [String]
+    attr_accessor :delivery_email_address
+
+    # Indicates whether the cardholder is reordering previously purchased
+    # merchandise.
+    # >01 - First time ordered
+    # >
+    # >02 - Reordered
+    # >
+    # @return [ReorderItemsIndEnum]
+    attr_accessor :reorder_items_ind
+
+    # Indicates whether Cardholder is placing an order for merchandise with a
+    # future availability or release date.
+    # >01 - Merchandise available
+    # >
+    # >02 - Future availability
+    # >
+    # @return [PreOrderPurchaseIndEnum]
+    attr_accessor :pre_order_purchase_ind
+
+    # For a pre-ordered purchase, the expected date that the merchandise will be
+    # available. Date format must be YYYYMMDD.
+    # @return [String]
+    attr_accessor :pre_order_date
+
+    # For prepaid or gift card purchase, the purchase amount total of prepaid or
+    # gift card(s) in major units (for example, USD 123.45 is 123).
+    # @return [Integer]
+    attr_accessor :gift_card_amount
+
+    # For prepaid or gift card purchase, the currency code of the card as
+    # defined in ISO 4217 except 955 - 964 and 999.
+    # @return [String]
+    attr_accessor :gift_card_curr
+
+    # For prepaid or gift card purchase, total count of individual prepaid or
+    # gift cards/codes purchased.
+    # @return [Integer]
+    attr_accessor :gift_card_count
+
+    # Available starting in EMV 3DS 2.3.1.1.  Indicates to the ACS specific
+    # transactions identified by the Merchant.
+    # >01 - Cryptocurrency transaction
+    # >
+    # >02 - NFT transaction
+    # >
+    # @return [Array[TransCharEnum]]
+    attr_accessor :trans_char
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ship_indicator'] = 'ship_indicator'
+      @_hash['delivery_timeframe'] = 'delivery_timeframe'
+      @_hash['delivery_email_address'] = 'delivery_email_address'
+      @_hash['reorder_items_ind'] = 'reorder_items_ind'
+      @_hash['pre_order_purchase_ind'] = 'pre_order_purchase_ind'
+      @_hash['pre_order_date'] = 'pre_order_date'
+      @_hash['gift_card_amount'] = 'gift_card_amount'
+      @_hash['gift_card_curr'] = 'gift_card_curr'
+      @_hash['gift_card_count'] = 'gift_card_count'
+      @_hash['trans_char'] = 'trans_char'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ship_indicator
+        delivery_timeframe
+        delivery_email_address
+        reorder_items_ind
+        pre_order_purchase_ind
+        pre_order_date
+        gift_card_amount
+        gift_card_curr
+        gift_card_count
+        trans_char
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ship_indicator = SKIP, delivery_timeframe = SKIP,
+                   delivery_email_address = SKIP, reorder_items_ind = SKIP,
+                   pre_order_purchase_ind = SKIP, pre_order_date = SKIP,
+                   gift_card_amount = SKIP, gift_card_curr = SKIP,
+                   gift_card_count = SKIP, trans_char = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @ship_indicator = ship_indicator unless ship_indicator == SKIP
+      @delivery_timeframe = delivery_timeframe unless delivery_timeframe == SKIP
+      @delivery_email_address = delivery_email_address unless delivery_email_address == SKIP
+      @reorder_items_ind = reorder_items_ind unless reorder_items_ind == SKIP
+      @pre_order_purchase_ind = pre_order_purchase_ind unless pre_order_purchase_ind == SKIP
+      @pre_order_date = pre_order_date unless pre_order_date == SKIP
+      @gift_card_amount = gift_card_amount unless gift_card_amount == SKIP
+      @gift_card_curr = gift_card_curr unless gift_card_curr == SKIP
+      @gift_card_count = gift_card_count unless gift_card_count == SKIP
+      @trans_char = trans_char unless trans_char == 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.
+      ship_indicator =
+        hash.key?('ship_indicator') ? hash['ship_indicator'] : SKIP
+      delivery_timeframe =
+        hash.key?('delivery_timeframe') ? hash['delivery_timeframe'] : SKIP
+      delivery_email_address =
+        hash.key?('delivery_email_address') ? hash['delivery_email_address'] : SKIP
+      reorder_items_ind =
+        hash.key?('reorder_items_ind') ? hash['reorder_items_ind'] : SKIP
+      pre_order_purchase_ind =
+        hash.key?('pre_order_purchase_ind') ? hash['pre_order_purchase_ind'] : SKIP
+      pre_order_date =
+        hash.key?('pre_order_date') ? hash['pre_order_date'] : SKIP
+      gift_card_amount =
+        hash.key?('gift_card_amount') ? hash['gift_card_amount'] : SKIP
+      gift_card_curr =
+        hash.key?('gift_card_curr') ? hash['gift_card_curr'] : SKIP
+      gift_card_count =
+        hash.key?('gift_card_count') ? hash['gift_card_count'] : SKIP
+      trans_char = hash.key?('trans_char') ? hash['trans_char'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      MerchantRiskIndicator.new(ship_indicator,
+                                delivery_timeframe,
+                                delivery_email_address,
+                                reorder_items_ind,
+                                pre_order_purchase_ind,
+                                pre_order_date,
+                                gift_card_amount,
+                                gift_card_curr,
+                                gift_card_count,
+                                trans_char,
+                                additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ship_indicator: #{@ship_indicator}, delivery_timeframe:"\
+      " #{@delivery_timeframe}, delivery_email_address: #{@delivery_email_address},"\
+      " reorder_items_ind: #{@reorder_items_ind}, pre_order_purchase_ind:"\
+      " #{@pre_order_purchase_ind}, pre_order_date: #{@pre_order_date}, gift_card_amount:"\
+      " #{@gift_card_amount}, gift_card_curr: #{@gift_card_curr}, gift_card_count:"\
+      " #{@gift_card_count}, trans_char: #{@trans_char}, 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} ship_indicator: #{@ship_indicator.inspect}, delivery_timeframe:"\
+      " #{@delivery_timeframe.inspect}, delivery_email_address:"\
+      " #{@delivery_email_address.inspect}, reorder_items_ind: #{@reorder_items_ind.inspect},"\
+      " pre_order_purchase_ind: #{@pre_order_purchase_ind.inspect}, pre_order_date:"\
+      " #{@pre_order_date.inspect}, gift_card_amount: #{@gift_card_amount.inspect},"\
+      " gift_card_curr: #{@gift_card_curr.inspect}, gift_card_count: #{@gift_card_count.inspect},"\
+      " trans_char: #{@trans_char.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/message_category_enum.rb

@@ -0,0 +1,120 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Identifies the category of the message for a specific use case. >01 -
+  # Payment Authentication (PA) > >02 - Non-Payment Authentication (NPA) > >80
+  # through 99 - PS Specific Values > >80 - MasterCard Identity Check Insights >
+  # >85 - MasterCard Identity Check, Production Validation PA > >86 - MasterCard
+  # Identity Check, Production Validation NPA >
+  class MessageCategoryEnum
+    MESSAGE_CATEGORY_ENUM = [
+      # TODO: Write general description for ENUM_01
+      ENUM_01 = '01'.freeze,
+
+      # TODO: Write general description for ENUM_02
+      ENUM_02 = '02'.freeze,
+
+      # TODO: Write general description for ENUM_80
+      ENUM_80 = '80'.freeze,
+
+      # TODO: Write general description for ENUM_81
+      ENUM_81 = '81'.freeze,
+
+      # TODO: Write general description for ENUM_82
+      ENUM_82 = '82'.freeze,
+
+      # TODO: Write general description for ENUM_83
+      ENUM_83 = '83'.freeze,
+
+      # TODO: Write general description for ENUM_84
+      ENUM_84 = '84'.freeze,
+
+      # TODO: Write general description for ENUM_85
+      ENUM_85 = '85'.freeze,
+
+      # TODO: Write general description for ENUM_86
+      ENUM_86 = '86'.freeze,
+
+      # TODO: Write general description for ENUM_87
+      ENUM_87 = '87'.freeze,
+
+      # TODO: Write general description for ENUM_88
+      ENUM_88 = '88'.freeze,
+
+      # TODO: Write general description for ENUM_89
+      ENUM_89 = '89'.freeze,
+
+      # TODO: Write general description for ENUM_90
+      ENUM_90 = '90'.freeze,
+
+      # TODO: Write general description for ENUM_91
+      ENUM_91 = '91'.freeze,
+
+      # TODO: Write general description for ENUM_92
+      ENUM_92 = '92'.freeze,
+
+      # TODO: Write general description for ENUM_93
+      ENUM_93 = '93'.freeze,
+
+      # TODO: Write general description for ENUM_94
+      ENUM_94 = '94'.freeze,
+
+      # TODO: Write general description for ENUM_95
+      ENUM_95 = '95'.freeze,
+
+      # TODO: Write general description for ENUM_96
+      ENUM_96 = '96'.freeze,
+
+      # TODO: Write general description for ENUM_97
+      ENUM_97 = '97'.freeze,
+
+      # TODO: Write general description for ENUM_98
+      ENUM_98 = '98'.freeze,
+
+      # TODO: Write general description for ENUM_99
+      ENUM_99 = '99'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MESSAGE_CATEGORY_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
+      when 'enum_80' then ENUM_80
+      when 'enum_81' then ENUM_81
+      when 'enum_82' then ENUM_82
+      when 'enum_83' then ENUM_83
+      when 'enum_84' then ENUM_84
+      when 'enum_85' then ENUM_85
+      when 'enum_86' then ENUM_86
+      when 'enum_87' then ENUM_87
+      when 'enum_88' then ENUM_88
+      when 'enum_89' then ENUM_89
+      when 'enum_90' then ENUM_90
+      when 'enum_91' then ENUM_91
+      when 'enum_92' then ENUM_92
+      when 'enum_93' then ENUM_93
+      when 'enum_94' then ENUM_94
+      when 'enum_95' then ENUM_95
+      when 'enum_96' then ENUM_96
+      when 'enum_97' then ENUM_97
+      when 'enum_98' then ENUM_98
+      when 'enum_99' then ENUM_99
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/message_extension.rb

@@ -0,0 +1,109 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # MessageExtension Model.
+  class MessageExtension < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique identifier for the extension. Payment System Registered
+    # Application Provider Identifier (RID) is required as prefix of the ID. The
+    # maximum length is 64 characters.
+    # @return [String]
+    attr_accessor :id
+
+    # The name of the extension data set as defined by the extension owner.
+    # Maximum length is 64 characters.
+    # @return [String]
+    attr_accessor :name
+
+    # A boolean value indicating whether the recipient must understand the
+    # contents of the extension to interpret the entire message.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :criticality_indicator
+
+    # The data carried in the extension as. The maximum length is 8059
+    # characters.
+    # @return [Object]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['criticality_indicator'] = 'criticality_indicator'
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+        criticality_indicator
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, name = SKIP, criticality_indicator = SKIP,
+                   data = 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
+      @name = name unless name == SKIP
+      @criticality_indicator = criticality_indicator unless criticality_indicator == SKIP
+      @data = data unless data == 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
+      name = hash.key?('name') ? hash['name'] : SKIP
+      criticality_indicator =
+        hash.key?('criticality_indicator') ? hash['criticality_indicator'] : SKIP
+      data = hash.key?('data') ? hash['data'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      MessageExtension.new(id,
+                           name,
+                           criticality_indicator,
+                           data,
+                           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}, name: #{@name}, criticality_indicator:"\
+      " #{@criticality_indicator}, data: #{@data}, 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}, name: #{@name.inspect}, criticality_indicator:"\
+      " #{@criticality_indicator.inspect}, data: #{@data.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/meta.rb

@@ -0,0 +1,81 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Meta Model.
+  class Meta < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error detail
+    # @return [Array[Detail]]
+    attr_accessor :details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['details'] = 'details'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(details = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @details = details unless details == 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.
+      # Parameter is an array, so we need to iterate through it
+      details = nil
+      unless hash['details'].nil?
+        details = []
+        hash['details'].each do |structure|
+          details << (Detail.from_hash(structure) if structure)
+        end
+      end
+
+      details = SKIP unless hash.key?('details')
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Meta.new(details,
+               additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} details: #{@details}, 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} details: #{@details.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/method3.rb

@@ -0,0 +1,97 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Method3 Model.
+  class Method3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Payment type. Must be unique.
+    # @return [Type29Enum]
+    attr_accessor :type
+
+    # The product_transaction_id of the cc or ach deposit account that the
+    # transaction is inteded for. Use only the cc or ach id to display their
+    # respective elements form only. The Product's method (cc/ach) has to match
+    # the type.
+    # @return [String]
+    attr_accessor :product_transaction_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['product_transaction_id'] = 'product_transaction_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        product_transaction_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = SKIP, product_transaction_id = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @type = type unless type == SKIP
+      @product_transaction_id = product_transaction_id unless product_transaction_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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      product_transaction_id =
+        hash.key?('product_transaction_id') ? hash['product_transaction_id'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Method3.new(type,
+                  product_transaction_id,
+                  additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Method3 | 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} type: #{@type}, product_transaction_id: #{@product_transaction_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} type: #{@type.inspect}, product_transaction_id:"\
+      " #{@product_transaction_id.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end