sc-apimatic-sdk 0.0.1

data/lib/socure_risk_os_api/models/data8.rb

@@ -0,0 +1,115 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Event payload for the workforce verification application.
+  class Data8 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of event being emitted.
+    # @return [String]
+    attr_reader :event_type
+
+    # Category of the event.
+    # @return [String]
+    attr_reader :event_category
+
+    # Information about the individual being verified.
+    # @return [Individual4]
+    attr_accessor :individual
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(individual:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @event_type = 'application_submitted'
+      @event_category = 'workforce_verification'
+      @individual = individual
+      @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 = Individual4.from_hash(hash['individual']) if hash['individual']
+
+      # 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.
+      Data8.new(individual: individual,
+                additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Data8 | 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 }) and
+            APIHelper.valid_type?(value.event_category,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.individual,
+                                  ->(val) { Individual4.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['event_type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['event_category'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['individual'],
+                                ->(val) { Individual4.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} event_type: #{@event_type}, event_category: #{@event_category}, individual:"\
+      " #{@individual}, 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}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/data9.rb

@@ -0,0 +1,130 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # The main payload for the Payment Screening workflow.
+  class Data9 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Single-select transaction type.
+    # @return [String]
+    attr_reader :transaction_type
+
+    # Optional free-form field identifying the line of business the request
+    # originates from.
+    # @return [String]
+    attr_accessor :line_of_business
+
+    # Transaction detail fields.
+    # @return [TransactionDetails]
+    attr_accessor :transaction_details
+
+    # Source party information.
+    # @return [Source]
+    attr_accessor :source
+
+    # Destination party information.
+    # @return [Destination]
+    attr_accessor :destination
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_type'] = 'transaction_type'
+      @_hash['line_of_business'] = 'line_of_business'
+      @_hash['transaction_details'] = 'transaction_details'
+      @_hash['source'] = 'source'
+      @_hash['destination'] = 'destination'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        line_of_business
+        transaction_details
+        source
+        destination
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line_of_business: SKIP, transaction_details: SKIP,
+                   source: SKIP, destination: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transaction_type = 'transfer'
+      @line_of_business = line_of_business unless line_of_business == SKIP
+      @transaction_details = transaction_details unless transaction_details == SKIP
+      @source = source unless source == SKIP
+      @destination = destination unless destination == 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.
+      line_of_business =
+        hash.key?('line_of_business') ? hash['line_of_business'] : SKIP
+      transaction_details = TransactionDetails.from_hash(hash['transaction_details']) if
+        hash['transaction_details']
+      source = Source.from_hash(hash['source']) if hash['source']
+      destination = Destination.from_hash(hash['destination']) if hash['destination']
+
+      # 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.
+      Data9.new(line_of_business: line_of_business,
+                transaction_details: transaction_details,
+                source: source,
+                destination: destination,
+                additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Data9 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.transaction_type,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['transaction_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} transaction_type: #{@transaction_type}, line_of_business:"\
+      " #{@line_of_business}, transaction_details: #{@transaction_details}, source: #{@source},"\
+      " destination: #{@destination}, 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_type: #{@transaction_type.inspect}, line_of_business:"\
+      " #{@line_of_business.inspect}, transaction_details: #{@transaction_details.inspect},"\
+      " source: #{@source.inspect}, destination: #{@destination.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/data_enrichment.rb

@@ -0,0 +1,182 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Common metadata shared by every enrichment result, describing the provider
+  # and call outcome.
+  class DataEnrichment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The human-readable name of the enrichment that executed.
+    # @return [String]
+    attr_accessor :enrichment_name
+
+    # Identifies the Socure service that processed this enrichment. The value
+    # varies by enrichment type — for example, `SocureOTP` for OTP, `SocureSNA`
+    # for SNA, and `SocurePaymentScreening` for Payment Screening. Core
+    # enrichments such as email risk may return the generic value `Socure`.
+    # @return [String]
+    attr_accessor :enrichment_provider
+
+    # The API endpoint used for the enrichment request.
+    # @return [String]
+    attr_accessor :enrichment_endpoint
+
+    # The provider or orchestration status code for the enrichment attempt.
+    # @return [Integer]
+    attr_accessor :status_code
+
+    # The payload sent to the enrichment provider.
+    # @return [Object]
+    attr_accessor :request
+
+    # Query string parameters sent to the enrichment provider, for enrichments
+    # called via URL parameters rather than a request body.
+    # @return [Object]
+    attr_accessor :request_url_params
+
+    # The data returned from the enrichment provider.
+    # @return [Response]
+    attr_accessor :response
+
+    # Indicates whether the result was returned from source cache instead of a
+    # fresh provider call.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_source_cache
+
+    # Total number of attempts made to complete the enrichment.
+    # @return [Integer]
+    attr_accessor :total_attempts
+
+    # Error detail when the enrichment request failed or only partially
+    # completed.
+    # @return [String]
+    attr_accessor :error_message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['enrichment_name'] = 'enrichment_name'
+      @_hash['enrichment_provider'] = 'enrichment_provider'
+      @_hash['enrichment_endpoint'] = 'enrichment_endpoint'
+      @_hash['status_code'] = 'status_code'
+      @_hash['request'] = 'request'
+      @_hash['request_url_params'] = 'request_url_params'
+      @_hash['response'] = 'response'
+      @_hash['is_source_cache'] = 'is_source_cache'
+      @_hash['total_attempts'] = 'total_attempts'
+      @_hash['error_message'] = 'error_message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        enrichment_name
+        enrichment_provider
+        enrichment_endpoint
+        status_code
+        request
+        request_url_params
+        response
+        is_source_cache
+        total_attempts
+        error_message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(enrichment_name: SKIP, enrichment_provider: SKIP,
+                   enrichment_endpoint: SKIP, status_code: SKIP, request: SKIP,
+                   request_url_params: SKIP, response: SKIP,
+                   is_source_cache: SKIP, total_attempts: SKIP,
+                   error_message: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @enrichment_name = enrichment_name unless enrichment_name == SKIP
+      @enrichment_provider = enrichment_provider unless enrichment_provider == SKIP
+      @enrichment_endpoint = enrichment_endpoint unless enrichment_endpoint == SKIP
+      @status_code = status_code unless status_code == SKIP
+      @request = request unless request == SKIP
+      @request_url_params = request_url_params unless request_url_params == SKIP
+      @response = response unless response == SKIP
+      @is_source_cache = is_source_cache unless is_source_cache == SKIP
+      @total_attempts = total_attempts unless total_attempts == SKIP
+      @error_message = error_message unless error_message == 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.
+      enrichment_name =
+        hash.key?('enrichment_name') ? hash['enrichment_name'] : SKIP
+      enrichment_provider =
+        hash.key?('enrichment_provider') ? hash['enrichment_provider'] : SKIP
+      enrichment_endpoint =
+        hash.key?('enrichment_endpoint') ? hash['enrichment_endpoint'] : SKIP
+      status_code = hash.key?('status_code') ? hash['status_code'] : SKIP
+      request = hash.key?('request') ? hash['request'] : SKIP
+      request_url_params =
+        hash.key?('request_url_params') ? hash['request_url_params'] : SKIP
+      response = Response.from_hash(hash['response']) if hash['response']
+      is_source_cache =
+        hash.key?('is_source_cache') ? hash['is_source_cache'] : SKIP
+      total_attempts =
+        hash.key?('total_attempts') ? hash['total_attempts'] : SKIP
+      error_message = hash.key?('error_message') ? hash['error_message'] : 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.
+      DataEnrichment.new(enrichment_name: enrichment_name,
+                         enrichment_provider: enrichment_provider,
+                         enrichment_endpoint: enrichment_endpoint,
+                         status_code: status_code,
+                         request: request,
+                         request_url_params: request_url_params,
+                         response: response,
+                         is_source_cache: is_source_cache,
+                         total_attempts: total_attempts,
+                         error_message: error_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} enrichment_name: #{@enrichment_name}, enrichment_provider:"\
+      " #{@enrichment_provider}, enrichment_endpoint: #{@enrichment_endpoint}, status_code:"\
+      " #{@status_code}, request: #{@request}, request_url_params: #{@request_url_params},"\
+      " response: #{@response}, is_source_cache: #{@is_source_cache}, total_attempts:"\
+      " #{@total_attempts}, error_message: #{@error_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} enrichment_name: #{@enrichment_name.inspect}, enrichment_provider:"\
+      " #{@enrichment_provider.inspect}, enrichment_endpoint: #{@enrichment_endpoint.inspect},"\
+      " status_code: #{@status_code.inspect}, request: #{@request.inspect}, request_url_params:"\
+      " #{@request_url_params.inspect}, response: #{@response.inspect}, is_source_cache:"\
+      " #{@is_source_cache.inspect}, total_attempts: #{@total_attempts.inspect}, error_message:"\
+      " #{@error_message.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/decision.rb

@@ -0,0 +1,47 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # The final outcome of the evaluation. Possible decision values are: *
+  # `ACCEPT`: The evaluation is approved; proceed with fulfillment/onboarding
+  # and the happy‑path experience. * `REVIEW`: Additional assessment is
+  # required; route to manual review and/or configured step‑up checks per
+  # workflow logic. * `REJECT`: The evaluation has failed the required checks
+  # and the entity is rejected. > **Note:** `ACCEPT`, `REVIEW`, and `REJECT` are
+  # the default decision values. Your integration can be customized to use
+  # different default decision values based on specific workflow needs.
+  class Decision
+    DECISION = [
+      # TODO: Write general description for ACCEPT
+      ACCEPT = 'ACCEPT'.freeze,
+
+      # TODO: Write general description for REVIEW
+      REVIEW = 'REVIEW'.freeze,
+
+      # TODO: Write general description for REJECT
+      REJECT = 'REJECT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DECISION.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACCEPT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'accept' then ACCEPT
+      when 'review' then REVIEW
+      when 'reject' then REJECT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/socure_risk_os_api/models/decision1.rb

@@ -0,0 +1,48 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # The new decision value to apply.
+  class Decision1
+    DECISION1 = [
+      # TODO: Write general description for ACCEPT
+      ACCEPT = 'ACCEPT'.freeze,
+
+      # TODO: Write general description for REJECT
+      REJECT = 'REJECT'.freeze,
+
+      # TODO: Write general description for REVIEW
+      REVIEW = 'REVIEW'.freeze,
+
+      # TODO: Write general description for RESUBMIT
+      RESUBMIT = 'RESUBMIT'.freeze,
+
+      # TODO: Write general description for CANCEL
+      CANCEL = 'CANCEL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DECISION1.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACCEPT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'accept' then ACCEPT
+      when 'reject' then REJECT
+      when 'review' then REVIEW
+      when 'resubmit' then RESUBMIT
+      when 'cancel' then CANCEL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/socure_risk_os_api/models/destination.rb

@@ -0,0 +1,136 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Destination party information.
+  class Destination < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount in minor currency units.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # ISO 4217 currency code for the amount.
+    # @return [String]
+    attr_accessor :currency
+
+    # Mode of interaction on the consumer's end.
+    # @return [Channel1]
+    attr_accessor :channel
+
+    # Consumer IP address in IPv4 or IPv6 format.
+    # @return [String]
+    attr_accessor :ip_address
+
+    # Individual party details for Payment Screening.
+    # @return [PaymentScreeningIndividual]
+    attr_accessor :individual
+
+    # Business party details for Payment Screening.
+    # @return [PaymentScreeningBusiness]
+    attr_accessor :business
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['channel'] = 'channel'
+      @_hash['ip_address'] = 'ip_address'
+      @_hash['individual'] = 'individual'
+      @_hash['business'] = 'business'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        currency
+        channel
+        ip_address
+        individual
+        business
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount: SKIP, currency: SKIP, channel: SKIP,
+                   ip_address: SKIP, individual: SKIP, business: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount unless amount == SKIP
+      @currency = currency unless currency == SKIP
+      @channel = channel unless channel == SKIP
+      @ip_address = ip_address unless ip_address == SKIP
+      @individual = individual unless individual == SKIP
+      @business = business unless 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.
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      channel = hash.key?('channel') ? hash['channel'] : SKIP
+      ip_address = hash.key?('ip_address') ? hash['ip_address'] : SKIP
+      individual = PaymentScreeningIndividual.from_hash(hash['individual']) if hash['individual']
+      business = PaymentScreeningBusiness.from_hash(hash['business']) if hash['business']
+
+      # 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.
+      Destination.new(amount: amount,
+                      currency: currency,
+                      channel: channel,
+                      ip_address: ip_address,
+                      individual: individual,
+                      business: business,
+                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Destination | 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} amount: #{@amount}, currency: #{@currency}, channel: #{@channel},"\
+      " ip_address: #{@ip_address}, individual: #{@individual}, business: #{@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} amount: #{@amount.inspect}, currency: #{@currency.inspect}, channel:"\
+      " #{@channel.inspect}, ip_address: #{@ip_address.inspect}, individual:"\
+      " #{@individual.inspect}, business: #{@business.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end