sc-apimatic-sdk 0.0.1

data/lib/socure_risk_os_api/models/eval_response_with_out_socure_data.rb

@@ -0,0 +1,413 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module SocureRiskOsApi
+  # The standard Socure RiskOS™ evaluation response.
+  class EvalResponseWithOutSocureData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The client-defined request identifier, echoed back in the response.
+    # @return [String]
+    attr_accessor :id
+
+    # 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
+
+    # A unique identifier generated by RiskOS™ for this evaluation. Required for
+    # all `GET` and `PATCH` operations.
+    # @return [UUID | String]
+    attr_accessor :eval_id
+
+    # Your environment-specific workflow executed for this evaluation.
+    # @return [String]
+    attr_accessor :workflow
+
+    # Unique identifier of the workflow definition that was executed. This value
+    # corresponds to the workflow version configured in RiskOS™.
+    # @return [UUID | String]
+    attr_accessor :workflow_id
+
+    # The current lifecycle state of the evaluation — for example,
+    # `evaluation_in_process`, `evaluation_completed`, or `evaluation_paused`.
+    # @return [String]
+    attr_accessor :eval_status
+
+    # 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.
+    # @return [Decision]
+    attr_accessor :decision
+
+    # RFC 3339 timestamp marking when the decision was finalized (UTC).
+    # @return [DateTime]
+    attr_accessor :decision_at
+
+    # If configured for a workflow, provides an aggregate sum of the scores
+    # assigned to each matched step. Use it for risk banding, additional
+    # routing, or analytics alongside the primary `decision` value. The value is
+    # determined entirely by your workflow configuration: because you can assign
+    # positive or negative scores to individual steps, the aggregate is
+    # unbounded and can be negative. Whether a higher value indicates more or
+    # less risk depends on how you configure those step scores.
+    # @return [Integer]
+    attr_accessor :score
+
+    # Case-level status of the evaluation.
+    # @return [Status]
+    attr_accessor :status
+
+    # Provides additional detail about the evaluation status (for example,
+    # `Pending Verification` or `In Review`).
+    # @return [String]
+    attr_accessor :sub_status
+
+    # Version of the executed workflow.
+    # @return [String]
+    attr_accessor :workflow_version
+
+    # Indicates where the evaluation was initiated from. <br />  <br /> Possible
+    # values include: 
+    #   * `API`: Request submitted via the Evaluation API.
+    #   * `Dashboard`: Case created or evaluated through the RiskOS™ Dashboard.
+    # @return [EvalSource]
+    attr_accessor :eval_source
+
+    # RFC 3339 timestamp for when RiskOS™ started processing the evaluation.
+    # Useful for latency and performance monitoring.
+    # @return [DateTime]
+    attr_accessor :eval_start_time
+
+    # RFC 3339 timestamp for when RiskOS™ finished processing the evaluation.
+    # Can be paired with `eval_start_time` to compute total processing time.
+    # @return [DateTime]
+    attr_accessor :eval_end_time
+
+    # Array of labels applied during the workflow to highlight routing choices,
+    # notable signals, or rule outcomes. Useful for reporting, segmentation, or
+    # UI highlighting in the RiskOS™ Dashboard.
+    # @return [Array[String]]
+    attr_accessor :tags
+
+    # Subset of `tags` contributed only by the workflow's terminal decision or
+    # manual review step. Use this field when you need the tags that directly
+    # explain the final `decision`, without the broader routing and signal tags
+    # captured in `tags`.
+    # @return [Array[String]]
+    attr_accessor :decision_tags
+
+    # Freeform text field for analyst or system comments about the evaluation.
+    # Often used to capture manual review rationale or investigation context.
+    # @return [String]
+    attr_accessor :notes
+
+    # Lists any manual review queues the evaluation was sent to. Empty when the
+    # case is fully auto-resolved without human review.
+    # @return [Array[String]]
+    attr_accessor :review_queues
+
+    # A collection of external enrichment results generated during the workflow
+    # (e.g., device risk checks, KYC verifications, fraud models).
+    # @return [Array[DataEnrichment]]
+    attr_accessor :data_enrichments
+
+    # Aggregated data computed across historical evaluations for this entity.
+    # Returned when the extended evaluation response is enabled for your
+    # account.
+    # @return [Object]
+    attr_accessor :aggregations
+
+    # Identifier linking related evaluations that belong to the same group (for
+    # example, multiple evaluations triggered as part of a single workflow with
+    # grouped enrichments).
+    # @return [String]
+    attr_accessor :group_id
+
+    # The original input data submitted with the evaluation request. Only
+    # returned when the `include_input` query parameter is set to `true`.
+    # @return [Input]
+    attr_accessor :input
+
+    # Redirect URI for the hosted experience. Returned when the evaluation is
+    # initiated through the Hosted UX flow.
+    # @return [String]
+    attr_accessor :redirect_uri
+
+    # Derived and aggregated results produced by RiskOS™ for quick access.
+    # Disabled by default; enable through Socure support if required.
+    # @return [Object]
+    attr_accessor :computed
+
+    # Indicates which environment the evaluation ran in. Typically `Sandbox` for
+    # testing or `Production` for live traffic.
+    # @return [EnvironmentName]
+    attr_accessor :environment_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['customer_metadata'] = 'customer_metadata'
+      @_hash['eval_id'] = 'eval_id'
+      @_hash['workflow'] = 'workflow'
+      @_hash['workflow_id'] = 'workflow_id'
+      @_hash['eval_status'] = 'eval_status'
+      @_hash['decision'] = 'decision'
+      @_hash['decision_at'] = 'decision_at'
+      @_hash['score'] = 'score'
+      @_hash['status'] = 'status'
+      @_hash['sub_status'] = 'sub_status'
+      @_hash['workflow_version'] = 'workflow_version'
+      @_hash['eval_source'] = 'eval_source'
+      @_hash['eval_start_time'] = 'eval_start_time'
+      @_hash['eval_end_time'] = 'eval_end_time'
+      @_hash['tags'] = 'tags'
+      @_hash['decision_tags'] = 'decision_tags'
+      @_hash['notes'] = 'notes'
+      @_hash['review_queues'] = 'review_queues'
+      @_hash['data_enrichments'] = 'data_enrichments'
+      @_hash['aggregations'] = 'aggregations'
+      @_hash['group_id'] = 'group_id'
+      @_hash['input'] = 'input'
+      @_hash['redirect_uri'] = 'redirect_uri'
+      @_hash['computed'] = 'computed'
+      @_hash['environment_name'] = 'environment_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        customer_metadata
+        eval_id
+        workflow
+        workflow_id
+        eval_status
+        decision
+        decision_at
+        score
+        status
+        sub_status
+        workflow_version
+        eval_source
+        eval_start_time
+        eval_end_time
+        tags
+        decision_tags
+        notes
+        review_queues
+        data_enrichments
+        aggregations
+        group_id
+        input
+        redirect_uri
+        computed
+        environment_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        customer_metadata
+      ]
+    end
+
+    def initialize(id: SKIP, customer_metadata: SKIP, eval_id: SKIP,
+                   workflow: SKIP, workflow_id: SKIP, eval_status: SKIP,
+                   decision: SKIP, decision_at: SKIP, score: SKIP, status: SKIP,
+                   sub_status: SKIP, workflow_version: SKIP, eval_source: SKIP,
+                   eval_start_time: SKIP, eval_end_time: SKIP, tags: SKIP,
+                   decision_tags: SKIP, notes: SKIP, review_queues: SKIP,
+                   data_enrichments: SKIP, aggregations: SKIP, group_id: SKIP,
+                   input: SKIP, redirect_uri: SKIP, computed: SKIP,
+                   environment_name: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @customer_metadata = customer_metadata unless customer_metadata == SKIP
+      @eval_id = eval_id unless eval_id == SKIP
+      @workflow = workflow unless workflow == SKIP
+      @workflow_id = workflow_id unless workflow_id == SKIP
+      @eval_status = eval_status unless eval_status == SKIP
+      @decision = decision unless decision == SKIP
+      @decision_at = decision_at unless decision_at == SKIP
+      @score = score unless score == SKIP
+      @status = status unless status == SKIP
+      @sub_status = sub_status unless sub_status == SKIP
+      @workflow_version = workflow_version unless workflow_version == SKIP
+      @eval_source = eval_source unless eval_source == SKIP
+      @eval_start_time = eval_start_time unless eval_start_time == SKIP
+      @eval_end_time = eval_end_time unless eval_end_time == SKIP
+      @tags = tags unless tags == SKIP
+      @decision_tags = decision_tags unless decision_tags == SKIP
+      @notes = notes unless notes == SKIP
+      @review_queues = review_queues unless review_queues == SKIP
+      @data_enrichments = data_enrichments unless data_enrichments == SKIP
+      @aggregations = aggregations unless aggregations == SKIP
+      @group_id = group_id unless group_id == SKIP
+      @input = input unless input == SKIP
+      @redirect_uri = redirect_uri unless redirect_uri == SKIP
+      @computed = computed unless computed == SKIP
+      @environment_name = environment_name unless environment_name == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      customer_metadata =
+        hash.key?('customer_metadata') ? hash['customer_metadata'] : SKIP
+      eval_id = hash.key?('eval_id') ? hash['eval_id'] : SKIP
+      workflow = hash.key?('workflow') ? hash['workflow'] : SKIP
+      workflow_id = hash.key?('workflow_id') ? hash['workflow_id'] : SKIP
+      eval_status = hash.key?('eval_status') ? hash['eval_status'] : SKIP
+      decision = hash.key?('decision') ? hash['decision'] : SKIP
+      decision_at = if hash.key?('decision_at')
+                      (DateTimeHelper.from_rfc3339(hash['decision_at']) if hash['decision_at'])
+                    else
+                      SKIP
+                    end
+      score = hash.key?('score') ? hash['score'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      sub_status = hash.key?('sub_status') ? hash['sub_status'] : SKIP
+      workflow_version =
+        hash.key?('workflow_version') ? hash['workflow_version'] : SKIP
+      eval_source = hash.key?('eval_source') ? hash['eval_source'] : SKIP
+      eval_start_time = if hash.key?('eval_start_time')
+                          (DateTimeHelper.from_rfc3339(hash['eval_start_time']) if hash['eval_start_time'])
+                        else
+                          SKIP
+                        end
+      eval_end_time = if hash.key?('eval_end_time')
+                        (DateTimeHelper.from_rfc3339(hash['eval_end_time']) if hash['eval_end_time'])
+                      else
+                        SKIP
+                      end
+      tags = hash.key?('tags') ? hash['tags'] : SKIP
+      decision_tags = hash.key?('decision_tags') ? hash['decision_tags'] : SKIP
+      notes = hash.key?('notes') ? hash['notes'] : SKIP
+      review_queues = hash.key?('review_queues') ? hash['review_queues'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      data_enrichments = nil
+      unless hash['data_enrichments'].nil?
+        data_enrichments = []
+        hash['data_enrichments'].each do |structure|
+          data_enrichments << (DataEnrichment.from_hash(structure) if structure)
+        end
+      end
+
+      data_enrichments = SKIP unless hash.key?('data_enrichments')
+      aggregations = hash.key?('aggregations') ? hash['aggregations'] : SKIP
+      group_id = hash.key?('group_id') ? hash['group_id'] : SKIP
+      input = Input.from_hash(hash['input']) if hash['input']
+      redirect_uri = hash.key?('redirect_uri') ? hash['redirect_uri'] : SKIP
+      computed = hash.key?('computed') ? hash['computed'] : SKIP
+      environment_name =
+        hash.key?('environment_name') ? hash['environment_name'] : 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.
+      EvalResponseWithOutSocureData.new(id: id,
+                                        customer_metadata: customer_metadata,
+                                        eval_id: eval_id,
+                                        workflow: workflow,
+                                        workflow_id: workflow_id,
+                                        eval_status: eval_status,
+                                        decision: decision,
+                                        decision_at: decision_at,
+                                        score: score,
+                                        status: status,
+                                        sub_status: sub_status,
+                                        workflow_version: workflow_version,
+                                        eval_source: eval_source,
+                                        eval_start_time: eval_start_time,
+                                        eval_end_time: eval_end_time,
+                                        tags: tags,
+                                        decision_tags: decision_tags,
+                                        notes: notes,
+                                        review_queues: review_queues,
+                                        data_enrichments: data_enrichments,
+                                        aggregations: aggregations,
+                                        group_id: group_id,
+                                        input: input,
+                                        redirect_uri: redirect_uri,
+                                        computed: computed,
+                                        environment_name: environment_name,
+                                        additional_properties: additional_properties)
+    end
+
+    def to_custom_decision_at
+      DateTimeHelper.to_rfc3339(decision_at)
+    end
+
+    def to_custom_eval_start_time
+      DateTimeHelper.to_rfc3339(eval_start_time)
+    end
+
+    def to_custom_eval_end_time
+      DateTimeHelper.to_rfc3339(eval_end_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, customer_metadata: #{@customer_metadata}, eval_id: #{@eval_id},"\
+      " workflow: #{@workflow}, workflow_id: #{@workflow_id}, eval_status: #{@eval_status},"\
+      " decision: #{@decision}, decision_at: #{@decision_at}, score: #{@score}, status:"\
+      " #{@status}, sub_status: #{@sub_status}, workflow_version: #{@workflow_version},"\
+      " eval_source: #{@eval_source}, eval_start_time: #{@eval_start_time}, eval_end_time:"\
+      " #{@eval_end_time}, tags: #{@tags}, decision_tags: #{@decision_tags}, notes: #{@notes},"\
+      " review_queues: #{@review_queues}, data_enrichments: #{@data_enrichments}, aggregations:"\
+      " #{@aggregations}, group_id: #{@group_id}, input: #{@input}, redirect_uri:"\
+      " #{@redirect_uri}, computed: #{@computed}, environment_name: #{@environment_name},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, customer_metadata: #{@customer_metadata.inspect},"\
+      " eval_id: #{@eval_id.inspect}, workflow: #{@workflow.inspect}, workflow_id:"\
+      " #{@workflow_id.inspect}, eval_status: #{@eval_status.inspect}, decision:"\
+      " #{@decision.inspect}, decision_at: #{@decision_at.inspect}, score: #{@score.inspect},"\
+      " status: #{@status.inspect}, sub_status: #{@sub_status.inspect}, workflow_version:"\
+      " #{@workflow_version.inspect}, eval_source: #{@eval_source.inspect}, eval_start_time:"\
+      " #{@eval_start_time.inspect}, eval_end_time: #{@eval_end_time.inspect}, tags:"\
+      " #{@tags.inspect}, decision_tags: #{@decision_tags.inspect}, notes: #{@notes.inspect},"\
+      " review_queues: #{@review_queues.inspect}, data_enrichments: #{@data_enrichments.inspect},"\
+      " aggregations: #{@aggregations.inspect}, group_id: #{@group_id.inspect}, input:"\
+      " #{@input.inspect}, redirect_uri: #{@redirect_uri.inspect}, computed: #{@computed.inspect},"\
+      " environment_name: #{@environment_name.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/eval_source.rb

@@ -0,0 +1,38 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Indicates where the evaluation was initiated from. <br />  <br /> Possible
+  # values include:    * `API`: Request submitted via the Evaluation API.   *
+  # `Dashboard`: Case created or evaluated through the RiskOS™ Dashboard.
+  class EvalSource
+    EVAL_SOURCE = [
+      # TODO: Write general description for API
+      API = 'API'.freeze,
+
+      # TODO: Write general description for DASHBOARD
+      DASHBOARD = 'Dashboard'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EVAL_SOURCE.include?(value)
+    end
+
+    def self.from_value(value, default_value = API)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'api' then API
+      when 'dashboard' then DASHBOARD
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/socure_risk_os_api/models/event_category.rb

@@ -0,0 +1,45 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Represents the category of the event occurring on a user profile or account
+  # within the context of Trust and Safety verification processes.
+  class EventCategory
+    EVENT_CATEGORY = [
+      # TODO: Write general description for VERIFICATION
+      VERIFICATION = 'verification'.freeze,
+
+      # TODO: Write general description for AUTHENTICATION
+      AUTHENTICATION = 'authentication'.freeze,
+
+      # TODO: Write general description for ACTION
+      ACTION = 'action'.freeze,
+
+      # TODO: Write general description for UPDATE
+      UPDATE = 'update'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EVENT_CATEGORY.include?(value)
+    end
+
+    def self.from_value(value, default_value = VERIFICATION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'verification' then VERIFICATION
+      when 'authentication' then AUTHENTICATION
+      when 'action' then ACTION
+      when 'update' then UPDATE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/socure_risk_os_api/models/event_category1.rb

@@ -0,0 +1,45 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Represents the category of the event occurring on a user profile or account
+  # within the context of Bank Account Verification processes.
+  class EventCategory1
+    EVENT_CATEGORY1 = [
+      # TODO: Write general description for VERIFICATION
+      VERIFICATION = 'verification'.freeze,
+
+      # TODO: Write general description for AUTHENTICATION
+      AUTHENTICATION = 'authentication'.freeze,
+
+      # TODO: Write general description for ACTION
+      ACTION = 'action'.freeze,
+
+      # TODO: Write general description for UPDATE
+      UPDATE = 'update'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EVENT_CATEGORY1.include?(value)
+    end
+
+    def self.from_value(value, default_value = VERIFICATION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'verification' then VERIFICATION
+      when 'authentication' then AUTHENTICATION
+      when 'action' then ACTION
+      when 'update' then UPDATE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/socure_risk_os_api/models/event_category2.rb

@@ -0,0 +1,57 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # 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.
+  class EventCategory2
+    EVENT_CATEGORY2 = [
+      # TODO: Write general description for AUTHENTICATE
+      AUTHENTICATE = 'authenticate'.freeze,
+
+      # TODO: Write general description for ACTION
+      ACTION = 'action'.freeze,
+
+      # TODO: Write general description for INFORMATION
+      INFORMATION = 'information'.freeze,
+
+      # TODO: Write general description for UPDATE
+      UPDATE = 'update'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EVENT_CATEGORY2.include?(value)
+    end
+
+    def self.from_value(value, default_value = AUTHENTICATE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'authenticate' then AUTHENTICATE
+      when 'action' then ACTION
+      when 'information' then INFORMATION
+      when 'update' then UPDATE
+      else
+        default_value
+      end
+    end
+  end
+end