fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/browser_information.rb

@@ -0,0 +1,288 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Contains browser information.  This field is required when device_channel=02
+  # (BRW).
+  class BrowserInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Exact content of the HTTP accept headers as sent to the 3DS Requestor from
+    # the Cardholder's browser. This field is limited to maximum 2048 characters
+    #  and if the total length exceeds the limit, the 3DS Server truncates the
+    # excess portion.
+    #  This field is required for requests where device_channel=02 (BRW).
+    # @return [String]
+    attr_accessor :browser_accept_header
+
+    # Boolean that represents the ability of the cardholder browser to execute
+    # Java. Value is returned from the navigator.javaEnabled property.
+    # Depending on the message version, the field is required for requests:
+    # - with message version = 2.1.0 and device_channel = 02 (BRW).
+    # - with message version = 2.2.0 and device_channel = 02 (BRW) and
+    # browser_javascript_enabled = true.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :browser_java_enabled
+
+    # Value representing the browser language as defined in IETF BCP47.
+    # Until EMV 3DS 2.2.0:
+    # The value is limited to 1-8 characters. If the value exceeds 8 characters,
+    # it will be truncated to a semantically valid value, if possible. The value
+    # is returned from navigator.language property.
+    # This field is required for requests where device_channel = 02 (BRW).
+    # In other cases this field is optional.
+    # Starting from EMV 3DS 2.3.1:
+    # The value is limited to 35 characters. If the value exceeds 35 characters,
+    # it will be truncated to a semantically valid value, if possible. The value
+    # is returned from navigator.language property.
+    # This field is required for requests where device_channel = 02 (BRW) and
+    # browser_javascript_enabled = true.
+    # In other cases this field is optional.
+    # @return [String]
+    attr_accessor :browser_language
+
+    # Value representing the bit depth of the color palette for displaying
+    # images, in bits per pixel. Obtained from Cardholder browser using the
+    # screen.colorDepth property. The field is limited to 1-2 characters.
+    # If the value is not in the accepted values, it will be resolved to the
+    # first accepted value lower from the one provided.
+    # Depending on the message version, the field is required for requests:
+    # - with message version = 2.1.0 and device_channel = 02 (BRW).
+    # - with message version = 2.2.0 and device_channel = 02 (BRW) and
+    # browser_javascript_enabled = true.
+    # >1 - 1 bit
+    # >
+    # >4 - 4 bits
+    # >
+    # >8 - 8 bits
+    # >
+    # >15 - 15 bits
+    # >
+    # >16 - 16 bits
+    # >
+    # >24 - 24 bits
+    # >
+    # >32 - 32 bits
+    # >
+    # >48 - 48 bits
+    # >
+    # @return [String]
+    attr_accessor :browser_color_depth
+
+    # Total height of the Cardholder's screen in pixels. Value is returned from
+    # the screen.height property. The value is limited to 1-6 characters.
+    # Depending on the message version, the field is required for requests:
+    # - with message version = 2.1.0 and device_channel = 02 (BRW).
+    # - with message version = 2.2.0 and device_channel = 02 (BRW) and
+    # browserJavascripbrowser_javascript_enabledtEnabled = true.
+    # @return [Integer]
+    attr_accessor :browser_screen_height
+
+    # Total width of the Cardholder's screen in pixels. Value is returned from
+    # the screen.width property. The value is limited to 1-6 characters.
+    # Depending on the message version, the field is required for requests:
+    # - with message version = 2.1.0 and device_channel = 02 (BRW).
+    # - with message version = 2.2.0 and device_channel = 02 (BRW) and
+    # browser_javascript_enabled = true.
+    # @return [Integer]
+    attr_accessor :browser_screen_width
+
+    # Time difference between UTC time and the Cardholder browser local time, in
+    # minutes. The field is limited to 1-5 characters where the values is
+    # returned from the getTimezoneOffset() method.
+    # Depending on the message version, the field is required for requests:
+    # - with message version = 2.1.0 and device_channel = 02 (BRW).
+    # - with message version = 2.2.0 and device_channel = 02 (BRW) and
+    # browser_javascript_enabled = true.
+    # @return [Integer]
+    attr_accessor :browser_tz
+
+    # Exact content of the HTTP user-agent header. The field is limited to
+    # maximum 2048 caracters. If the total length of the User-Agent sent by the
+    # browser exceeds 2048 characters, the 3DS Server truncates the excess
+    # portion.
+    # This field is required for requests where device_channel = 02 (BRW).
+    # @return [String]
+    attr_accessor :browser_user_agent
+
+    # Dimensions of the challenge window that has been displayed to the
+    # Cardholder. The ACS shall reply with content that is formatted to
+    # appropriately render in this window to provide the best possible user
+    # experience.
+    # Preconfigured sizes are width X height in pixels of the window displayed
+    # in the Cardholder browser window. This is used only to prepare the CReq
+    # request and it is not part of the AReq flow. If not present it will be
+    # omitted.
+    # However, when sending the Challenge Request, this field is required when
+    # device_channel = 02 (BRW).
+    # >01 - 250 x 400
+    # >
+    # >02 - 390 x 400
+    # >
+    # >03 - 500 x 600
+    # >
+    # >04 - 600 x 400
+    # >
+    # >05 - Full screen
+    # >
+    # @return [ChallengeWindowSizeEnum]
+    attr_accessor :challenge_window_size
+
+    # Boolean that represents the ability of the cardholder browser to execute
+    # JavaScript.
+    # This field is required for requests where device_channel = 02 (BRW).
+    # Available for supporting EMV 3DS 2.2.0 and later versions.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :browser_javascript_enabled
+
+    # Value representing the browser language preference present in the http
+    # header, as defined in IETF BCP 47.
+    # The value is limited to 1-99 elements. Each element should contain a
+    # maximum of 100 characters.
+    # This field is required for requests where device_channel = 02 (BRW).
+    # Available for supporting EMV 3DS 2.3.1 and later versions.
+    # @return [Array[String]]
+    attr_accessor :accept_language
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['browser_accept_header'] = 'browser_accept_header'
+      @_hash['browser_java_enabled'] = 'browser_java_enabled'
+      @_hash['browser_language'] = 'browser_language'
+      @_hash['browser_color_depth'] = 'browser_color_depth'
+      @_hash['browser_screen_height'] = 'browser_screen_height'
+      @_hash['browser_screen_width'] = 'browser_screen_width'
+      @_hash['browser_tz'] = 'browser_tz'
+      @_hash['browser_user_agent'] = 'browser_user_agent'
+      @_hash['challenge_window_size'] = 'challenge_window_size'
+      @_hash['browser_javascript_enabled'] = 'browser_javascript_enabled'
+      @_hash['accept_language'] = 'accept_language'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        browser_accept_header
+        browser_java_enabled
+        browser_language
+        browser_color_depth
+        browser_screen_height
+        browser_screen_width
+        browser_tz
+        browser_user_agent
+        challenge_window_size
+        browser_javascript_enabled
+        accept_language
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(browser_accept_header = SKIP, browser_java_enabled = SKIP,
+                   browser_language = SKIP, browser_color_depth = SKIP,
+                   browser_screen_height = SKIP, browser_screen_width = SKIP,
+                   browser_tz = SKIP, browser_user_agent = SKIP,
+                   challenge_window_size = SKIP,
+                   browser_javascript_enabled = SKIP, accept_language = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @browser_accept_header = browser_accept_header unless browser_accept_header == SKIP
+      @browser_java_enabled = browser_java_enabled unless browser_java_enabled == SKIP
+      @browser_language = browser_language unless browser_language == SKIP
+      @browser_color_depth = browser_color_depth unless browser_color_depth == SKIP
+      @browser_screen_height = browser_screen_height unless browser_screen_height == SKIP
+      @browser_screen_width = browser_screen_width unless browser_screen_width == SKIP
+      @browser_tz = browser_tz unless browser_tz == SKIP
+      @browser_user_agent = browser_user_agent unless browser_user_agent == SKIP
+      @challenge_window_size = challenge_window_size unless challenge_window_size == SKIP
+      unless browser_javascript_enabled == SKIP
+        @browser_javascript_enabled =
+          browser_javascript_enabled
+      end
+      @accept_language = accept_language unless accept_language == 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.
+      browser_accept_header =
+        hash.key?('browser_accept_header') ? hash['browser_accept_header'] : SKIP
+      browser_java_enabled =
+        hash.key?('browser_java_enabled') ? hash['browser_java_enabled'] : SKIP
+      browser_language =
+        hash.key?('browser_language') ? hash['browser_language'] : SKIP
+      browser_color_depth =
+        hash.key?('browser_color_depth') ? hash['browser_color_depth'] : SKIP
+      browser_screen_height =
+        hash.key?('browser_screen_height') ? hash['browser_screen_height'] : SKIP
+      browser_screen_width =
+        hash.key?('browser_screen_width') ? hash['browser_screen_width'] : SKIP
+      browser_tz = hash.key?('browser_tz') ? hash['browser_tz'] : SKIP
+      browser_user_agent =
+        hash.key?('browser_user_agent') ? hash['browser_user_agent'] : SKIP
+      challenge_window_size =
+        hash.key?('challenge_window_size') ? hash['challenge_window_size'] : SKIP
+      browser_javascript_enabled =
+        hash.key?('browser_javascript_enabled') ? hash['browser_javascript_enabled'] : SKIP
+      accept_language =
+        hash.key?('accept_language') ? hash['accept_language'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      BrowserInformation.new(browser_accept_header,
+                             browser_java_enabled,
+                             browser_language,
+                             browser_color_depth,
+                             browser_screen_height,
+                             browser_screen_width,
+                             browser_tz,
+                             browser_user_agent,
+                             challenge_window_size,
+                             browser_javascript_enabled,
+                             accept_language,
+                             additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} browser_accept_header: #{@browser_accept_header}, browser_java_enabled:"\
+      " #{@browser_java_enabled}, browser_language: #{@browser_language}, browser_color_depth:"\
+      " #{@browser_color_depth}, browser_screen_height: #{@browser_screen_height},"\
+      " browser_screen_width: #{@browser_screen_width}, browser_tz: #{@browser_tz},"\
+      " browser_user_agent: #{@browser_user_agent}, challenge_window_size:"\
+      " #{@challenge_window_size}, browser_javascript_enabled: #{@browser_javascript_enabled},"\
+      " accept_language: #{@accept_language}, 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} browser_accept_header: #{@browser_accept_header.inspect},"\
+      " browser_java_enabled: #{@browser_java_enabled.inspect}, browser_language:"\
+      " #{@browser_language.inspect}, browser_color_depth: #{@browser_color_depth.inspect},"\
+      " browser_screen_height: #{@browser_screen_height.inspect}, browser_screen_width:"\
+      " #{@browser_screen_width.inspect}, browser_tz: #{@browser_tz.inspect}, browser_user_agent:"\
+      " #{@browser_user_agent.inspect}, challenge_window_size: #{@challenge_window_size.inspect},"\
+      " browser_javascript_enabled: #{@browser_javascript_enabled.inspect}, accept_language:"\
+      " #{@accept_language.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/business_category_enum.rb

@@ -0,0 +1,74 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # The Category of the merchant's business >(Required if "business_type" is
+  # provided). Note: "business_type" must belong to the appropriate
+  # "business_category" >
+  class BusinessCategoryEnum
+    BUSINESS_CATEGORY_ENUM = [
+      # TODO: Write general description for BEAUTY_AND_PERSONAL_CARE
+      BEAUTY_AND_PERSONAL_CARE = 'beauty_and_personal_care'.freeze,
+
+      # TODO: Write general description for CASUAL_USE
+      CASUAL_USE = 'casual_use'.freeze,
+
+      # TODO: Write general description for EDUCATION
+      EDUCATION = 'education'.freeze,
+
+      # TODO: Write general description for FOOD_AND_DRINK
+      FOOD_AND_DRINK = 'food_and_drink'.freeze,
+
+      # TODO: Write general description for HEALTH_CARE_AND_FITNESS
+      HEALTH_CARE_AND_FITNESS = 'health_care_and_fitness'.freeze,
+
+      # TODO: Write general description for HOME_AND_REPAIR
+      HOME_AND_REPAIR = 'home_and_repair'.freeze,
+
+      # TODO: Write general description for LEISURE_AND_ENTERTAINMENT
+      LEISURE_AND_ENTERTAINMENT = 'leisure_and_entertainment'.freeze,
+
+      # TODO: Write general description for NON_PROFIT
+      NON_PROFIT = 'non_profit'.freeze,
+
+      # TODO: Write general description for PROFESSIONAL_SERVICES
+      PROFESSIONAL_SERVICES = 'professional_services'.freeze,
+
+      # TODO: Write general description for RETAIL
+      RETAIL = 'retail'.freeze,
+
+      # TODO: Write general description for TRANSPORTATION
+      TRANSPORTATION = 'transportation'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BUSINESS_CATEGORY_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = BEAUTY_AND_PERSONAL_CARE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'beauty_and_personal_care' then BEAUTY_AND_PERSONAL_CARE
+      when 'casual_use' then CASUAL_USE
+      when 'education' then EDUCATION
+      when 'food_and_drink' then FOOD_AND_DRINK
+      when 'health_care_and_fitness' then HEALTH_CARE_AND_FITNESS
+      when 'home_and_repair' then HOME_AND_REPAIR
+      when 'leisure_and_entertainment' then LEISURE_AND_ENTERTAINMENT
+      when 'non_profit' then NON_PROFIT
+      when 'professional_services' then PROFESSIONAL_SERVICES
+      when 'retail' then RETAIL
+      when 'transportation' then TRANSPORTATION
+      else
+        default_value
+      end
+    end
+  end
+end