sc-apimatic-sdk 0.0.1

data/lib/socure_risk_os_api/models/business.rb

@@ -0,0 +1,224 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Information related to the business entity being evaluated.
+  class Business < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique identifier for the business entity.
+    # @return [String]
+    attr_accessor :id
+
+    # The registered legal name of the business.
+    # @return [String]
+    attr_accessor :name
+
+    # The consumer’s phone number. The API expects the standard E.164 format
+    # (e.g., +12025550147) but tolerates hyphens and spaces for user
+    # convenience.
+    # **Examples:**
+    # - United States: `+13475550100`
+    # - United Kingdom: `+447911123456`
+    # - Brazil: `+5511987654321`
+    # - India: `+919876543210`
+    # - Australia: `+61412345678`
+    # @return [String]
+    attr_accessor :phone_number
+
+    # The consumer’s phone number. The API expects the standard E.164 format
+    # (e.g., +12025550147) but tolerates hyphens and spaces for user
+    # convenience.
+    # **Examples:**
+    # - United States: `+13475550100`
+    # - United Kingdom: `+447911123456`
+    # - Brazil: `+5511987654321`
+    # - India: `+919876543210`
+    # - Australia: `+61412345678`
+    # @return [Address]
+    attr_accessor :address
+
+    # The consumer’s phone number. The API expects the standard E.164 format
+    # (e.g., +12025550147) but tolerates hyphens and spaces for user
+    # convenience.
+    # **Examples:**
+    # - United States: `+13475550100`
+    # - United Kingdom: `+447911123456`
+    # - Brazil: `+5511987654321`
+    # - India: `+919876543210`
+    # - Australia: `+61412345678`
+    # @return [Formation]
+    attr_accessor :formation
+
+    # The Employer Identification Number (EIN) of the business.
+    # @return [String]
+    attr_accessor :ein
+
+    # Additional addresses associated with the business, such as mailing or
+    # branch locations.
+    # @return [Array[Address]]
+    attr_accessor :additional_addresses
+
+    # The website URL of the business.
+    # @return [String]
+    attr_accessor :website_url
+
+    # Represents a monetary amount with its associated currency.
+    # @return [Amount]
+    attr_accessor :last_fiscal_revenue
+
+    # Defines the schema of an bank account.
+    # @return [Account]
+    attr_accessor :account
+
+    # Use this field to send any additional, customer-specific data relevant to
+    # the business evaluation. See [Custom
+    # Fields](https://help.socure.com/riskos/docs/custom-fields) for more
+    # information.
+    # @return [Hash[String, Object]]
+    attr_accessor :custom
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['address'] = 'address'
+      @_hash['formation'] = 'formation'
+      @_hash['ein'] = 'ein'
+      @_hash['additional_addresses'] = 'additional_addresses'
+      @_hash['website_url'] = 'website_url'
+      @_hash['last_fiscal_revenue'] = 'last_fiscal_revenue'
+      @_hash['account'] = 'account'
+      @_hash['custom'] = 'custom'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+        phone_number
+        address
+        formation
+        ein
+        additional_addresses
+        website_url
+        last_fiscal_revenue
+        account
+        custom
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, name: SKIP, phone_number: SKIP, address: SKIP,
+                   formation: SKIP, ein: SKIP, additional_addresses: SKIP,
+                   website_url: SKIP, last_fiscal_revenue: SKIP, account: SKIP,
+                   custom: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @address = address unless address == SKIP
+      @formation = formation unless formation == SKIP
+      @ein = ein unless ein == SKIP
+      @additional_addresses = additional_addresses unless additional_addresses == SKIP
+      @website_url = website_url unless website_url == SKIP
+      @last_fiscal_revenue = last_fiscal_revenue unless last_fiscal_revenue == SKIP
+      @account = account unless account == SKIP
+      @custom = custom unless custom == 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
+      name = hash.key?('name') ? hash['name'] : SKIP
+      phone_number = hash.key?('phone_number') ? hash['phone_number'] : SKIP
+      address = Address.from_hash(hash['address']) if hash['address']
+      formation = Formation.from_hash(hash['formation']) if hash['formation']
+      ein = hash.key?('ein') ? hash['ein'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      additional_addresses = nil
+      unless hash['additional_addresses'].nil?
+        additional_addresses = []
+        hash['additional_addresses'].each do |structure|
+          additional_addresses << (Address.from_hash(structure) if structure)
+        end
+      end
+
+      additional_addresses = SKIP unless hash.key?('additional_addresses')
+      website_url = hash.key?('website_url') ? hash['website_url'] : SKIP
+      last_fiscal_revenue = Amount.from_hash(hash['last_fiscal_revenue']) if
+        hash['last_fiscal_revenue']
+      account = Account.from_hash(hash['account']) if hash['account']
+      custom = hash.key?('custom') ? hash['custom'] : 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.
+      Business.new(id: id,
+                   name: name,
+                   phone_number: phone_number,
+                   address: address,
+                   formation: formation,
+                   ein: ein,
+                   additional_addresses: additional_addresses,
+                   website_url: website_url,
+                   last_fiscal_revenue: last_fiscal_revenue,
+                   account: account,
+                   custom: custom,
+                   additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Business | 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} id: #{@id}, name: #{@name}, phone_number: #{@phone_number}, address:"\
+      " #{@address}, formation: #{@formation}, ein: #{@ein}, additional_addresses:"\
+      " #{@additional_addresses}, website_url: #{@website_url}, last_fiscal_revenue:"\
+      " #{@last_fiscal_revenue}, account: #{@account}, custom: #{@custom}, 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}, name: #{@name.inspect}, phone_number:"\
+      " #{@phone_number.inspect}, address: #{@address.inspect}, formation: #{@formation.inspect},"\
+      " ein: #{@ein.inspect}, additional_addresses: #{@additional_addresses.inspect}, website_url:"\
+      " #{@website_url.inspect}, last_fiscal_revenue: #{@last_fiscal_revenue.inspect}, account:"\
+      " #{@account.inspect}, custom: #{@custom.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/business_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
+  # BusinessOnboarding Model.
+  class BusinessOnboarding < 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 Business Onboarding workflow.
+    # @return [Data6]
+    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 = Data6.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.
+      BusinessOnboarding.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 [BusinessOnboarding | 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) { Data6.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) { Data6.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/channel.rb

@@ -0,0 +1,45 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Specifies the mode of interaction on the consumer's end.  <br /><br />
+  # Available values include: `web`, `mobile`, `pos`, and `other`.
+  class Channel
+    CHANNEL = [
+      # TODO: Write general description for WEB
+      WEB = 'web'.freeze,
+
+      # TODO: Write general description for MOBILE
+      MOBILE = 'mobile'.freeze,
+
+      # TODO: Write general description for POS
+      POS = 'pos'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'other'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CHANNEL.include?(value)
+    end
+
+    def self.from_value(value, default_value = WEB)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'web' then WEB
+      when 'mobile' then MOBILE
+      when 'pos' then POS
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/socure_risk_os_api/models/channel1.rb

@@ -0,0 +1,44 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Mode of interaction on the consumer's end.
+  class Channel1
+    CHANNEL1 = [
+      # TODO: Write general description for WEB
+      WEB = 'web'.freeze,
+
+      # TODO: Write general description for MOBILE
+      MOBILE = 'mobile'.freeze,
+
+      # TODO: Write general description for POS
+      POS = 'pos'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'other'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CHANNEL1.include?(value)
+    end
+
+    def self.from_value(value, default_value = WEB)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'web' then WEB
+      when 'mobile' then MOBILE
+      when 'pos' then POS
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/socure_risk_os_api/models/code.rb

@@ -0,0 +1,68 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # A machine-readable error code for programmatic handling.
+  class Code
+    CODE = [
+      # TODO: Write general description for AUTHENTICATION_FAILED
+      AUTHENTICATION_FAILED = 'AUTHENTICATION_FAILED'.freeze,
+
+      # TODO: Write general description for PERMISSION_DENIED
+      PERMISSION_DENIED = 'PERMISSION_DENIED'.freeze,
+
+      # TODO: Write general description for WORKFLOW_NOT_FOUND
+      WORKFLOW_NOT_FOUND = 'WORKFLOW_NOT_FOUND'.freeze,
+
+      # TODO: Write general description for WORKFLOW_NOT_PUBLISHED
+      WORKFLOW_NOT_PUBLISHED = 'WORKFLOW_NOT_PUBLISHED'.freeze,
+
+      # TODO: Write general description for INVALID_REQUEST
+      INVALID_REQUEST = 'INVALID_REQUEST'.freeze,
+
+      # TODO: Write general description for INVALID_PAYLOAD
+      INVALID_PAYLOAD = 'INVALID_PAYLOAD'.freeze,
+
+      # TODO: Write general description for INVALID_ID
+      INVALID_ID = 'INVALID_ID'.freeze,
+
+      # TODO: Write general description for INVALID_FRAUD_TYPE
+      INVALID_FRAUD_TYPE = 'INVALID_FRAUD_TYPE'.freeze,
+
+      # TODO: Write general description for INTERNAL_ERROR
+      INTERNAL_ERROR = 'INTERNAL_ERROR'.freeze,
+
+      # TODO: Write general description for CUSTOMER_METADATA_TOO_LARGE
+      CUSTOMER_METADATA_TOO_LARGE = 'CUSTOMER_METADATA_TOO_LARGE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CODE.include?(value)
+    end
+
+    def self.from_value(value, default_value = AUTHENTICATION_FAILED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'authentication_failed' then AUTHENTICATION_FAILED
+      when 'permission_denied' then PERMISSION_DENIED
+      when 'workflow_not_found' then WORKFLOW_NOT_FOUND
+      when 'workflow_not_published' then WORKFLOW_NOT_PUBLISHED
+      when 'invalid_request' then INVALID_REQUEST
+      when 'invalid_payload' then INVALID_PAYLOAD
+      when 'invalid_id' then INVALID_ID
+      when 'invalid_fraud_type' then INVALID_FRAUD_TYPE
+      when 'internal_error' then INTERNAL_ERROR
+      when 'customer_metadata_too_large' then CUSTOMER_METADATA_TOO_LARGE
+      else
+        default_value
+      end
+    end
+  end
+end