sc-apimatic-sdk 0.0.1

data/lib/socure_risk_os_api/models/event_details.rb

@@ -0,0 +1,96 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Contextual details about the specific event, such as previous and  updated
+  # state values.
+  class EventDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Data reflecting the state prior to the update.
+    # @return [Object]
+    attr_accessor :previous
+
+    # Data reflecting the new state after the update.
+    # @return [Object]
+    attr_accessor :updated
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['previous'] = 'previous'
+      @_hash['updated'] = 'updated'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        previous
+        updated
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(previous: SKIP, updated: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @previous = previous unless previous == SKIP
+      @updated = updated unless updated == 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.
+      previous = hash.key?('previous') ? hash['previous'] : SKIP
+      updated = hash.key?('updated') ? hash['updated'] : 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.
+      EventDetails.new(previous: previous,
+                       updated: updated,
+                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [EventDetails | 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} previous: #{@previous}, updated: #{@updated}, 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} previous: #{@previous.inspect}, updated: #{@updated.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/formation.rb

@@ -0,0 +1,138 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Formation Model.
+  class Formation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Legal structure of the business. Free-form string; no fixed set of values
+    # is enforced. For best business verification results, send a standard legal
+    # entity type such as `CORPORATION`, `LLC`, `SOLE_PROPRIETOR`, or
+    # `PARTNERSHIP`.
+    # @return [String]
+    attr_accessor :entity_type
+
+    # YYYY-MM-DD RFC 3339 date string
+    # @return [Date]
+    attr_accessor :registration_date
+
+    # State of registration
+    # @return [String]
+    attr_accessor :registration_state
+
+    # Country of registration
+    # @return [String]
+    attr_accessor :registration_country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['entity_type'] = 'entity_type'
+      @_hash['registration_date'] = 'registration_date'
+      @_hash['registration_state'] = 'registration_state'
+      @_hash['registration_country'] = 'registration_country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(entity_type:, registration_date:, registration_state:,
+                   registration_country:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @entity_type = entity_type
+      @registration_date = registration_date
+      @registration_state = registration_state
+      @registration_country = registration_country
+      @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.
+      entity_type = hash.key?('entity_type') ? hash['entity_type'] : nil
+      registration_date =
+        hash.key?('registration_date') ? hash['registration_date'] : nil
+      registration_state =
+        hash.key?('registration_state') ? hash['registration_state'] : nil
+      registration_country =
+        hash.key?('registration_country') ? hash['registration_country'] : nil
+
+      # 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.
+      Formation.new(entity_type: entity_type,
+                    registration_date: registration_date,
+                    registration_state: registration_state,
+                    registration_country: registration_country,
+                    additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Formation | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.entity_type,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.registration_date,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.registration_state,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.registration_country,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['entity_type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['registration_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['registration_state'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['registration_country'],
+                                ->(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} entity_type: #{@entity_type}, registration_date: #{@registration_date},"\
+      " registration_state: #{@registration_state}, registration_country:"\
+      " #{@registration_country}, 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} entity_type: #{@entity_type.inspect}, registration_date:"\
+      " #{@registration_date.inspect}, registration_state: #{@registration_state.inspect},"\
+      " registration_country: #{@registration_country.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/fraud_feedback_import_response.rb

@@ -0,0 +1,73 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # FraudFeedbackImportResponse Model.
+  class FraudFeedbackImportResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(message:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @message = message
+      @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.
+      message = hash.key?('message') ? hash['message'] : nil
+
+      # 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.
+      FraudFeedbackImportResponse.new(message: message,
+                                      additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message: #{@message}, 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} message: #{@message.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/fraud_feedback_response.rb

@@ -0,0 +1,73 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # FraudFeedbackResponse Model.
+  class FraudFeedbackResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(message:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @message = message
+      @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.
+      message = hash.key?('message') ? hash['message'] : nil
+
+      # 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.
+      FraudFeedbackResponse.new(message: message,
+                                additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message: #{@message}, 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} message: #{@message.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/fraud_label.rb

@@ -0,0 +1,37 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # The fraud label for an application. Accepted values are `fraud` and
+  # `non-fraud`.
+  class FraudLabel
+    FRAUD_LABEL = [
+      # TODO: Write general description for FRAUD
+      FRAUD = 'fraud'.freeze,
+
+      # TODO: Write general description for NONFRAUD
+      NONFRAUD = 'non-fraud'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FRAUD_LABEL.include?(value)
+    end
+
+    def self.from_value(value, default_value = FRAUD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'fraud' then FRAUD
+      when 'nonfraud' then NONFRAUD
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/socure_risk_os_api/models/gender.rb

@@ -0,0 +1,40 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # The consumer's gender.
+  class Gender
+    GENDER = [
+      # TODO: Write general description for MALE
+      MALE = 'Male'.freeze,
+
+      # TODO: Write general description for FEMALE
+      FEMALE = 'Female'.freeze,
+
+      # TODO: Write general description for ENUM_SELF_IDENTIFY
+      ENUM_SELF_IDENTIFY = 'Self Identify'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      GENDER.include?(value)
+    end
+
+    def self.from_value(value, default_value = MALE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'male' then MALE
+      when 'female' then FEMALE
+      when 'enum_self_identify' then ENUM_SELF_IDENTIFY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/socure_risk_os_api/models/generic_passthrough.rb

@@ -0,0 +1,169 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module SocureRiskOsApi
+  # Schema for a generic pass-through evaluation flow. Typically used when the
+  # goal is to retrieve Socure module data without applying a full risk
+  # evaluation.
+  class GenericPassthrough < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your environment-specific workflow identifier. You can find this value in
+    # the RiskOS™ Dashboard > Developer Workbench > Integration Checklist. <br
+    # /><br /> **Note:** The workflow name must be unique within your RiskOS™
+    # environment. It is not scoped by use case and must identify a single
+    # active workflow for each Evaluation API request.
+    # @return [String]
+    attr_accessor :workflow
+
+    # Required, customer-defined unique identifier for the request. <br /><br />
+    # This value must be unique for each evaluation. Reusing an ID causes
+    # RiskOS™ to treat the request as a re-run and can impact processing
+    # behavior, results, and downstream workflows.
+    # @return [String]
+    attr_accessor :id
+
+    # The timestamp indicating when the evaluation was initiated, in ISO 8601 /
+    # RFC 3339 format.
+    # @return [DateTime]
+    attr_accessor :timestamp
+
+    # Optional, opaque JSON object echoed back unchanged on the response and at
+    # the top level of webhook callbacks — use it to route and correlate
+    # requests. Must be a JSON object of up to 200 characters total (the entire
+    # serialized JSON); larger payloads return `413
+    # CUSTOMER_METADATA_TOO_LARGE`. Omit it or send `null` to skip. Don't
+    # include PII or secrets. See [Customer
+    # Metadata](https://help.socure.com/riskos/docs/customer-metadata).
+    # @return [Object]
+    attr_accessor :customer_metadata
+
+    # The main payload for the Pass-Through workflow.
+    # @return [Data3]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['workflow'] = 'workflow'
+      @_hash['id'] = 'id'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['customer_metadata'] = 'customer_metadata'
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer_metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        customer_metadata
+      ]
+    end
+
+    def initialize(workflow:, id:, timestamp:, data:, customer_metadata: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @workflow = workflow
+      @id = id
+      @timestamp = timestamp
+      @customer_metadata = customer_metadata unless customer_metadata == SKIP
+      @data = data
+      @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.
+      workflow = hash.key?('workflow') ? hash['workflow'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      timestamp = if hash.key?('timestamp')
+                    (DateTimeHelper.from_rfc3339(hash['timestamp']) if hash['timestamp'])
+                  end
+      data = Data3.from_hash(hash['data']) if hash['data']
+      customer_metadata =
+        hash.key?('customer_metadata') ? hash['customer_metadata'] : 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.
+      GenericPassthrough.new(workflow: workflow,
+                             id: id,
+                             timestamp: timestamp,
+                             data: data,
+                             customer_metadata: customer_metadata,
+                             additional_properties: additional_properties)
+    end
+
+    def to_custom_timestamp
+      DateTimeHelper.to_rfc3339(timestamp)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [GenericPassthrough | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.workflow,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.timestamp,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.data,
+                                  ->(val) { Data3.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['workflow'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['timestamp'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['data'],
+                                ->(val) { Data3.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} workflow: #{@workflow}, id: #{@id}, timestamp: #{@timestamp},"\
+      " customer_metadata: #{@customer_metadata}, data: #{@data}, 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} workflow: #{@workflow.inspect}, id: #{@id.inspect}, timestamp:"\
+      " #{@timestamp.inspect}, customer_metadata: #{@customer_metadata.inspect}, data:"\
+      " #{@data.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end