sc-apimatic-sdk 0.0.1

data/lib/socure_risk_os_api/models/trust_and_safety.rb

@@ -0,0 +1,167 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module SocureRiskOsApi
+  # TrustAndSafety Model.
+  class TrustAndSafety < 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 Trust and Safety workflow.
+    # @return [Data4]
+    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 = Data4.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.
+      TrustAndSafety.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 [TrustAndSafety | 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) { Data4.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) { Data4.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

data/lib/socure_risk_os_api/models/type.rb

@@ -0,0 +1,36 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Account Type
+  class Type
+    TYPE = [
+      # TODO: Write general description for CHECKING
+      CHECKING = 'CHECKING'.freeze,
+
+      # TODO: Write general description for SAVINGS
+      SAVINGS = 'SAVINGS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = CHECKING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'checking' then CHECKING
+      when 'savings' then SAVINGS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/socure_risk_os_api/models/type1.rb

@@ -0,0 +1,36 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Financial instrument type.
+  class Type1
+    TYPE1 = [
+      # TODO: Write general description for BANK_ACCOUNT
+      BANK_ACCOUNT = 'BANK_ACCOUNT'.freeze,
+
+      # TODO: Write general description for CRYPTO_ADDRESS
+      CRYPTO_ADDRESS = 'CRYPTO_ADDRESS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE1.include?(value)
+    end
+
+    def self.from_value(value, default_value = BANK_ACCOUNT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'bank_account' then BANK_ACCOUNT
+      when 'crypto_address' then CRYPTO_ADDRESS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/socure_risk_os_api/models/type2.rb

@@ -0,0 +1,36 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Bank account type.
+  class Type2
+    TYPE2 = [
+      # TODO: Write general description for CHECKING
+      CHECKING = 'CHECKING'.freeze,
+
+      # TODO: Write general description for SAVINGS
+      SAVINGS = 'SAVINGS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE2.include?(value)
+    end
+
+    def self.from_value(value, default_value = CHECKING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'checking' then CHECKING
+      when 'savings' then SAVINGS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/socure_risk_os_api/models/update_decision.rb

@@ -0,0 +1,156 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # UpdateDecision Model.
+  class UpdateDecision < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your environment-specific workflow identifier. <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
+
+    # The new decision value to apply.
+    # @return [Decision1]
+    attr_accessor :decision
+
+    # Comma-separated list of tags to apply to the evaluation.
+    # @return [String]
+    attr_accessor :tags
+
+    # The review queue to assign the evaluation to.
+    # @return [String]
+    attr_accessor :queue
+
+    # Optional notes to add context to the evaluation.
+    # @return [String]
+    attr_accessor :notes
+
+    # An array of base64-encoded attachment files.
+    # @return [Array[Attachment]]
+    attr_accessor :attachments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['workflow'] = 'workflow'
+      @_hash['decision'] = 'decision'
+      @_hash['tags'] = 'tags'
+      @_hash['queue'] = 'queue'
+      @_hash['notes'] = 'notes'
+      @_hash['attachments'] = 'attachments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tags
+        queue
+        notes
+        attachments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(workflow:, decision:, tags: SKIP, queue: SKIP, notes: SKIP,
+                   attachments: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @workflow = workflow
+      @decision = decision
+      @tags = tags unless tags == SKIP
+      @queue = queue unless queue == SKIP
+      @notes = notes unless notes == SKIP
+      @attachments = attachments unless attachments == 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.
+      workflow = hash.key?('workflow') ? hash['workflow'] : nil
+      decision = hash.key?('decision') ? hash['decision'] : nil
+      tags = hash.key?('tags') ? hash['tags'] : SKIP
+      queue = hash.key?('queue') ? hash['queue'] : SKIP
+      notes = hash.key?('notes') ? hash['notes'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      attachments = nil
+      unless hash['attachments'].nil?
+        attachments = []
+        hash['attachments'].each do |structure|
+          attachments << (Attachment.from_hash(structure) if structure)
+        end
+      end
+
+      attachments = SKIP unless hash.key?('attachments')
+
+      # 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.
+      UpdateDecision.new(workflow: workflow,
+                         decision: decision,
+                         tags: tags,
+                         queue: queue,
+                         notes: notes,
+                         attachments: attachments,
+                         additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [UpdateDecision | 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.decision,
+                                  ->(val) { Decision1.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['workflow'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['decision'],
+                                ->(val) { Decision1.validate(val) })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} workflow: #{@workflow}, decision: #{@decision}, tags: #{@tags}, queue:"\
+      " #{@queue}, notes: #{@notes}, attachments: #{@attachments}, 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}, decision: #{@decision.inspect}, tags:"\
+      " #{@tags.inspect}, queue: #{@queue.inspect}, notes: #{@notes.inspect}, attachments:"\
+      " #{@attachments.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/update_status.rb

@@ -0,0 +1,169 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # UpdateStatus Model.
+  class UpdateStatus < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your environment-specific workflow identifier. <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
+
+    # The new status to apply.
+    # @return [Status1]
+    attr_accessor :status
+
+    # An optional sub-status providing more detail (e.g., `In Review`).
+    # @return [String]
+    attr_accessor :sub_status
+
+    # Comma-separated list of tags to apply to the evaluation.
+    # @return [String]
+    attr_accessor :tags
+
+    # The review queue to assign the evaluation to.
+    # @return [String]
+    attr_accessor :queue
+
+    # Optional notes to add context to the evaluation.
+    # @return [String]
+    attr_accessor :notes
+
+    # An array of base64-encoded attachment files.
+    # @return [Array[Attachment]]
+    attr_accessor :attachments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['workflow'] = 'workflow'
+      @_hash['status'] = 'status'
+      @_hash['sub_status'] = 'sub_status'
+      @_hash['tags'] = 'tags'
+      @_hash['queue'] = 'queue'
+      @_hash['notes'] = 'notes'
+      @_hash['attachments'] = 'attachments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tags
+        queue
+        notes
+        attachments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(workflow:, status:, sub_status:, tags: SKIP, queue: SKIP,
+                   notes: SKIP, attachments: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @workflow = workflow
+      @status = status
+      @sub_status = sub_status
+      @tags = tags unless tags == SKIP
+      @queue = queue unless queue == SKIP
+      @notes = notes unless notes == SKIP
+      @attachments = attachments unless attachments == 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.
+      workflow = hash.key?('workflow') ? hash['workflow'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      sub_status = hash.key?('sub_status') ? hash['sub_status'] : nil
+      tags = hash.key?('tags') ? hash['tags'] : SKIP
+      queue = hash.key?('queue') ? hash['queue'] : SKIP
+      notes = hash.key?('notes') ? hash['notes'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      attachments = nil
+      unless hash['attachments'].nil?
+        attachments = []
+        hash['attachments'].each do |structure|
+          attachments << (Attachment.from_hash(structure) if structure)
+        end
+      end
+
+      attachments = SKIP unless hash.key?('attachments')
+
+      # 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.
+      UpdateStatus.new(workflow: workflow,
+                       status: status,
+                       sub_status: sub_status,
+                       tags: tags,
+                       queue: queue,
+                       notes: notes,
+                       attachments: attachments,
+                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [UpdateStatus | 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.status,
+                                  ->(val) { Status1.validate(val) }) and
+            APIHelper.valid_type?(value.sub_status,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['workflow'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['status'],
+                                ->(val) { Status1.validate(val) }) and
+          APIHelper.valid_type?(value['sub_status'],
+                                ->(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} workflow: #{@workflow}, status: #{@status}, sub_status: #{@sub_status},"\
+      " tags: #{@tags}, queue: #{@queue}, notes: #{@notes}, attachments: #{@attachments},"\
+      " 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}, status: #{@status.inspect}, sub_status:"\
+      " #{@sub_status.inspect}, tags: #{@tags.inspect}, queue: #{@queue.inspect}, notes:"\
+      " #{@notes.inspect}, attachments: #{@attachments.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end