fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/scheme_id_enum.rb

@@ -0,0 +1,45 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # ID for the scheme to which the Cardholder's acctNumber belongs to. It will
+  # be used to identify the Scheme from the 3DS Server configuration.
+  class SchemeIdEnum
+    SCHEME_ID_ENUM = [
+      # TODO: Write general description for VISA
+      VISA = 'Visa'.freeze,
+
+      # TODO: Write general description for MASTERCARD
+      MASTERCARD = 'Mastercard'.freeze,
+
+      # TODO: Write general description for ENUM_AMERICAN_EXPRESS
+      ENUM_AMERICAN_EXPRESS = 'American Express'.freeze,
+
+      # TODO: Write general description for DINERS
+      DINERS = 'Diners'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SCHEME_ID_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = VISA)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'visa' then VISA
+      when 'mastercard' then MASTERCARD
+      when 'enum_american_express' then ENUM_AMERICAN_EXPRESS
+      when 'diners' then DINERS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/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
+  # SecCode.
+  class SecCodeEnum
+    SEC_CODE_ENUM = [
+      # TODO: Write general description for CCD
+      CCD = 'CCD'.freeze,
+
+      # TODO: Write general description for PPD
+      PPD = 'PPD'.freeze,
+
+      # TODO: Write general description for WEB
+      WEB = 'WEB'.freeze,
+
+      # TODO: Write general description for TEL
+      TEL = 'TEL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SEC_CODE_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 'web' then WEB
+      when 'tel' then TEL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/settings.rb

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

data/lib/fortis_api/models/severity_enum.rb

@@ -0,0 +1,48 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Indicates the importance/severity level of the broadcasted information. This
+  # field is required. >01 - Critical. Immediate action to be taken by recipient
+  # > >02 - Major. Major impact; Upcoming action to be taken by recipient > >03
+  # - Minor. Minor impact; Upcoming action to be taken by recipient > >04 -
+  # Informational. Informational only with no immediate action by recipient >
+  class SeverityEnum
+    SEVERITY_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_03
+      ENUM_03 = '03'.freeze,
+
+      # TODO: Write general description for ENUM_04
+      ENUM_04 = '04'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SEVERITY_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_03' then ENUM_03
+      when 'enum_04' then ENUM_04
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/ship_address_usage_ind_enum.rb

@@ -0,0 +1,46 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # 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 >
+  class ShipAddressUsageIndEnum
+    SHIP_ADDRESS_USAGE_IND_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_03
+      ENUM_03 = '03'.freeze,
+
+      # TODO: Write general description for ENUM_04
+      ENUM_04 = '04'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SHIP_ADDRESS_USAGE_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
+      when 'enum_03' then ENUM_03
+      when 'enum_04' then ENUM_04
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/ship_indicator_enum.rb

@@ -0,0 +1,83 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # 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) >
+  class ShipIndicatorEnum
+    SHIP_INDICATOR_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_03
+      ENUM_03 = '03'.freeze,
+
+      # TODO: Write general description for ENUM_04
+      ENUM_04 = '04'.freeze,
+
+      # TODO: Write general description for ENUM_05
+      ENUM_05 = '05'.freeze,
+
+      # TODO: Write general description for ENUM_07
+      ENUM_07 = '07'.freeze,
+
+      # TODO: Write general description for ENUM_08
+      ENUM_08 = '08'.freeze,
+
+      # TODO: Write general description for ENUM_09
+      ENUM_09 = '09'.freeze,
+
+      # TODO: Write general description for ENUM_80
+      ENUM_80 = '80'.freeze,
+
+      # TODO: Write general description for ENUM_81
+      ENUM_81 = '81'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SHIP_INDICATOR_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_03' then ENUM_03
+      when 'enum_04' then ENUM_04
+      when 'enum_05' then ENUM_05
+      when 'enum_07' then ENUM_07
+      when 'enum_08' then ENUM_08
+      when 'enum_09' then ENUM_09
+      when 'enum_80' then ENUM_80
+      when 'enum_81' then ENUM_81
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/ship_name_indicator_enum.rb

@@ -0,0 +1,38 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # 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 >
+  class ShipNameIndicatorEnum
+    SHIP_NAME_INDICATOR_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?
+
+      SHIP_NAME_INDICATOR_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/shipping_address.rb

@@ -0,0 +1,161 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Cardholder shipping address object
+  class ShippingAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The city of the Cardholder shipping address associated with the card used
+    # for this purchase.
+    # This field is required unless market or regional mandate restricts sending
+    # this information.
+    # @return [String]
+    attr_accessor :city
+
+    # The ISO 3166-1 alpha-3 or alpha-2 country of the Cardholder shipping
+    # address associated with the card used for this purchase.
+    # The field is required if Cardholder Shipping Address State is present and
+    # unless market or regional mandate restricts sending this information.
+    # @return [String]
+    attr_accessor :country_code
+
+    # First line of the street address or equivalent local portion of the
+    # Cardholder shipping address associated with the card use for this
+    # purchase.
+    # This field is required unless market or regional mandate restricts sending
+    # this information.
+    # @return [String]
+    attr_accessor :address_line_1
+
+    # Second line of the street address or equivalent local portion of the
+    # Cardholder shipping address associated with the card use for this
+    # purchase.
+    # This field is required unless market or regional mandate restricts sending
+    # this information.
+    # @return [String]
+    attr_accessor :address_line_2
+
+    # Third line of the street address or equivalent local portion of the
+    # Cardholder shipping address associated with the card use for this
+    # purchase.
+    # This field is required unless market or regional mandate restricts sending
+    # this information.
+    # @return [String]
+    attr_accessor :address_line_3
+
+    # ZIP or other postal code of the Cardholder shipping address associated
+    # with the card used for this purchase.
+    # This field is required unless market or regional mandate restricts sending
+    # this information.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The state or province of the Cardholder shipping address associated with
+    # the card used for this purchase. The value should be the country
+    # subdivision code defined in ISO 3166-2.
+    # This field is required unless State is not applicable for this country and
+    # unless market or regional mandate restricts sending this information.
+    # @return [String]
+    attr_accessor :state
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['city'] = 'city'
+      @_hash['country_code'] = 'country_code'
+      @_hash['address_line_1'] = 'address_line_1'
+      @_hash['address_line_2'] = 'address_line_2'
+      @_hash['address_line_3'] = 'address_line_3'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash['state'] = 'state'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        city
+        country_code
+        address_line_1
+        address_line_2
+        address_line_3
+        postal_code
+        state
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(city = SKIP, country_code = SKIP, address_line_1 = SKIP,
+                   address_line_2 = SKIP, address_line_3 = SKIP,
+                   postal_code = SKIP, state = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @city = city unless city == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @address_line_1 = address_line_1 unless address_line_1 == SKIP
+      @address_line_2 = address_line_2 unless address_line_2 == SKIP
+      @address_line_3 = address_line_3 unless address_line_3 == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @state = state unless state == 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.
+      city = hash.key?('city') ? hash['city'] : SKIP
+      country_code = hash.key?('country_code') ? hash['country_code'] : SKIP
+      address_line_1 =
+        hash.key?('address_line_1') ? hash['address_line_1'] : SKIP
+      address_line_2 =
+        hash.key?('address_line_2') ? hash['address_line_2'] : SKIP
+      address_line_3 =
+        hash.key?('address_line_3') ? hash['address_line_3'] : SKIP
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      ShippingAddress.new(city,
+                          country_code,
+                          address_line_1,
+                          address_line_2,
+                          address_line_3,
+                          postal_code,
+                          state,
+                          additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} city: #{@city}, country_code: #{@country_code}, address_line_1:"\
+      " #{@address_line_1}, address_line_2: #{@address_line_2}, address_line_3:"\
+      " #{@address_line_3}, postal_code: #{@postal_code}, state: #{@state}, 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} city: #{@city.inspect}, country_code: #{@country_code.inspect},"\
+      " address_line_1: #{@address_line_1.inspect}, address_line_2: #{@address_line_2.inspect},"\
+      " address_line_3: #{@address_line_3.inspect}, postal_code: #{@postal_code.inspect}, state:"\
+      " #{@state.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/signature.rb

@@ -0,0 +1,125 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Signature Information on `expand`
+  class Signature < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Signature
+    # @return [String]
+    attr_accessor :signature
+
+    # Resource
+    # >Recurring, Transaction, AccountVault, DeviceTerm
+    # >
+    # @return [ResourceEnum]
+    attr_accessor :resource
+
+    # Resource ID
+    # @return [String]
+    attr_accessor :resource_id
+
+    # Signature ID
+    # @return [String]
+    attr_accessor :id
+
+    # Created Time Stamp
+    # @return [Integer]
+    attr_accessor :created_ts
+
+    # Modified Time Stamp
+    # @return [Integer]
+    attr_accessor :modified_ts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['signature'] = 'signature'
+      @_hash['resource'] = 'resource'
+      @_hash['resource_id'] = 'resource_id'
+      @_hash['id'] = 'id'
+      @_hash['created_ts'] = 'created_ts'
+      @_hash['modified_ts'] = 'modified_ts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        signature
+        resource
+        resource_id
+        id
+        created_ts
+        modified_ts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(signature = SKIP, resource = SKIP, resource_id = SKIP,
+                   id = SKIP, created_ts = SKIP, modified_ts = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @signature = signature unless signature == SKIP
+      @resource = resource unless resource == SKIP
+      @resource_id = resource_id unless resource_id == SKIP
+      @id = id unless id == SKIP
+      @created_ts = created_ts unless created_ts == SKIP
+      @modified_ts = modified_ts unless modified_ts == 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.
+      signature = hash.key?('signature') ? hash['signature'] : SKIP
+      resource = hash.key?('resource') ? hash['resource'] : SKIP
+      resource_id = hash.key?('resource_id') ? hash['resource_id'] : 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
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Signature.new(signature,
+                    resource,
+                    resource_id,
+                    id,
+                    created_ts,
+                    modified_ts,
+                    additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} signature: #{@signature}, resource: #{@resource}, resource_id:"\
+      " #{@resource_id}, id: #{@id}, created_ts: #{@created_ts}, modified_ts: #{@modified_ts},"\
+      " 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} signature: #{@signature.inspect}, resource: #{@resource.inspect},"\
+      " resource_id: #{@resource_id.inspect}, id: #{@id.inspect}, created_ts:"\
+      " #{@created_ts.inspect}, modified_ts: #{@modified_ts.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end