sc-apimatic-sdk 0.0.1

data/lib/socure_risk_os_api/models/api_feedback_request.rb

@@ -0,0 +1,153 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # ApiFeedbackRequest Model.
+  class ApiFeedbackRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The customer-side identifier (`id`) provided during the original
+    # evaluation request.
+    # @return [String]
+    attr_accessor :id
+
+    # The environment-specific Workflow identifier that the ID is associated
+    # with. <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 fraud label for an application. Accepted values are `fraud` and
+    # `non-fraud`.
+    # @return [FraudLabel]
+    attr_accessor :fraud_label
+
+    # The fraud typology or category that best describes the nature of the
+    # fraud.
+    # @return [String]
+    attr_accessor :fraud_type
+
+    # Optional notes or additional information to be added to the case.
+    # @return [String]
+    attr_accessor :notes
+
+    # The date when the event was recorded. Use the `YYYY-MM-DD` format as
+    # defined by the [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339)
+    # full-date standard. If omitted, defaults to the current date.
+    # @return [Date]
+    attr_accessor :recorded_at
+
+    # The name or identifier of the person who recorded the fraud. If omitted,
+    # defaults to the authenticated user.
+    # @return [String]
+    attr_accessor :recorded_by
+
+    # Tags to categorize or label the fraud case. Useful for filtering,
+    # reporting, or internal tracking. Tags are validated against the
+    # namespace's configured tag definitions. If any tag is invalid, the request
+    # returns a `400` error.
+    # @return [Array[String]]
+    attr_accessor :tags
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['workflow'] = 'workflow'
+      @_hash['fraud_label'] = 'fraud_label'
+      @_hash['fraud_type'] = 'fraud_type'
+      @_hash['notes'] = 'notes'
+      @_hash['recorded_at'] = 'recorded_at'
+      @_hash['recorded_by'] = 'recorded_by'
+      @_hash['tags'] = 'tags'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fraud_type
+        notes
+        recorded_at
+        recorded_by
+        tags
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, workflow:, fraud_label:, fraud_type: SKIP, notes: SKIP,
+                   recorded_at: SKIP, recorded_by: SKIP, tags: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @workflow = workflow
+      @fraud_label = fraud_label
+      @fraud_type = fraud_type unless fraud_type == SKIP
+      @notes = notes unless notes == SKIP
+      @recorded_at = recorded_at unless recorded_at == SKIP
+      @recorded_by = recorded_by unless recorded_by == SKIP
+      @tags = tags unless tags == 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'] : nil
+      workflow = hash.key?('workflow') ? hash['workflow'] : nil
+      fraud_label = hash.key?('fraud_label') ? hash['fraud_label'] : nil
+      fraud_type = hash.key?('fraud_type') ? hash['fraud_type'] : SKIP
+      notes = hash.key?('notes') ? hash['notes'] : SKIP
+      recorded_at = hash.key?('recorded_at') ? hash['recorded_at'] : SKIP
+      recorded_by = hash.key?('recorded_by') ? hash['recorded_by'] : SKIP
+      tags = hash.key?('tags') ? hash['tags'] : 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.
+      ApiFeedbackRequest.new(id: id,
+                             workflow: workflow,
+                             fraud_label: fraud_label,
+                             fraud_type: fraud_type,
+                             notes: notes,
+                             recorded_at: recorded_at,
+                             recorded_by: recorded_by,
+                             tags: tags,
+                             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} id: #{@id}, workflow: #{@workflow}, fraud_label: #{@fraud_label},"\
+      " fraud_type: #{@fraud_type}, notes: #{@notes}, recorded_at: #{@recorded_at}, recorded_by:"\
+      " #{@recorded_by}, tags: #{@tags}, 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}, workflow: #{@workflow.inspect}, fraud_label:"\
+      " #{@fraud_label.inspect}, fraud_type: #{@fraud_type.inspect}, notes: #{@notes.inspect},"\
+      " recorded_at: #{@recorded_at.inspect}, recorded_by: #{@recorded_by.inspect}, tags:"\
+      " #{@tags.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/api_reason_codes_response.rb

@@ -0,0 +1,85 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # ApiReasonCodesResponse Model.
+  class ApiReasonCodesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of reason codes that match the request.
+    # @return [Array[ReasonCode]]
+    attr_accessor :reason_codes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reason_codes'] = 'reasonCodes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason_codes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reason_codes: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @reason_codes = reason_codes unless reason_codes == 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.
+      # Parameter is an array, so we need to iterate through it
+      reason_codes = nil
+      unless hash['reasonCodes'].nil?
+        reason_codes = []
+        hash['reasonCodes'].each do |structure|
+          reason_codes << (ReasonCode.from_hash(structure) if structure)
+        end
+      end
+
+      reason_codes = SKIP unless hash.key?('reasonCodes')
+
+      # 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.
+      ApiReasonCodesResponse.new(reason_codes: reason_codes,
+                                 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} reason_codes: #{@reason_codes}, 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} reason_codes: #{@reason_codes.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/attachment.rb

@@ -0,0 +1,95 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Attachment Model.
+  class Attachment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :file_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :file_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['file_name'] = 'file_name'
+      @_hash['file_data'] = 'file_data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        file_name
+        file_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(file_name: SKIP, file_data: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @file_name = file_name unless file_name == SKIP
+      @file_data = file_data unless file_data == 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.
+      file_name = hash.key?('file_name') ? hash['file_name'] : SKIP
+      file_data = hash.key?('file_data') ? hash['file_data'] : 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.
+      Attachment.new(file_name: file_name,
+                     file_data: file_data,
+                     additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Attachment | 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} file_name: #{@file_name}, file_data: #{@file_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} file_name: #{@file_name.inspect}, file_data: #{@file_data.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/bank_account_verification.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
+  # BankAccountVerification Model.
+  class BankAccountVerification < 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 Bank Account Verification workflow.
+    # @return [Data5]
+    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 = Data5.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.
+      BankAccountVerification.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 [BankAccountVerification | 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) { Data5.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) { Data5.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/base_model.rb

@@ -0,0 +1,110 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Base model.
+  # rubocop:disable all
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
+          end
+
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
+            else
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+  # rubocop:enable all
+end