sc-apimatic-sdk 0.0.1

data/lib/socure_risk_os_api/models/individual6.rb

@@ -0,0 +1,148 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Inputs the configured Age Assurance methods resolve age from.
+  class Individual6 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The consumer's given name. Improves passive identity resolution.
+    # @return [String]
+    attr_accessor :given_name
+
+    # The consumer's family name. Improves passive identity resolution.
+    # @return [String]
+    attr_accessor :family_name
+
+    # The consumer's phone number in E.164 format (e.g., `+12025550147`);
+    # hyphens and spaces are tolerated. Required for phone-based assurance.
+    # @return [String]
+    attr_accessor :phone_number
+
+    # The consumer's email address. Required for email-based assurance.
+    # @return [String]
+    attr_accessor :email
+
+    # The consumer's email address. Required for email-based assurance.
+    # @return [Address]
+    attr_accessor :address
+
+    # The consumer's email address. Required for email-based assurance.
+    # @return [Docv]
+    attr_accessor :docv
+
+    # Device session token captured by the Digital Intelligence SDK. Required
+    # for device-based assurance.
+    # @return [String]
+    attr_accessor :di_session_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['given_name'] = 'given_name'
+      @_hash['family_name'] = 'family_name'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['email'] = 'email'
+      @_hash['address'] = 'address'
+      @_hash['docv'] = 'docv'
+      @_hash['di_session_token'] = 'di_session_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        given_name
+        family_name
+        phone_number
+        email
+        address
+        docv
+        di_session_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(given_name: SKIP, family_name: SKIP, phone_number: SKIP,
+                   email: SKIP, address: SKIP, docv: SKIP,
+                   di_session_token: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @given_name = given_name unless given_name == SKIP
+      @family_name = family_name unless family_name == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @email = email unless email == SKIP
+      @address = address unless address == SKIP
+      @docv = docv unless docv == SKIP
+      @di_session_token = di_session_token unless di_session_token == 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.
+      given_name = hash.key?('given_name') ? hash['given_name'] : SKIP
+      family_name = hash.key?('family_name') ? hash['family_name'] : SKIP
+      phone_number = hash.key?('phone_number') ? hash['phone_number'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      address = Address.from_hash(hash['address']) if hash['address']
+      docv = Docv.from_hash(hash['docv']) if hash['docv']
+      di_session_token =
+        hash.key?('di_session_token') ? hash['di_session_token'] : 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.
+      Individual6.new(given_name: given_name,
+                      family_name: family_name,
+                      phone_number: phone_number,
+                      email: email,
+                      address: address,
+                      docv: docv,
+                      di_session_token: di_session_token,
+                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Individual6 | 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} given_name: #{@given_name}, family_name: #{@family_name}, phone_number:"\
+      " #{@phone_number}, email: #{@email}, address: #{@address}, docv: #{@docv},"\
+      " di_session_token: #{@di_session_token}, 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} given_name: #{@given_name.inspect}, family_name: #{@family_name.inspect},"\
+      " phone_number: #{@phone_number.inspect}, email: #{@email.inspect}, address:"\
+      " #{@address.inspect}, docv: #{@docv.inspect}, di_session_token:"\
+      " #{@di_session_token.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/input.rb

@@ -0,0 +1,86 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # The original input data submitted with the evaluation request. Only returned
+  # when the `include_input` query parameter is set to `true`.
+  class Input < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The input data as submitted.
+    # @return [Object]
+    attr_accessor :data
+
+    # The input data after any transformations applied by the workflow.
+    # @return [Object]
+    attr_accessor :updated_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['updated_data'] = 'updated_data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data
+        updated_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data: SKIP, updated_data: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @data = data unless data == SKIP
+      @updated_data = updated_data unless updated_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.
+      data = hash.key?('data') ? hash['data'] : SKIP
+      updated_data = hash.key?('updated_data') ? hash['updated_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.
+      Input.new(data: data,
+                updated_data: updated_data,
+                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} data: #{@data}, updated_data: #{@updated_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} data: #{@data.inspect}, updated_data: #{@updated_data.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/inquiry.rb

@@ -0,0 +1,36 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Inquiry.
+  class Inquiry
+    INQUIRY = [
+      # TODO: Write general description for AVAILABILITY
+      AVAILABILITY = 'AVAILABILITY'.freeze,
+
+      # TODO: Write general description for OWNERSHIP
+      OWNERSHIP = 'OWNERSHIP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INQUIRY.include?(value)
+    end
+
+    def self.from_value(value, default_value = AVAILABILITY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'availability' then AVAILABILITY
+      when 'ownership' then OWNERSHIP
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/socure_risk_os_api/models/invalid_arg.rb

@@ -0,0 +1,85 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # InvalidArg Model.
+  class InvalidArg < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the invalid field.
+    # @return [String]
+    attr_accessor :field
+
+    # An explanation of why the field is invalid.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['field'] = 'field'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        field
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(field: SKIP, description: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @field = field unless field == SKIP
+      @description = description unless description == 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.
+      field = hash.key?('field') ? hash['field'] : SKIP
+      description = hash.key?('description') ? hash['description'] : 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.
+      InvalidArg.new(field: field,
+                     description: description,
+                     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} field: #{@field}, description: #{@description}, 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} field: #{@field.inspect}, description: #{@description.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/language.rb

@@ -0,0 +1,247 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Specifies the language package for the Capture App. Below are the possible
+  # values. - Automatic (device default): `auto` - Arabic: `ar` - Arabic (Saudi
+  # Arabia): `ar-sa` - Armenian: `hy` - Bengali: `bn` - Chinese (Hong Kong):
+  # `zh-hk` - Chinese (Simplified): `zh-cn` - Chinese (Traditional): `zh-tw` -
+  # Czech: `cs-cz` - Danish: `da-dk` - Dutch: `nl-nl` - English: `en` - English
+  # (Australian): `en-au` - English (Canadian): `en-ca` - English (United
+  # Kingdom): `en-gb` - English (United States): `en-us` - Finnish: `fi-fi` -
+  # French: `fr` - French (Canada): `fr-ca` - German: `de-de` - Haitian Creole:
+  # `ht` - Hebrew: `he-il` - Hindi: `hi-in` - Hungarian: `hu-hu` - Indonesian:
+  # `id-id` - Italian: `it` - Italian (Switzerland): `it-ch` - Japanese: `ja-jp`
+  # - Korean: `ko` - Malay: `ms-my` - Norwegian: `no-no` - Polish: `pl-pl` -
+  # Portuguese (Brazil): `pt-br` - Portuguese (Portugal): `pt-pt` - Romanian
+  # (Moldova): `ro-mo` - Romanian (Romania): `ro-ro` - Russian: `ru` - Slovak:
+  # `sk-sk` - Spanish: `es` - Spanish (Argentina): `es-ar` - Spanish
+  # (International): `es-001` - Spanish (Mexico): `es-mx` - Spanish (Spain):
+  # `es-es` - Spanish (US): `es-us` - Swedish: `sv-se` - Tagalog: `tl` - Thai:
+  # `th-th` - Turkish: `tr-tr` - Urdu: `ur` - Vietnamese: `vi` Set `language` to
+  # `auto` to use the consumer's device default language. If the device's
+  # default language isn't supported, the Capture App defaults to English
+  # (`en`).
+  class Language
+    LANGUAGE = [
+      # TODO: Write general description for AUTO
+      AUTO = 'auto'.freeze,
+
+      # TODO: Write general description for AR
+      AR = 'ar'.freeze,
+
+      # TODO: Write general description for ARSA
+      ARSA = 'ar-sa'.freeze,
+
+      # TODO: Write general description for BN
+      BN = 'bn'.freeze,
+
+      # TODO: Write general description for CSCZ
+      CSCZ = 'cs-cz'.freeze,
+
+      # TODO: Write general description for DADK
+      DADK = 'da-dk'.freeze,
+
+      # TODO: Write general description for DEDE
+      DEDE = 'de-de'.freeze,
+
+      # TODO: Write general description for EN
+      EN = 'en'.freeze,
+
+      # TODO: Write general description for ENAU
+      ENAU = 'en-au'.freeze,
+
+      # TODO: Write general description for ENCA
+      ENCA = 'en-ca'.freeze,
+
+      # TODO: Write general description for ENGB
+      ENGB = 'en-gb'.freeze,
+
+      # TODO: Write general description for ENUS
+      ENUS = 'en-us'.freeze,
+
+      # TODO: Write general description for ES
+      ES = 'es'.freeze,
+
+      # TODO: Write general description for ES001
+      ES001 = 'es-001'.freeze,
+
+      # TODO: Write general description for ESAR
+      ESAR = 'es-ar'.freeze,
+
+      # TODO: Write general description for ESES
+      ESES = 'es-es'.freeze,
+
+      # TODO: Write general description for ESMX
+      ESMX = 'es-mx'.freeze,
+
+      # TODO: Write general description for ESUS
+      ESUS = 'es-us'.freeze,
+
+      # TODO: Write general description for FIFI
+      FIFI = 'fi-fi'.freeze,
+
+      # TODO: Write general description for FR
+      FR = 'fr'.freeze,
+
+      # TODO: Write general description for FRCA
+      FRCA = 'fr-ca'.freeze,
+
+      # TODO: Write general description for HEIL
+      HEIL = 'he-il'.freeze,
+
+      # TODO: Write general description for HIIN
+      HIIN = 'hi-in'.freeze,
+
+      # TODO: Write general description for HT
+      HT = 'ht'.freeze,
+
+      # TODO: Write general description for HUHU
+      HUHU = 'hu-hu'.freeze,
+
+      # TODO: Write general description for HY
+      HY = 'hy'.freeze,
+
+      # TODO: Write general description for IDID
+      IDID = 'id-id'.freeze,
+
+      # TODO: Write general description for IT
+      IT = 'it'.freeze,
+
+      # TODO: Write general description for ITCH
+      ITCH = 'it-ch'.freeze,
+
+      # TODO: Write general description for JAJP
+      JAJP = 'ja-jp'.freeze,
+
+      # TODO: Write general description for KO
+      KO = 'ko'.freeze,
+
+      # TODO: Write general description for MSMY
+      MSMY = 'ms-my'.freeze,
+
+      # TODO: Write general description for NLNL
+      NLNL = 'nl-nl'.freeze,
+
+      # TODO: Write general description for NONO
+      NONO = 'no-no'.freeze,
+
+      # TODO: Write general description for PLPL
+      PLPL = 'pl-pl'.freeze,
+
+      # TODO: Write general description for PTBR
+      PTBR = 'pt-br'.freeze,
+
+      # TODO: Write general description for PTPT
+      PTPT = 'pt-pt'.freeze,
+
+      # TODO: Write general description for ROMO
+      ROMO = 'ro-mo'.freeze,
+
+      # TODO: Write general description for RORO
+      RORO = 'ro-ro'.freeze,
+
+      # TODO: Write general description for RU
+      RU = 'ru'.freeze,
+
+      # TODO: Write general description for SKSK
+      SKSK = 'sk-sk'.freeze,
+
+      # TODO: Write general description for SVSE
+      SVSE = 'sv-se'.freeze,
+
+      # TODO: Write general description for THTH
+      THTH = 'th-th'.freeze,
+
+      # TODO: Write general description for TL
+      TL = 'tl'.freeze,
+
+      # TODO: Write general description for TRTR
+      TRTR = 'tr-tr'.freeze,
+
+      # TODO: Write general description for UR
+      UR = 'ur'.freeze,
+
+      # TODO: Write general description for VI
+      VI = 'vi'.freeze,
+
+      # TODO: Write general description for ZHCN
+      ZHCN = 'zh-cn'.freeze,
+
+      # TODO: Write general description for ZHHK
+      ZHHK = 'zh-hk'.freeze,
+
+      # TODO: Write general description for ZHTW
+      ZHTW = 'zh-tw'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LANGUAGE.include?(value)
+    end
+
+    def self.from_value(value, default_value = AUTO)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'auto' then AUTO
+      when 'ar' then AR
+      when 'arsa' then ARSA
+      when 'bn' then BN
+      when 'cscz' then CSCZ
+      when 'dadk' then DADK
+      when 'dede' then DEDE
+      when 'en' then EN
+      when 'enau' then ENAU
+      when 'enca' then ENCA
+      when 'engb' then ENGB
+      when 'enus' then ENUS
+      when 'es' then ES
+      when 'es001' then ES001
+      when 'esar' then ESAR
+      when 'eses' then ESES
+      when 'esmx' then ESMX
+      when 'esus' then ESUS
+      when 'fifi' then FIFI
+      when 'fr' then FR
+      when 'frca' then FRCA
+      when 'heil' then HEIL
+      when 'hiin' then HIIN
+      when 'ht' then HT
+      when 'huhu' then HUHU
+      when 'hy' then HY
+      when 'idid' then IDID
+      when 'it' then IT
+      when 'itch' then ITCH
+      when 'jajp' then JAJP
+      when 'ko' then KO
+      when 'msmy' then MSMY
+      when 'nlnl' then NLNL
+      when 'nono' then NONO
+      when 'plpl' then PLPL
+      when 'ptbr' then PTBR
+      when 'ptpt' then PTPT
+      when 'romo' then ROMO
+      when 'roro' then RORO
+      when 'ru' then RU
+      when 'sksk' then SKSK
+      when 'svse' then SVSE
+      when 'thth' then THTH
+      when 'tl' then TL
+      when 'trtr' then TRTR
+      when 'ur' then UR
+      when 'vi' then VI
+      when 'zhcn' then ZHCN
+      when 'zhhk' then ZHHK
+      when 'zhtw' then ZHTW
+      else
+        default_value
+      end
+    end
+  end
+end