sc-apimatic-sdk 0.0.1

data/lib/socure_risk_os_api/models/data4.rb

@@ -0,0 +1,157 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # The main payload for the Trust and Safety workflow.
+  class Data4 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Specifies the specific event type being tracked for a user, such as
+    # `identity_verification`, `document_submission`, or `badge_request`.
+    # @return [String]
+    attr_accessor :event_type
+
+    # Represents the category of the event occurring on a user profile or
+    # account within the context of Trust and Safety verification processes.
+    # @return [EventCategory]
+    attr_accessor :event_category
+
+    # Represents core information about the primary individual consumer.
+    # @return [Individual]
+    attr_accessor :individual
+
+    # 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
+
+    # Include any additional customer-specific data relevant to the Trust and
+    # Safety evaluation in this field. See [Custom
+    # Fields](https://help.socure.com/riskos/docs/custom-fields) for more
+    # information.
+    # @return [Object]
+    attr_accessor :custom
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['event_type'] = 'event_type'
+      @_hash['event_category'] = 'event_category'
+      @_hash['individual'] = 'individual'
+      @_hash['ip_address'] = 'ip_address'
+      @_hash['external_device'] = 'external_device'
+      @_hash['custom'] = 'custom'
+      @_hash['channel'] = 'channel'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        event_category
+        individual
+        ip_address
+        external_device
+        custom
+        channel
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(event_type:, event_category: SKIP, individual: SKIP,
+                   ip_address: SKIP, external_device: SKIP, custom: SKIP,
+                   channel: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @event_type = event_type
+      @event_category = event_category unless event_category == SKIP
+      @individual = individual unless individual == SKIP
+      @ip_address = ip_address unless ip_address == SKIP
+      @external_device = external_device unless external_device == SKIP
+      @custom = custom unless custom == SKIP
+      @channel = channel unless channel == 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.
+      event_type = hash.key?('event_type') ? hash['event_type'] : nil
+      event_category =
+        hash.key?('event_category') ? hash['event_category'] : SKIP
+      individual = Individual.from_hash(hash['individual']) if hash['individual']
+      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
+      channel = hash.key?('channel') ? hash['channel'] : 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.
+      Data4.new(event_type: event_type,
+                event_category: event_category,
+                individual: individual,
+                ip_address: ip_address,
+                external_device: external_device,
+                custom: custom,
+                channel: channel,
+                additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Data4 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.event_type,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['event_type'],
+                            ->(val) { val.instance_of? String })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} event_type: #{@event_type}, event_category: #{@event_category}, individual:"\
+      " #{@individual}, ip_address: #{@ip_address}, external_device: #{@external_device}, custom:"\
+      " #{@custom}, channel: #{@channel}, 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} event_type: #{@event_type.inspect}, event_category:"\
+      " #{@event_category.inspect}, individual: #{@individual.inspect}, ip_address:"\
+      " #{@ip_address.inspect}, external_device: #{@external_device.inspect}, custom:"\
+      " #{@custom.inspect}, channel: #{@channel.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/data5.rb

@@ -0,0 +1,154 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # The main payload for the Bank Account Verification workflow.
+  class Data5 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents core information about the primary individual consumer.
+    # @return [Individual]
+    attr_accessor :individual
+
+    # 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
+
+    # Represents the category of the event occurring on a user profile or
+    # account within the context of Bank Account Verification processes.
+    # @return [EventCategory1]
+    attr_accessor :event_category
+
+    # Specifies the specific event type being tracked for a user, such as
+    # `account_verification`.
+    # @return [String]
+    attr_accessor :event_type
+
+    # Include any additional customer-specific data relevant to the Bank Account
+    # Verification in this field. See [Custom
+    # Fields](https://help.socure.com/riskos/docs/custom-fields) for more
+    # information.
+    # @return [Object]
+    attr_accessor :custom
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['individual'] = 'individual'
+      @_hash['ip_address'] = 'ip_address'
+      @_hash['external_device'] = 'external_device'
+      @_hash['event_category'] = 'event_category'
+      @_hash['event_type'] = 'event_type'
+      @_hash['custom'] = 'custom'
+      @_hash['channel'] = 'channel'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        individual
+        ip_address
+        external_device
+        event_category
+        event_type
+        custom
+        channel
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(individual: SKIP, ip_address: SKIP, external_device: SKIP,
+                   event_category: SKIP, event_type: SKIP, custom: SKIP,
+                   channel: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @individual = individual unless individual == SKIP
+      @ip_address = ip_address unless ip_address == SKIP
+      @external_device = external_device unless external_device == SKIP
+      @event_category = event_category unless event_category == SKIP
+      @event_type = event_type unless event_type == SKIP
+      @custom = custom unless custom == SKIP
+      @channel = channel unless channel == 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']
+      ip_address = hash.key?('ip_address') ? hash['ip_address'] : SKIP
+      external_device = Device.from_hash(hash['external_device']) if hash['external_device']
+      event_category =
+        hash.key?('event_category') ? hash['event_category'] : SKIP
+      event_type = hash.key?('event_type') ? hash['event_type'] : SKIP
+      custom = hash.key?('custom') ? hash['custom'] : SKIP
+      channel = hash.key?('channel') ? hash['channel'] : 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.
+      Data5.new(individual: individual,
+                ip_address: ip_address,
+                external_device: external_device,
+                event_category: event_category,
+                event_type: event_type,
+                custom: custom,
+                channel: channel,
+                additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Data5 | 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}, ip_address: #{@ip_address}, external_device:"\
+      " #{@external_device}, event_category: #{@event_category}, event_type: #{@event_type},"\
+      " custom: #{@custom}, channel: #{@channel}, 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}, ip_address: #{@ip_address.inspect},"\
+      " external_device: #{@external_device.inspect}, event_category: #{@event_category.inspect},"\
+      " event_type: #{@event_type.inspect}, custom: #{@custom.inspect}, channel:"\
+      " #{@channel.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/data6.rb

@@ -0,0 +1,174 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # The main payload for the Business Onboarding workflow.
+  class Data6 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents core information about the primary individual consumer.
+    # @return [Individual]
+    attr_accessor :individual
+
+    # A list of other individual consumers associated with the business, such as
+    # beneficial owners or authorized signatories.
+    # @return [Array[Individual]]
+    attr_accessor :additional_individuals
+
+    # Information related to the business entity being evaluated.
+    # @return [Business]
+    attr_accessor :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
+
+    # Include any additional, customer-specific data in this field as needed for
+    # the evaluation. See [Custom
+    # Fields](https://help.socure.com/riskos/docs/custom-fields) for more
+    # information.
+    # @return [Object]
+    attr_accessor :custom
+
+    # 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
+
+    # 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['business'] = 'business'
+      @_hash['ip_address'] = 'ip_address'
+      @_hash['external_device'] = 'external_device'
+      @_hash['custom'] = 'custom'
+      @_hash['channel'] = 'channel'
+      @_hash['line_of_business'] = 'line_of_business'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        individual
+        additional_individuals
+        business
+        ip_address
+        external_device
+        custom
+        channel
+        line_of_business
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(individual: SKIP, additional_individuals: SKIP,
+                   business: SKIP, ip_address: SKIP, external_device: SKIP,
+                   custom: SKIP, channel: SKIP, line_of_business: 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
+      @business = business unless business == SKIP
+      @ip_address = ip_address unless ip_address == SKIP
+      @external_device = external_device unless external_device == SKIP
+      @custom = custom unless custom == SKIP
+      @channel = channel unless channel == SKIP
+      @line_of_business = line_of_business unless line_of_business == 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']
+      # 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')
+      business = Business.from_hash(hash['business']) if hash['business']
+      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
+      channel = hash.key?('channel') ? hash['channel'] : SKIP
+      line_of_business =
+        hash.key?('line_of_business') ? hash['line_of_business'] : 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.
+      Data6.new(individual: individual,
+                additional_individuals: additional_individuals,
+                business: business,
+                ip_address: ip_address,
+                external_device: external_device,
+                custom: custom,
+                channel: channel,
+                line_of_business: line_of_business,
+                additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Data6 | 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}, business: #{@business}, ip_address: #{@ip_address},"\
+      " external_device: #{@external_device}, custom: #{@custom}, channel: #{@channel},"\
+      " line_of_business: #{@line_of_business}, 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}, business: #{@business.inspect}, ip_address:"\
+      " #{@ip_address.inspect}, external_device: #{@external_device.inspect}, custom:"\
+      " #{@custom.inspect}, channel: #{@channel.inspect}, line_of_business:"\
+      " #{@line_of_business.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/data7.rb

@@ -0,0 +1,205 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # The main payload for the Login and Authentication workflow.
+  class Data7 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Specifies the high-level category of the event occurring within a consumer
+    # profile or account. Use this field to indicate the general type of user
+    # interaction for risk evaluation purposes. <br />  <br /> Use the following
+    # guidance when selecting a value:
+    # - `authenticate`: Use for authentication-related events where a user is
+    #   proving identity or access, such as login, logout, or session
+    #   re-authentication.
+    # - `information`: Use for events where a user requests or views
+    #   information without modifying account data, such as requesting a bank
+    #   statement, viewing account balances, or retrieving transaction history.
+    # - `update`: Use for events where a user updates or modifies account or
+    #   profile data, such as changing a password, updating an address, or
+    #   modifying contact information.
+    # - `action`: Use for all other user-initiated actions where a risk
+    #   evaluation is useful but the event does not fit into authentication,
+    #   information, or update categories.
+    # @return [EventCategory2]
+    attr_accessor :event_category
+
+    # A free-form, application-defined sub-category of the `event_category` that
+    # provides additional context about the specific event performed.  <br />
+    # <br /> Examples include: `login`, `address_update`, `statement_download`,
+    # or `password_reset`.
+    # @return [String]
+    attr_accessor :event_type
+
+    # Contextual details about the specific event, such as previous and  updated
+    # state values.
+    # @return [EventDetails]
+    attr_accessor :event_details
+
+    # Represents core information about the primary individual consumer.
+    # @return [Individual]
+    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
+
+    # Include any additional customer-specific data relevant to the Account
+    # Takeover evaluation in this field. 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['event_category'] = 'event_category'
+      @_hash['event_type'] = 'event_type'
+      @_hash['event_details'] = 'event_details'
+      @_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[
+        event_details
+        individual
+        channel
+        line_of_business
+        ip_address
+        external_device
+        custom
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(event_category:, event_type:, event_details: SKIP,
+                   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?
+
+      @event_category = event_category
+      @event_type = event_type
+      @event_details = event_details unless event_details == SKIP
+      @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.
+      event_category =
+        hash.key?('event_category') ? hash['event_category'] : nil
+      event_type = hash.key?('event_type') ? hash['event_type'] : nil
+      event_details = EventDetails.from_hash(hash['event_details']) if hash['event_details']
+      individual = Individual.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.
+      Data7.new(event_category: event_category,
+                event_type: event_type,
+                event_details: event_details,
+                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 [Data7 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.event_category,
+                                ->(val) { EventCategory2.validate(val) }) and
+            APIHelper.valid_type?(value.event_type,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['event_category'],
+                              ->(val) { EventCategory2.validate(val) }) and
+          APIHelper.valid_type?(value['event_type'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} event_category: #{@event_category}, event_type: #{@event_type},"\
+      " event_details: #{@event_details}, 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} event_category: #{@event_category.inspect}, event_type:"\
+      " #{@event_type.inspect}, event_details: #{@event_details.inspect}, 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