sc-apimatic-sdk 0.0.1

data/lib/socure_risk_os_api/models/advanced_prefill.rb

@@ -0,0 +1,168 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module SocureRiskOsApi
+  # AdvancedPrefill Model.
+  class AdvancedPrefill < 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. Use
+    # the identifier for your Advanced Prefill workflow (for example,
+    # `advanced_pre_fill`). <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 Advanced Prefill workflow.
+    # @return [Data2]
+    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 = Data2.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.
+      AdvancedPrefill.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 [AdvancedPrefill | 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) { Data2.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) { Data2.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/age_assurance.rb

@@ -0,0 +1,163 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module SocureRiskOsApi
+  # AgeAssurance Model.
+  class AgeAssurance < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your environment-specific Age Assurance workflow identifier. You can find
+    # this value in the RiskOS™ Dashboard > Developer Workbench > Integration
+    # Checklist.
+    # @return [String]
+    attr_accessor :workflow
+
+    # Required, customer-defined unique identifier for the request. Reusing an
+    # ID causes RiskOS™ to treat the request as a re-run.
+    # @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 Age Assurance workflow.
+    # @return [Data]
+    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 = Data.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.
+      AgeAssurance.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 [AgeAssurance | 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) { Data.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) { Data.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/amount.rb

@@ -0,0 +1,95 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Represents a monetary amount with its associated currency.
+  class Amount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The monetary value, represented as a numeric value.
+    # @return [Float]
+    attr_accessor :amount
+
+    # The currency code in ISO 4217 format (e.g., USD for US dollars).
+    # @return [String]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount: SKIP, currency: 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
+      @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
+
+      # 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.
+      Amount.new(amount: amount,
+                 currency: currency,
+                 additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Amount | 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}, 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},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/api_evaluation_monitoring_request.rb

@@ -0,0 +1,96 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # ApiEvaluationMonitoringRequest Model.
+  class ApiEvaluationMonitoringRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier assigned to a Watchlist enrichment after a RiskOS™
+    # workflow is finalized. You can retrieve this value from the response of a
+    # successful call to the Evaluation endpoint.
+    # @return [UUID | String]
+    attr_accessor :reference_id
+
+    # Specifies the type of monitoring list to which the entity (identified by
+    # its enrichment `referenceId`) will be subscribed.
+    # Passing `watchlist` enables monitoring for changes across all watchlist
+    # types defined in your Monitoring policy.
+    # @return [String]
+    attr_reader :list_type
+
+    # Specifies the action to be taken for monitoring enrollment.
+    # - `enable`: Activates Watchlist Monitoring for the specified evaluation.
+    # - `disable`: Deactivates Watchlist Monitoring for the specified
+    # evaluation.
+    # @return [Operation]
+    attr_accessor :operation
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reference_id'] = 'reference_id'
+      @_hash['list_type'] = 'list_type'
+      @_hash['operation'] = 'operation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reference_id:, operation:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @reference_id = reference_id
+      @list_type = 'watchlist'
+      @operation = operation
+      @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.
+      reference_id = hash.key?('reference_id') ? hash['reference_id'] : nil
+      operation = hash.key?('operation') ? hash['operation'] : 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.
+      ApiEvaluationMonitoringRequest.new(reference_id: reference_id,
+                                         operation: operation,
+                                         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} reference_id: #{@reference_id}, list_type: #{@list_type}, operation:"\
+      " #{@operation}, 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} reference_id: #{@reference_id.inspect}, list_type: #{@list_type.inspect},"\
+      " operation: #{@operation.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/api_evaluation_monitoring_response.rb

@@ -0,0 +1,84 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # ApiEvaluationMonitoringResponse Model.
+  class ApiEvaluationMonitoringResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates whether the monitoring enrollment operation was successful.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :success
+
+    # Current status of the monitoring subscription after the operation has been
+    # processed.
+    # @return [MonitoringStatus]
+    attr_accessor :monitoring_status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['success'] = 'success'
+      @_hash['monitoring_status'] = 'monitoring_status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(success:, monitoring_status:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @success = success
+      @monitoring_status = monitoring_status
+      @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.
+      success = hash.key?('success') ? hash['success'] : nil
+      monitoring_status =
+        hash.key?('monitoring_status') ? hash['monitoring_status'] : 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.
+      ApiEvaluationMonitoringResponse.new(success: success,
+                                          monitoring_status: monitoring_status,
+                                          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} success: #{@success}, monitoring_status: #{@monitoring_status},"\
+      " 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} success: #{@success.inspect}, monitoring_status:"\
+      " #{@monitoring_status.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end