sc-apimatic-sdk 0.0.1

data/lib/socure_risk_os_api/models/device.rb

@@ -0,0 +1,339 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module SocureRiskOsApi
+  # Use this field to provide external device data, e.g. originating from a
+  # third party data intelligence provider.
+  class Device < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique customer side identifier for device.
+    # @return [String]
+    attr_accessor :id
+
+    # Unique customer side identifier for device session.
+    # @return [String]
+    attr_accessor :session
+
+    # Unique customer side identifier for device fingerprint. This could be same
+    # as the `id`.
+    # @return [String]
+    attr_accessor :fingerprint
+
+    # Name of the fingerprint provider used to generate the fingerprint and/or
+    # id.
+    # @return [String]
+    attr_accessor :fingerprint_provider
+
+    # Name of the fingerprint provider used to generate the fingerprint and/or
+    # id.
+    # @return [String]
+    attr_accessor :user_agent
+
+    # Name of the fingerprint provider used to generate the fingerprint and/or
+    # id.
+    # @return [String]
+    attr_accessor :device_type
+
+    # Name of the fingerprint provider used to generate the fingerprint and/or
+    # id.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_known
+
+    # RFC 3339 date-time string
+    # @return [DateTime]
+    attr_accessor :first_seen_time
+
+    # RFC 3339 date-time string
+    # @return [DateTime]
+    attr_accessor :last_seen_time
+
+    # RFC 3339 date-time string
+    # @return [TrueClass | FalseClass]
+    attr_accessor :timezone_mismatch
+
+    # RFC 3339 date-time string
+    # @return [String]
+    attr_accessor :ip_address
+
+    # RFC 3339 date-time string
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_ip_bad_proxy
+
+    # RFC 3339 date-time string
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_ip_proxy
+
+    # A numeric score indicating the risk level associated with the IP address.
+    # Higher values indicate greater risk. This score is derived from the IP
+    # enrichment provider. Use alongside `is_ip_proxy` and `is_ip_bad_proxy` for
+    # a comprehensive IP risk assessment.
+    # @return [Float]
+    attr_accessor :ip_risk_score
+
+    # A numeric score indicating the risk level associated with the IP address.
+    # Higher values indicate greater risk. This score is derived from the IP
+    # enrichment provider. Use alongside `is_ip_proxy` and `is_ip_bad_proxy` for
+    # a comprehensive IP risk assessment.
+    # @return [String]
+    attr_accessor :ip_isp
+
+    # A numeric score indicating the risk level associated with the IP address.
+    # Higher values indicate greater risk. This score is derived from the IP
+    # enrichment provider. Use alongside `is_ip_proxy` and `is_ip_bad_proxy` for
+    # a comprehensive IP risk assessment.
+    # @return [String]
+    attr_accessor :ip_country_code
+
+    # A numeric score indicating the risk level associated with the IP address.
+    # Higher values indicate greater risk. This score is derived from the IP
+    # enrichment provider. Use alongside `is_ip_proxy` and `is_ip_bad_proxy` for
+    # a comprehensive IP risk assessment.
+    # @return [String]
+    attr_accessor :ip_city
+
+    # A numeric score indicating the risk level associated with the IP address.
+    # Higher values indicate greater risk. This score is derived from the IP
+    # enrichment provider. Use alongside `is_ip_proxy` and `is_ip_bad_proxy` for
+    # a comprehensive IP risk assessment.
+    # @return [String]
+    attr_accessor :ip_region
+
+    # A numeric score indicating the risk level associated with the IP address.
+    # Higher values indicate greater risk. This score is derived from the IP
+    # enrichment provider. Use alongside `is_ip_proxy` and `is_ip_bad_proxy` for
+    # a comprehensive IP risk assessment.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_ip_tor
+
+    # A numeric score indicating the risk level associated with the IP address.
+    # Higher values indicate greater risk. This score is derived from the IP
+    # enrichment provider. Use alongside `is_ip_proxy` and `is_ip_bad_proxy` for
+    # a comprehensive IP risk assessment.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_emulator
+
+    # Send any additional, customer-specific data in this field. See [Custom
+    # Fields](https://help.socure.com/riskos/docs/custom-fields) for more
+    # information.
+    # @return [Hash[String, Object]]
+    attr_accessor :custom
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['session'] = 'session'
+      @_hash['fingerprint'] = 'fingerprint'
+      @_hash['fingerprint_provider'] = 'fingerprint_provider'
+      @_hash['user_agent'] = 'user_agent'
+      @_hash['device_type'] = 'device_type'
+      @_hash['is_known'] = 'is_known'
+      @_hash['first_seen_time'] = 'first_seen_time'
+      @_hash['last_seen_time'] = 'last_seen_time'
+      @_hash['timezone_mismatch'] = 'timezone_mismatch'
+      @_hash['ip_address'] = 'ip_address'
+      @_hash['is_ip_bad_proxy'] = 'is_ip_bad_proxy'
+      @_hash['is_ip_proxy'] = 'is_ip_proxy'
+      @_hash['ip_risk_score'] = 'ip_risk_score'
+      @_hash['ip_isp'] = 'ip_isp'
+      @_hash['ip_country_code'] = 'ip_country_code'
+      @_hash['ip_city'] = 'ip_city'
+      @_hash['ip_region'] = 'ip_region'
+      @_hash['is_ip_tor'] = 'is_ip_tor'
+      @_hash['is_emulator'] = 'is_emulator'
+      @_hash['custom'] = 'custom'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        session
+        fingerprint
+        fingerprint_provider
+        user_agent
+        device_type
+        is_known
+        first_seen_time
+        last_seen_time
+        timezone_mismatch
+        ip_address
+        is_ip_bad_proxy
+        is_ip_proxy
+        ip_risk_score
+        ip_isp
+        ip_country_code
+        ip_city
+        ip_region
+        is_ip_tor
+        is_emulator
+        custom
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, session: SKIP, fingerprint: SKIP,
+                   fingerprint_provider: SKIP, user_agent: SKIP,
+                   device_type: SKIP, is_known: SKIP, first_seen_time: SKIP,
+                   last_seen_time: SKIP, timezone_mismatch: SKIP,
+                   ip_address: SKIP, is_ip_bad_proxy: SKIP, is_ip_proxy: SKIP,
+                   ip_risk_score: SKIP, ip_isp: SKIP, ip_country_code: SKIP,
+                   ip_city: SKIP, ip_region: SKIP, is_ip_tor: SKIP,
+                   is_emulator: SKIP, custom: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @session = session unless session == SKIP
+      @fingerprint = fingerprint unless fingerprint == SKIP
+      @fingerprint_provider = fingerprint_provider unless fingerprint_provider == SKIP
+      @user_agent = user_agent unless user_agent == SKIP
+      @device_type = device_type unless device_type == SKIP
+      @is_known = is_known unless is_known == SKIP
+      @first_seen_time = first_seen_time unless first_seen_time == SKIP
+      @last_seen_time = last_seen_time unless last_seen_time == SKIP
+      @timezone_mismatch = timezone_mismatch unless timezone_mismatch == SKIP
+      @ip_address = ip_address unless ip_address == SKIP
+      @is_ip_bad_proxy = is_ip_bad_proxy unless is_ip_bad_proxy == SKIP
+      @is_ip_proxy = is_ip_proxy unless is_ip_proxy == SKIP
+      @ip_risk_score = ip_risk_score unless ip_risk_score == SKIP
+      @ip_isp = ip_isp unless ip_isp == SKIP
+      @ip_country_code = ip_country_code unless ip_country_code == SKIP
+      @ip_city = ip_city unless ip_city == SKIP
+      @ip_region = ip_region unless ip_region == SKIP
+      @is_ip_tor = is_ip_tor unless is_ip_tor == SKIP
+      @is_emulator = is_emulator unless is_emulator == SKIP
+      @custom = custom unless custom == SKIP
+      @additional_properties = additional_properties
+    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
+      session = hash.key?('session') ? hash['session'] : SKIP
+      fingerprint = hash.key?('fingerprint') ? hash['fingerprint'] : SKIP
+      fingerprint_provider =
+        hash.key?('fingerprint_provider') ? hash['fingerprint_provider'] : SKIP
+      user_agent = hash.key?('user_agent') ? hash['user_agent'] : SKIP
+      device_type = hash.key?('device_type') ? hash['device_type'] : SKIP
+      is_known = hash.key?('is_known') ? hash['is_known'] : SKIP
+      first_seen_time = if hash.key?('first_seen_time')
+                          (DateTimeHelper.from_rfc3339(hash['first_seen_time']) if hash['first_seen_time'])
+                        else
+                          SKIP
+                        end
+      last_seen_time = if hash.key?('last_seen_time')
+                         (DateTimeHelper.from_rfc3339(hash['last_seen_time']) if hash['last_seen_time'])
+                       else
+                         SKIP
+                       end
+      timezone_mismatch =
+        hash.key?('timezone_mismatch') ? hash['timezone_mismatch'] : SKIP
+      ip_address = hash.key?('ip_address') ? hash['ip_address'] : SKIP
+      is_ip_bad_proxy =
+        hash.key?('is_ip_bad_proxy') ? hash['is_ip_bad_proxy'] : SKIP
+      is_ip_proxy = hash.key?('is_ip_proxy') ? hash['is_ip_proxy'] : SKIP
+      ip_risk_score = hash.key?('ip_risk_score') ? hash['ip_risk_score'] : SKIP
+      ip_isp = hash.key?('ip_isp') ? hash['ip_isp'] : SKIP
+      ip_country_code =
+        hash.key?('ip_country_code') ? hash['ip_country_code'] : SKIP
+      ip_city = hash.key?('ip_city') ? hash['ip_city'] : SKIP
+      ip_region = hash.key?('ip_region') ? hash['ip_region'] : SKIP
+      is_ip_tor = hash.key?('is_ip_tor') ? hash['is_ip_tor'] : SKIP
+      is_emulator = hash.key?('is_emulator') ? hash['is_emulator'] : SKIP
+      custom = hash.key?('custom') ? hash['custom'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Device.new(id: id,
+                 session: session,
+                 fingerprint: fingerprint,
+                 fingerprint_provider: fingerprint_provider,
+                 user_agent: user_agent,
+                 device_type: device_type,
+                 is_known: is_known,
+                 first_seen_time: first_seen_time,
+                 last_seen_time: last_seen_time,
+                 timezone_mismatch: timezone_mismatch,
+                 ip_address: ip_address,
+                 is_ip_bad_proxy: is_ip_bad_proxy,
+                 is_ip_proxy: is_ip_proxy,
+                 ip_risk_score: ip_risk_score,
+                 ip_isp: ip_isp,
+                 ip_country_code: ip_country_code,
+                 ip_city: ip_city,
+                 ip_region: ip_region,
+                 is_ip_tor: is_ip_tor,
+                 is_emulator: is_emulator,
+                 custom: custom,
+                 additional_properties: additional_properties)
+    end
+
+    def to_custom_first_seen_time
+      DateTimeHelper.to_rfc3339(first_seen_time)
+    end
+
+    def to_custom_last_seen_time
+      DateTimeHelper.to_rfc3339(last_seen_time)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Device | 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} id: #{@id}, session: #{@session}, fingerprint: #{@fingerprint},"\
+      " fingerprint_provider: #{@fingerprint_provider}, user_agent: #{@user_agent}, device_type:"\
+      " #{@device_type}, is_known: #{@is_known}, first_seen_time: #{@first_seen_time},"\
+      " last_seen_time: #{@last_seen_time}, timezone_mismatch: #{@timezone_mismatch}, ip_address:"\
+      " #{@ip_address}, is_ip_bad_proxy: #{@is_ip_bad_proxy}, is_ip_proxy: #{@is_ip_proxy},"\
+      " ip_risk_score: #{@ip_risk_score}, ip_isp: #{@ip_isp}, ip_country_code:"\
+      " #{@ip_country_code}, ip_city: #{@ip_city}, ip_region: #{@ip_region}, is_ip_tor:"\
+      " #{@is_ip_tor}, is_emulator: #{@is_emulator}, custom: #{@custom}, additional_properties:"\
+      " #{@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}, session: #{@session.inspect}, fingerprint:"\
+      " #{@fingerprint.inspect}, fingerprint_provider: #{@fingerprint_provider.inspect},"\
+      " user_agent: #{@user_agent.inspect}, device_type: #{@device_type.inspect}, is_known:"\
+      " #{@is_known.inspect}, first_seen_time: #{@first_seen_time.inspect}, last_seen_time:"\
+      " #{@last_seen_time.inspect}, timezone_mismatch: #{@timezone_mismatch.inspect}, ip_address:"\
+      " #{@ip_address.inspect}, is_ip_bad_proxy: #{@is_ip_bad_proxy.inspect}, is_ip_proxy:"\
+      " #{@is_ip_proxy.inspect}, ip_risk_score: #{@ip_risk_score.inspect}, ip_isp:"\
+      " #{@ip_isp.inspect}, ip_country_code: #{@ip_country_code.inspect}, ip_city:"\
+      " #{@ip_city.inspect}, ip_region: #{@ip_region.inspect}, is_ip_tor: #{@is_ip_tor.inspect},"\
+      " is_emulator: #{@is_emulator.inspect}, custom: #{@custom.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/disclosure_purpose.rb

@@ -0,0 +1,29 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # This field must be set to `GLBA_502(e)` to support acceptable use of the
+  # product. Data contributed to Sigma First-Party Fraud is Non-Public
+  # Information (NPI) that may only be further disclosed pursuant to the GLBA
+  # fraud exception.
+  class DisclosurePurpose
+    DISCLOSURE_PURPOSE = [
+      # TODO: Write general description for ENUM_GLBA_502E
+      ENUM_GLBA_502E = 'GLBA_502(e)'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DISCLOSURE_PURPOSE.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_GLBA_502E)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/socure_risk_os_api/models/document_verification_config.rb

@@ -0,0 +1,195 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # The configurations for the document request transaction.
+  class DocumentVerificationConfig < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Set to `true` (boolean) to enable the SMS text message containing the
+    # document request URL. This field is set to `false` by default.
+    # > **Note:** SMS behavior varies by region:
+    # > - **US & Canada**: Messages are sent from our approved short code
+    # `33436`.
+    # > - **All other countries**: Messages are sent from our long code
+    # `+15103301986`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_message
+
+    # Specifies the language package for the Capture App. Below are the possible
+    # values.
+    # - Automatic (device default): `auto`
+    # - Arabic: `ar`
+    # - Arabic (Saudi Arabia): `ar-sa`
+    # - Armenian: `hy`
+    # - Bengali: `bn`
+    # - Chinese (Hong Kong): `zh-hk`
+    # - Chinese (Simplified): `zh-cn`
+    # - Chinese (Traditional): `zh-tw`
+    # - Czech: `cs-cz`
+    # - Danish: `da-dk`
+    # - Dutch: `nl-nl`
+    # - English: `en`
+    # - English (Australian): `en-au`
+    # - English (Canadian): `en-ca`
+    # - English (United Kingdom): `en-gb`
+    # - English (United States): `en-us`
+    # - Finnish: `fi-fi`
+    # - French: `fr`
+    # - French (Canada): `fr-ca`
+    # - German: `de-de`
+    # - Haitian Creole: `ht`
+    # - Hebrew: `he-il`
+    # - Hindi: `hi-in`
+    # - Hungarian: `hu-hu`
+    # - Indonesian: `id-id`
+    # - Italian: `it`
+    # - Italian (Switzerland): `it-ch`
+    # - Japanese: `ja-jp`
+    # - Korean: `ko`
+    # - Malay: `ms-my`
+    # - Norwegian: `no-no`
+    # - Polish: `pl-pl`
+    # - Portuguese (Brazil): `pt-br`
+    # - Portuguese (Portugal): `pt-pt`
+    # - Romanian (Moldova): `ro-mo`
+    # - Romanian (Romania): `ro-ro`
+    # - Russian: `ru`
+    # - Slovak: `sk-sk`
+    # - Spanish: `es`
+    # - Spanish (Argentina): `es-ar`
+    # - Spanish (International): `es-001`
+    # - Spanish (Mexico): `es-mx`
+    # - Spanish (Spain): `es-es`
+    # - Spanish (US): `es-us`
+    # - Swedish: `sv-se`
+    # - Tagalog: `tl`
+    # - Thai: `th-th`
+    # - Turkish: `tr-tr`
+    # - Urdu: `ur`
+    # - Vietnamese: `vi`
+    # Set `language` to `auto` to use the consumer's device default language. If
+    # the device's default language isn't supported, the Capture App defaults to
+    # English (`en`).
+    # @return [Language]
+    attr_accessor :language
+
+    # The name of the flow (created in RiskOS™) to use with this transaction.
+    # > **Note**: If the value is incorrect or not provided, the transaction
+    # uses the flow marked as **Default** in RiskOS™.
+    # @return [String]
+    attr_accessor :use_case_key
+
+    # Optional URL settings that redirect the consumer after the document
+    # capture and upload process is cancelled or completed on the Capture App.
+    # @return [Redirect]
+    attr_accessor :redirect
+
+    # Enables a simplified Capture App flow and allows you to select a default
+    # document type for the transaction using one of the values below.
+    # - `license`: Driver's license
+    # - `passport`: Passport
+    # > **Note**: Passing `documentType` with the value `license`  or `passport`
+    # implements a simplified Capture App flow that skips the Selected ID Type
+    # Screen and starts the flow on the Document Capture Screen.
+    # @return [String]
+    attr_accessor :document_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['send_message'] = 'send_message'
+      @_hash['language'] = 'language'
+      @_hash['use_case_key'] = 'use_case_key'
+      @_hash['redirect'] = 'redirect'
+      @_hash['document_type'] = 'document_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        send_message
+        language
+        use_case_key
+        redirect
+        document_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(send_message: SKIP, language: Language::ENUS,
+                   use_case_key: SKIP, redirect: SKIP, document_type: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @send_message = send_message unless send_message == SKIP
+      @language = language unless language == SKIP
+      @use_case_key = use_case_key unless use_case_key == SKIP
+      @redirect = redirect unless redirect == SKIP
+      @document_type = document_type unless document_type == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      send_message = hash.key?('send_message') ? hash['send_message'] : SKIP
+      language = hash['language'] ||= Language::ENUS
+      use_case_key = hash.key?('use_case_key') ? hash['use_case_key'] : SKIP
+      redirect = Redirect.from_hash(hash['redirect']) if hash['redirect']
+      document_type = hash.key?('document_type') ? hash['document_type'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      DocumentVerificationConfig.new(send_message: send_message,
+                                     language: language,
+                                     use_case_key: use_case_key,
+                                     redirect: redirect,
+                                     document_type: document_type,
+                                     additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [DocumentVerificationConfig | 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} send_message: #{@send_message}, language: #{@language}, use_case_key:"\
+      " #{@use_case_key}, redirect: #{@redirect}, document_type: #{@document_type},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} send_message: #{@send_message.inspect}, language: #{@language.inspect},"\
+      " use_case_key: #{@use_case_key.inspect}, redirect: #{@redirect.inspect}, document_type:"\
+      " #{@document_type.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/docv.rb

@@ -0,0 +1,98 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Docv Model.
+  class Docv < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The transaction token from the Document Request API response (v5). Use
+    # this if integrated with Socure's DocV solution.
+    # @return [String]
+    attr_accessor :transaction_token
+
+    # The configurations for the document request transaction.
+    # @return [DocumentVerificationConfig]
+    attr_accessor :config
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_token'] = 'transaction_token'
+      @_hash['config'] = 'config'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_token
+        config
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_token: SKIP, config: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transaction_token = transaction_token unless transaction_token == SKIP
+      @config = config unless config == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      transaction_token =
+        hash.key?('transaction_token') ? hash['transaction_token'] : SKIP
+      config = DocumentVerificationConfig.from_hash(hash['config']) if hash['config']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Docv.new(transaction_token: transaction_token,
+               config: config,
+               additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Docv | 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} transaction_token: #{@transaction_token}, config: #{@config},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_token: #{@transaction_token.inspect}, config:"\
+      " #{@config.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/environment_name.rb

@@ -0,0 +1,37 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Indicates which environment the evaluation ran in. Typically `Sandbox` for
+  # testing or `Production` for live traffic.
+  class EnvironmentName
+    ENVIRONMENT_NAME = [
+      # TODO: Write general description for SANDBOX
+      SANDBOX = 'Sandbox'.freeze,
+
+      # TODO: Write general description for PRODUCTION
+      PRODUCTION = 'Production'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ENVIRONMENT_NAME.include?(value)
+    end
+
+    def self.from_value(value, default_value = SANDBOX)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sandbox' then SANDBOX
+      when 'production' then PRODUCTION
+      else
+        default_value
+      end
+    end
+  end
+end