sc-apimatic-sdk 0.0.1

data/lib/socure_risk_os_api/models/reason_code.rb

@@ -0,0 +1,149 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # ReasonCode Model.
+  class ReasonCode < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason code identifier.
+    # @return [String]
+    attr_accessor :name
+
+    # The provider that produces the code.
+    # @return [String]
+    attr_accessor :provider
+
+    # Human-readable explanation of the signal.
+    # @return [String]
+    attr_accessor :description
+
+    # The product the code belongs to. Omitted when the code is not
+    # product-specific.
+    # @return [String]
+    attr_accessor :product
+
+    # Whether the code is currently in use.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_active
+
+    # The date the code was released (`YYYY-MM-DD`), when available.
+    # @return [Date]
+    attr_accessor :release_date
+
+    # The date the code was deprecated (`YYYY-MM-DD`), when applicable.
+    # @return [Date]
+    attr_accessor :deprecated_date
+
+    # Supplementary guidance for the code, when available.
+    # @return [String]
+    attr_accessor :additional_note
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['provider'] = 'provider'
+      @_hash['description'] = 'description'
+      @_hash['product'] = 'product'
+      @_hash['is_active'] = 'isActive'
+      @_hash['release_date'] = 'releaseDate'
+      @_hash['deprecated_date'] = 'deprecatedDate'
+      @_hash['additional_note'] = 'additionalNote'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        provider
+        description
+        product
+        is_active
+        release_date
+        deprecated_date
+        additional_note
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, provider: SKIP, description: SKIP, product: SKIP,
+                   is_active: SKIP, release_date: SKIP, deprecated_date: SKIP,
+                   additional_note: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @provider = provider unless provider == SKIP
+      @description = description unless description == SKIP
+      @product = product unless product == SKIP
+      @is_active = is_active unless is_active == SKIP
+      @release_date = release_date unless release_date == SKIP
+      @deprecated_date = deprecated_date unless deprecated_date == SKIP
+      @additional_note = additional_note unless additional_note == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      provider = hash.key?('provider') ? hash['provider'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      product = hash.key?('product') ? hash['product'] : SKIP
+      is_active = hash.key?('isActive') ? hash['isActive'] : SKIP
+      release_date = hash.key?('releaseDate') ? hash['releaseDate'] : SKIP
+      deprecated_date =
+        hash.key?('deprecatedDate') ? hash['deprecatedDate'] : SKIP
+      additional_note =
+        hash.key?('additionalNote') ? hash['additionalNote'] : 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.
+      ReasonCode.new(name: name,
+                     provider: provider,
+                     description: description,
+                     product: product,
+                     is_active: is_active,
+                     release_date: release_date,
+                     deprecated_date: deprecated_date,
+                     additional_note: additional_note,
+                     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} name: #{@name}, provider: #{@provider}, description: #{@description},"\
+      " product: #{@product}, is_active: #{@is_active}, release_date: #{@release_date},"\
+      " deprecated_date: #{@deprecated_date}, additional_note: #{@additional_note},"\
+      " 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} name: #{@name.inspect}, provider: #{@provider.inspect}, description:"\
+      " #{@description.inspect}, product: #{@product.inspect}, is_active: #{@is_active.inspect},"\
+      " release_date: #{@release_date.inspect}, deprecated_date: #{@deprecated_date.inspect},"\
+      " additional_note: #{@additional_note.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/redirect.rb

@@ -0,0 +1,118 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Optional URL settings that redirect the consumer after the document capture
+  # and upload process is cancelled or completed on the Capture App.
+  class Redirect < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Specifies the redirect destination URL.
+    # > **Note**: This field is required if `redirect` is provided.
+    # @return [String]
+    attr_accessor :url
+
+    # The redirect method.
+    # > **Note**: This field is required if `redirect` is provided.
+    # @return [Method]
+    attr_accessor :method
+
+    # Specifies an optional object where you can define custom headers.
+    # @return [Object]
+    attr_accessor :headers
+
+    # Adds a delay before redirecting, specified in milliseconds.
+    # @return [Float]
+    attr_accessor :delay
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['url'] = 'url'
+      @_hash['method'] = 'method'
+      @_hash['headers'] = 'headers'
+      @_hash['delay'] = 'delay'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        url
+        method
+        headers
+        delay
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(url: SKIP, method: Method::POST, headers: SKIP, delay: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @url = url unless url == SKIP
+      @method = method unless method == SKIP
+      @headers = headers unless headers == SKIP
+      @delay = delay unless delay == 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.
+      url = hash.key?('url') ? hash['url'] : SKIP
+      method = hash['method'] ||= Method::POST
+      headers = hash.key?('headers') ? hash['headers'] : SKIP
+      delay = hash.key?('delay') ? hash['delay'] : 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.
+      Redirect.new(url: url,
+                   method: method,
+                   headers: headers,
+                   delay: delay,
+                   additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Redirect | 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} url: #{@url}, method: #{@method}, headers: #{@headers}, delay: #{@delay},"\
+      " 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} url: #{@url.inspect}, method: #{@method.inspect}, headers:"\
+      " #{@headers.inspect}, delay: #{@delay.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/response.rb

@@ -0,0 +1,77 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # The data returned from the enrichment provider.
+  class Response < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier assigned to each enrichment after a RiskOS™ workflow is
+    # finalized.
+    # @return [String]
+    attr_accessor :reference_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reference_id'] = 'referenceId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reference_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reference_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @reference_id = reference_id unless reference_id == 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.
+      reference_id = hash.key?('referenceId') ? hash['referenceId'] : 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.
+      Response.new(reference_id: reference_id,
+                   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}, 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}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/source.rb

@@ -0,0 +1,146 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Source party information.
+  class Source < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount in minor currency units.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # ISO 4217 currency code for the amount.
+    # @return [String]
+    attr_accessor :currency
+
+    # Mode of interaction on the consumer's end.
+    # @return [Channel1]
+    attr_accessor :channel
+
+    # Consumer IP address in IPv4 or IPv6 format.
+    # @return [String]
+    attr_accessor :ip_address
+
+    # Individual party details for Payment Screening.
+    # @return [PaymentScreeningIndividual]
+    attr_accessor :individual
+
+    # Business party details for Payment Screening.
+    # @return [PaymentScreeningBusiness]
+    attr_accessor :business
+
+    # Use this field to provide external device data, e.g. originating from a
+    # third party data intelligence provider.
+    # @return [Device]
+    attr_accessor :external_device
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['channel'] = 'channel'
+      @_hash['ip_address'] = 'ip_address'
+      @_hash['individual'] = 'individual'
+      @_hash['business'] = 'business'
+      @_hash['external_device'] = 'external_device'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        currency
+        channel
+        ip_address
+        individual
+        business
+        external_device
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount: SKIP, currency: SKIP, channel: SKIP,
+                   ip_address: SKIP, individual: SKIP, business: SKIP,
+                   external_device: 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
+      @channel = channel unless channel == SKIP
+      @ip_address = ip_address unless ip_address == SKIP
+      @individual = individual unless individual == SKIP
+      @business = business unless business == SKIP
+      @external_device = external_device unless external_device == 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
+      channel = hash.key?('channel') ? hash['channel'] : SKIP
+      ip_address = hash.key?('ip_address') ? hash['ip_address'] : SKIP
+      individual = PaymentScreeningIndividual.from_hash(hash['individual']) if hash['individual']
+      business = PaymentScreeningBusiness.from_hash(hash['business']) if hash['business']
+      external_device = Device.from_hash(hash['external_device']) if hash['external_device']
+
+      # 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.
+      Source.new(amount: amount,
+                 currency: currency,
+                 channel: channel,
+                 ip_address: ip_address,
+                 individual: individual,
+                 business: business,
+                 external_device: external_device,
+                 additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Source | 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}, channel: #{@channel},"\
+      " ip_address: #{@ip_address}, individual: #{@individual}, business: #{@business},"\
+      " external_device: #{@external_device}, 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}, channel:"\
+      " #{@channel.inspect}, ip_address: #{@ip_address.inspect}, individual:"\
+      " #{@individual.inspect}, business: #{@business.inspect}, external_device:"\
+      " #{@external_device.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/status.rb

@@ -0,0 +1,40 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Case-level status of the evaluation.
+  class Status
+    STATUS = [
+      # TODO: Write general description for OPEN
+      OPEN = 'OPEN'.freeze,
+
+      # TODO: Write general description for ON_HOLD
+      ON_HOLD = 'ON_HOLD'.freeze,
+
+      # TODO: Write general description for CLOSED
+      CLOSED = 'CLOSED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = OPEN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'open' then OPEN
+      when 'on_hold' then ON_HOLD
+      when 'closed' then CLOSED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/socure_risk_os_api/models/status1.rb

@@ -0,0 +1,40 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # The new status to apply.
+  class Status1
+    STATUS1 = [
+      # TODO: Write general description for OPEN
+      OPEN = 'OPEN'.freeze,
+
+      # TODO: Write general description for CLOSED
+      CLOSED = 'CLOSED'.freeze,
+
+      # TODO: Write general description for ON_HOLD
+      ON_HOLD = 'ON_HOLD'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS1.include?(value)
+    end
+
+    def self.from_value(value, default_value = OPEN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'open' then OPEN
+      when 'closed' then CLOSED
+      when 'on_hold' then ON_HOLD
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/socure_risk_os_api/models/transaction_details.rb

@@ -0,0 +1,97 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Transaction detail fields.
+  class TransactionDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Short transaction description.
+    # @return [String]
+    attr_accessor :memo
+
+    # Descriptor that may appear on bank statements.
+    # @return [String]
+    attr_accessor :statement_descriptor
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['memo'] = 'memo'
+      @_hash['statement_descriptor'] = 'statement_descriptor'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        memo
+        statement_descriptor
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(memo: SKIP, statement_descriptor: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @memo = memo unless memo == SKIP
+      @statement_descriptor = statement_descriptor unless statement_descriptor == 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.
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      statement_descriptor =
+        hash.key?('statement_descriptor') ? hash['statement_descriptor'] : 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.
+      TransactionDetails.new(memo: memo,
+                             statement_descriptor: statement_descriptor,
+                             additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TransactionDetails | 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} memo: #{@memo}, statement_descriptor: #{@statement_descriptor},"\
+      " 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} memo: #{@memo.inspect}, statement_descriptor:"\
+      " #{@statement_descriptor.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end