sc-apimatic-sdk 0.0.1

data/lib/socure_risk_os_api/models/consumer_onboarding.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
+  # ConsumerOnboarding Model.
+  class ConsumerOnboarding < 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 Consumer Onboarding workflow.
+    # @return [Data1]
+    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 = Data1.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.
+      ConsumerOnboarding.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 [ConsumerOnboarding | 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) { Data1.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) { Data1.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/consumer_onboarding_patch.rb

@@ -0,0 +1,178 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module SocureRiskOsApi
+  # ConsumerOnboardingPatch Model.
+  class ConsumerOnboardingPatch < 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
+
+    # A top-level container for instructions that modify the lifecycle of the
+    # current evaluation session.
+    # @return [Actions]
+    attr_accessor :actions
+
+    # The main payload for the Consumer Onboarding workflow.
+    # @return [Data10]
+    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['actions'] = 'actions'
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer_metadata
+        actions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        customer_metadata
+      ]
+    end
+
+    def initialize(workflow:, id:, timestamp:, data:, customer_metadata: SKIP,
+                   actions: 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
+      @actions = actions unless actions == 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 = Data10.from_hash(hash['data']) if hash['data']
+      customer_metadata =
+        hash.key?('customer_metadata') ? hash['customer_metadata'] : SKIP
+      actions = Actions.from_hash(hash['actions']) if hash['actions']
+
+      # 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.
+      ConsumerOnboardingPatch.new(workflow: workflow,
+                                  id: id,
+                                  timestamp: timestamp,
+                                  data: data,
+                                  customer_metadata: customer_metadata,
+                                  actions: actions,
+                                  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 [ConsumerOnboardingPatch | 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) { Data10.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) { Data10.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}, actions: #{@actions}, 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}, actions:"\
+      " #{@actions.inspect}, data: #{@data.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/crypto_address.rb

@@ -0,0 +1,105 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Crypto address details. Required when `type` is `CRYPTO_ADDRESS`.
+  class CryptoAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Crypto asset code.
+    # @return [String]
+    attr_accessor :currency
+
+    # Blockchain network name.
+    # @return [String]
+    attr_accessor :network
+
+    # Wallet address.
+    # @return [String]
+    attr_accessor :address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['network'] = 'network'
+      @_hash['address'] = 'address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency
+        network
+        address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency: SKIP, network: SKIP, address: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @currency = currency unless currency == SKIP
+      @network = network unless network == SKIP
+      @address = address unless address == 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.
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      network = hash.key?('network') ? hash['network'] : SKIP
+      address = hash.key?('address') ? hash['address'] : 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.
+      CryptoAddress.new(currency: currency,
+                        network: network,
+                        address: address,
+                        additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CryptoAddress | 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} currency: #{@currency}, network: #{@network}, address: #{@address},"\
+      " 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} currency: #{@currency.inspect}, network: #{@network.inspect}, address:"\
+      " #{@address.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/data.rb

@@ -0,0 +1,106 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # The main payload for the Age Assurance workflow.
+  class Data < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The event category for the evaluation.
+    # @return [String]
+    attr_accessor :event_type
+
+    # Specifies the mode of interaction on the consumer's end.  <br /><br />
+    # Available values include: `web`, `mobile`, `pos`, and `other`.
+    # @return [Channel]
+    attr_accessor :channel
+
+    # Inputs the configured Age Assurance methods resolve age from.
+    # @return [Individual6]
+    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['channel'] = 'channel'
+      @_hash['individual'] = 'individual'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        event_type
+        channel
+        individual
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(event_type: SKIP, channel: SKIP, individual: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @event_type = event_type unless event_type == SKIP
+      @channel = channel unless channel == SKIP
+      @individual = individual unless individual == 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.
+      event_type = hash.key?('event_type') ? hash['event_type'] : SKIP
+      channel = hash.key?('channel') ? hash['channel'] : SKIP
+      individual = Individual6.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.
+      Data.new(event_type: event_type,
+               channel: channel,
+               individual: individual,
+               additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Data | 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} event_type: #{@event_type}, channel: #{@channel}, 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}, channel: #{@channel.inspect},"\
+      " individual: #{@individual.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end