sc-apimatic-sdk 0.0.1

data/lib/socure_risk_os_api/models/data1.rb

@@ -0,0 +1,166 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # The main payload for the Consumer Onboarding workflow.
+  class Data1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents core information about the primary consumer.
+    # @return [Individual1]
+    attr_accessor :individual
+
+    # Include details of additional consumers if the evaluation involves
+    # multiple people. This field allows you to expand the evaluation scope
+    # beyond the primary consumer.
+    # @return [Array[AdditionalIndividual]]
+    attr_accessor :additional_individuals
+
+    # Specifies the mode of interaction on the consumer's end.  <br /><br />
+    # Available values include: `web`, `mobile`, `pos`, and `other`.
+    # @return [Channel]
+    attr_accessor :channel
+
+    # Optional free-form field that allows to pass on the line of business the
+    # request originates from.
+    # @return [String]
+    attr_accessor :line_of_business
+
+    # The consumer's IP address in IPv4 decimal or IPv6 hexadecimal format.
+    # @return [String]
+    attr_accessor :ip_address
+
+    # Use this field to provide external device data, e.g. originating from a
+    # third party data intelligence provider.
+    # @return [Device]
+    attr_accessor :external_device
+
+    # Use this field to send any additional, customer-specific data relevant to
+    # the evaluation. See [Custom
+    # Fields](https://help.socure.com/riskos/docs/custom-fields) for more
+    # information.
+    # @return [Object]
+    attr_accessor :custom
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['individual'] = 'individual'
+      @_hash['additional_individuals'] = 'additional_individuals'
+      @_hash['channel'] = 'channel'
+      @_hash['line_of_business'] = 'line_of_business'
+      @_hash['ip_address'] = 'ip_address'
+      @_hash['external_device'] = 'external_device'
+      @_hash['custom'] = 'custom'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        individual
+        additional_individuals
+        channel
+        line_of_business
+        ip_address
+        external_device
+        custom
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(individual: SKIP, additional_individuals: SKIP,
+                   channel: SKIP, line_of_business: SKIP, ip_address: SKIP,
+                   external_device: SKIP, custom: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @individual = individual unless individual == SKIP
+      @additional_individuals = additional_individuals unless additional_individuals == SKIP
+      @channel = channel unless channel == SKIP
+      @line_of_business = line_of_business unless line_of_business == SKIP
+      @ip_address = ip_address unless ip_address == SKIP
+      @external_device = external_device unless external_device == 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.
+      individual = Individual1.from_hash(hash['individual']) if hash['individual']
+      # Parameter is an array, so we need to iterate through it
+      additional_individuals = nil
+      unless hash['additional_individuals'].nil?
+        additional_individuals = []
+        hash['additional_individuals'].each do |structure|
+          additional_individuals << (AdditionalIndividual.from_hash(structure) if structure)
+        end
+      end
+
+      additional_individuals = SKIP unless hash.key?('additional_individuals')
+      channel = hash.key?('channel') ? hash['channel'] : SKIP
+      line_of_business =
+        hash.key?('line_of_business') ? hash['line_of_business'] : SKIP
+      ip_address = hash.key?('ip_address') ? hash['ip_address'] : SKIP
+      external_device = Device.from_hash(hash['external_device']) if hash['external_device']
+      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.
+      Data1.new(individual: individual,
+                additional_individuals: additional_individuals,
+                channel: channel,
+                line_of_business: line_of_business,
+                ip_address: ip_address,
+                external_device: external_device,
+                custom: custom,
+                additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Data1 | 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} individual: #{@individual}, additional_individuals:"\
+      " #{@additional_individuals}, channel: #{@channel}, line_of_business: #{@line_of_business},"\
+      " ip_address: #{@ip_address}, external_device: #{@external_device}, 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} individual: #{@individual.inspect}, additional_individuals:"\
+      " #{@additional_individuals.inspect}, channel: #{@channel.inspect}, line_of_business:"\
+      " #{@line_of_business.inspect}, ip_address: #{@ip_address.inspect}, external_device:"\
+      " #{@external_device.inspect}, custom: #{@custom.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/data10.rb

@@ -0,0 +1,166 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # The main payload for the Consumer Onboarding workflow.
+  class Data10 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents core information about the primary consumer.
+    # @return [Individual5]
+    attr_accessor :individual
+
+    # Include details of additional consumers if the evaluation involves
+    # multiple people. This field allows you to expand the evaluation scope
+    # beyond the primary consumer.
+    # @return [Array[Individual]]
+    attr_accessor :additional_individuals
+
+    # Specifies the mode of interaction on the consumer's end.  <br /><br />
+    # Available values include: `web`, `mobile`, `pos`, and `other`.
+    # @return [Channel]
+    attr_accessor :channel
+
+    # Optional free-form field that allows to pass on the line of business the
+    # request originates from.
+    # @return [String]
+    attr_accessor :line_of_business
+
+    # The consumer's IP address in IPv4 decimal or IPv6 hexadecimal format.
+    # @return [String]
+    attr_accessor :ip_address
+
+    # Use this field to provide external device data, e.g. originating from a
+    # third party data intelligence provider.
+    # @return [Device]
+    attr_accessor :external_device
+
+    # Use this field to send any additional, customer-specific data relevant to
+    # the evaluation. See [Custom
+    # Fields](https://help.socure.com/riskos/docs/custom-fields) for more
+    # information.
+    # @return [Object]
+    attr_accessor :custom
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['individual'] = 'individual'
+      @_hash['additional_individuals'] = 'additional_individuals'
+      @_hash['channel'] = 'channel'
+      @_hash['line_of_business'] = 'line_of_business'
+      @_hash['ip_address'] = 'ip_address'
+      @_hash['external_device'] = 'external_device'
+      @_hash['custom'] = 'custom'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        individual
+        additional_individuals
+        channel
+        line_of_business
+        ip_address
+        external_device
+        custom
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(individual: SKIP, additional_individuals: SKIP,
+                   channel: SKIP, line_of_business: SKIP, ip_address: SKIP,
+                   external_device: SKIP, custom: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @individual = individual unless individual == SKIP
+      @additional_individuals = additional_individuals unless additional_individuals == SKIP
+      @channel = channel unless channel == SKIP
+      @line_of_business = line_of_business unless line_of_business == SKIP
+      @ip_address = ip_address unless ip_address == SKIP
+      @external_device = external_device unless external_device == 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.
+      individual = Individual5.from_hash(hash['individual']) if hash['individual']
+      # Parameter is an array, so we need to iterate through it
+      additional_individuals = nil
+      unless hash['additional_individuals'].nil?
+        additional_individuals = []
+        hash['additional_individuals'].each do |structure|
+          additional_individuals << (Individual.from_hash(structure) if structure)
+        end
+      end
+
+      additional_individuals = SKIP unless hash.key?('additional_individuals')
+      channel = hash.key?('channel') ? hash['channel'] : SKIP
+      line_of_business =
+        hash.key?('line_of_business') ? hash['line_of_business'] : SKIP
+      ip_address = hash.key?('ip_address') ? hash['ip_address'] : SKIP
+      external_device = Device.from_hash(hash['external_device']) if hash['external_device']
+      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.
+      Data10.new(individual: individual,
+                 additional_individuals: additional_individuals,
+                 channel: channel,
+                 line_of_business: line_of_business,
+                 ip_address: ip_address,
+                 external_device: external_device,
+                 custom: custom,
+                 additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Data10 | 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} individual: #{@individual}, additional_individuals:"\
+      " #{@additional_individuals}, channel: #{@channel}, line_of_business: #{@line_of_business},"\
+      " ip_address: #{@ip_address}, external_device: #{@external_device}, 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} individual: #{@individual.inspect}, additional_individuals:"\
+      " #{@additional_individuals.inspect}, channel: #{@channel.inspect}, line_of_business:"\
+      " #{@line_of_business.inspect}, ip_address: #{@ip_address.inspect}, external_device:"\
+      " #{@external_device.inspect}, custom: #{@custom.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/data2.rb

@@ -0,0 +1,145 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # The main payload for the Advanced Prefill workflow.
+  class Data2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Minimal identity and device inputs used to verify the requester and gate
+    # identity-data disclosure. Only `phone_number` and `di_session_token` are
+    # required; additional attributes improve Prefill match accuracy.
+    # @return [Individual3]
+    attr_accessor :individual
+
+    # Specifies the mode of interaction on the consumer's end.  <br /><br />
+    # Available values include: `web`, `mobile`, `pos`, and `other`.
+    # @return [Channel]
+    attr_accessor :channel
+
+    # Optional free-form field that allows to pass on the line of business the
+    # request originates from.
+    # @return [String]
+    attr_accessor :line_of_business
+
+    # The consumer's IP address in IPv4 decimal or IPv6 hexadecimal format.
+    # @return [String]
+    attr_accessor :ip_address
+
+    # Use this field to provide external device data, e.g. originating from a
+    # third party data intelligence provider.
+    # @return [Device]
+    attr_accessor :external_device
+
+    # Use this field to send any additional, customer-specific data relevant to
+    # the evaluation. See [Custom
+    # Fields](https://help.socure.com/riskos/docs/custom-fields) for more
+    # information.
+    # @return [Object]
+    attr_accessor :custom
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['individual'] = 'individual'
+      @_hash['channel'] = 'channel'
+      @_hash['line_of_business'] = 'line_of_business'
+      @_hash['ip_address'] = 'ip_address'
+      @_hash['external_device'] = 'external_device'
+      @_hash['custom'] = 'custom'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        individual
+        channel
+        line_of_business
+        ip_address
+        external_device
+        custom
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(individual: SKIP, channel: SKIP, line_of_business: SKIP,
+                   ip_address: SKIP, external_device: SKIP, custom: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @individual = individual unless individual == SKIP
+      @channel = channel unless channel == SKIP
+      @line_of_business = line_of_business unless line_of_business == SKIP
+      @ip_address = ip_address unless ip_address == SKIP
+      @external_device = external_device unless external_device == 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.
+      individual = Individual3.from_hash(hash['individual']) if hash['individual']
+      channel = hash.key?('channel') ? hash['channel'] : SKIP
+      line_of_business =
+        hash.key?('line_of_business') ? hash['line_of_business'] : SKIP
+      ip_address = hash.key?('ip_address') ? hash['ip_address'] : SKIP
+      external_device = Device.from_hash(hash['external_device']) if hash['external_device']
+      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.
+      Data2.new(individual: individual,
+                channel: channel,
+                line_of_business: line_of_business,
+                ip_address: ip_address,
+                external_device: external_device,
+                custom: custom,
+                additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Data2 | 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} individual: #{@individual}, channel: #{@channel}, line_of_business:"\
+      " #{@line_of_business}, ip_address: #{@ip_address}, external_device: #{@external_device},"\
+      " 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} individual: #{@individual.inspect}, channel: #{@channel.inspect},"\
+      " line_of_business: #{@line_of_business.inspect}, ip_address: #{@ip_address.inspect},"\
+      " external_device: #{@external_device.inspect}, custom: #{@custom.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/data3.rb

@@ -0,0 +1,160 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # The main payload for the Pass-Through workflow.
+  class Data3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents core information about the primary individual consumer.
+    # @return [Individual]
+    attr_accessor :individual
+
+    # A list of Socure module names to include in the pass-through evaluation.
+    # Each entry is a module identifier string following the same naming
+    # convention as the ID+ endpoint modules — for example `["fraud",
+    # "synthetic"]`. The module names you can request depend on the enrichments
+    # enabled for your workflow and your Socure contract:
+    # - `accountintelligence`
+    # - `accountintelligencepremier`
+    # - `addressrisk`
+    # - `deceasedcheck`
+    # - `devicerisk`
+    # - `digitalintelligence`
+    # - `documentverification`
+    # - `ecbsv`
+    # - `emailrisk`
+    # - `firstpartyfraud`
+    # - `fraud`
+    # - `graphintelligenceplus`
+    # - `graphintelligencestandard`
+    # - `kyc`
+    # - `kycplus`
+    # - `phonerisk`
+    # - `prefill`
+    # - `secondarydocument`
+    # - `selfieintelligence`
+    # - `selfiereverification`
+    # - `synthetic`
+    # - `watchlistplus`
+    # - `watchlistpremier`
+    # - `watchliststandard`
+    # **Note:** Listing a module in `data.modules` does not by itself guarantee
+    # a pass-through. The requested module data is returned only when your
+    # workflow is configured with a pass-through enrichment.
+    # @return [Array[String]]
+    attr_accessor :modules
+
+    # Specifies the mode of interaction on the consumer's end.  <br /><br />
+    # Available values include: `web`, `mobile`, `pos`, and `other`.
+    # @return [Channel]
+    attr_accessor :channel
+
+    # Optional free-form field that allows to pass on the line of business the
+    # request originates from.
+    # @return [String]
+    attr_accessor :line_of_business
+
+    # The consumer's IP address in IPv4 decimal or IPv6 hexadecimal format.
+    # @return [String]
+    attr_accessor :ip_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['individual'] = 'individual'
+      @_hash['modules'] = 'modules'
+      @_hash['channel'] = 'channel'
+      @_hash['line_of_business'] = 'line_of_business'
+      @_hash['ip_address'] = 'ip_address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        individual
+        modules
+        channel
+        line_of_business
+        ip_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(individual: SKIP, modules: SKIP, channel: SKIP,
+                   line_of_business: SKIP, ip_address: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @individual = individual unless individual == SKIP
+      @modules = modules unless modules == SKIP
+      @channel = channel unless channel == SKIP
+      @line_of_business = line_of_business unless line_of_business == SKIP
+      @ip_address = ip_address unless ip_address == 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.
+      individual = Individual.from_hash(hash['individual']) if hash['individual']
+      modules = hash.key?('modules') ? hash['modules'] : SKIP
+      channel = hash.key?('channel') ? hash['channel'] : SKIP
+      line_of_business =
+        hash.key?('line_of_business') ? hash['line_of_business'] : SKIP
+      ip_address = hash.key?('ip_address') ? hash['ip_address'] : 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.
+      Data3.new(individual: individual,
+                modules: modules,
+                channel: channel,
+                line_of_business: line_of_business,
+                ip_address: ip_address,
+                additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Data3 | 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} individual: #{@individual}, modules: #{@modules}, channel: #{@channel},"\
+      " line_of_business: #{@line_of_business}, ip_address: #{@ip_address}, 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} individual: #{@individual.inspect}, modules: #{@modules.inspect}, channel:"\
+      " #{@channel.inspect}, line_of_business: #{@line_of_business.inspect}, ip_address:"\
+      " #{@ip_address.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end