sc-apimatic-sdk 0.0.1

data/lib/socure_risk_os_api/models/individual.rb

@@ -0,0 +1,281 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Represents core information about the primary individual consumer.
+  class Individual < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Maps to the `userId` in  enrichments or a customer’s internal identifier.
+    # Can be enabled as a searchable field in RiskOS™ Dashboard.
+    # @return [String]
+    attr_accessor :id
+
+    # The consumer's given name.
+    # **Requirements:**
+    # - Must be UTF-8 encoded
+    # - Supports single-byte Latin characters only
+    # - The following special characters are not supported:
+    #   ^ ± ! @ £ $ % & * _ + ¡ € # ¢ § ¶ • ª º « < > ? \ / : ; | =
+    # @return [String]
+    attr_accessor :given_name
+
+    # The consumer's family name.
+    # **Requirements:**
+    # - Must be UTF-8 encoded
+    # - Supports single-byte Latin characters only
+    # - The following special characters are not supported:
+    #   ^ ± ! @ £ $ % & * _ + ¡ € # ¢ § ¶ • ª º « < > ? \ / : ; | =
+    # @return [String]
+    attr_accessor :family_name
+
+    # A suffix for the consumer's name, if applicable (e.g., Jr., Sr., III).
+    # @return [String]
+    attr_accessor :suffix
+
+    # The consumer's national identification number. For US consumers, this can
+    # be a nine-digit Social Security Number (SSN) or Individual Tax
+    # Identification Number (ITIN). Partial SSNs (last four digits) are also
+    # accepted. Hyphens are optional.
+    # @return [String]
+    attr_accessor :national_id
+
+    # The consumer's date of birth in the format YYYY-MM-DD, compliant with RFC
+    # 3339.
+    # @return [Date]
+    attr_accessor :date_of_birth
+
+    # The consumer's email address.
+    # @return [String]
+    attr_accessor :email
+
+    # The consumer's alternate email address.
+    # @return [String]
+    attr_accessor :alternate_email
+
+    # 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 alternate phone number. The API accepts E.164 format (e.g.,
+    # `+12025550147`) but tolerates hyphens and spaces for user convenience.
+    # @return [String]
+    attr_accessor :alternate_phone_number
+
+    # The consumer's gender.
+    # @return [Gender]
+    attr_accessor :gender
+
+    # The consumer's gender.
+    # @return [Address]
+    attr_accessor :address
+
+    # Defines the schema of an bank account.
+    # @return [Account]
+    attr_accessor :account
+
+    # Defines the schema of an bank account.
+    # @return [Docv]
+    attr_accessor :docv
+
+    # Use this field to pass additional data required by specific Socure
+    # products. Additional fields are typically optional and should only be used
+    # if explicitly stated in the product documentation.
+    # @return [AdditionalContext]
+    attr_accessor :additional_context
+
+    # Token required to extract Device Intelligence (DI) signals.
+    # @return [String]
+    attr_accessor :di_session_token
+
+    # Send any additional, customer-specific data for this consumer in this
+    # field. See [Custom
+    # Fields](https://help.socure.com/riskos/docs/custom-fields) for more
+    # information.
+    # @return [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['given_name'] = 'given_name'
+      @_hash['family_name'] = 'family_name'
+      @_hash['suffix'] = 'suffix'
+      @_hash['national_id'] = 'national_id'
+      @_hash['date_of_birth'] = 'date_of_birth'
+      @_hash['email'] = 'email'
+      @_hash['alternate_email'] = 'alternate_email'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['alternate_phone_number'] = 'alternate_phone_number'
+      @_hash['gender'] = 'gender'
+      @_hash['address'] = 'address'
+      @_hash['account'] = 'account'
+      @_hash['docv'] = 'docv'
+      @_hash['additional_context'] = 'additional_context'
+      @_hash['di_session_token'] = 'di_session_token'
+      @_hash['custom'] = 'custom'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        given_name
+        family_name
+        suffix
+        national_id
+        date_of_birth
+        email
+        alternate_email
+        phone_number
+        alternate_phone_number
+        gender
+        address
+        account
+        docv
+        additional_context
+        di_session_token
+        custom
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, given_name: SKIP, family_name: SKIP, suffix: SKIP,
+                   national_id: SKIP, date_of_birth: SKIP, email: SKIP,
+                   alternate_email: SKIP, phone_number: SKIP,
+                   alternate_phone_number: SKIP, gender: SKIP, address: SKIP,
+                   account: SKIP, docv: SKIP, additional_context: SKIP,
+                   di_session_token: SKIP, custom: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @given_name = given_name unless given_name == SKIP
+      @family_name = family_name unless family_name == SKIP
+      @suffix = suffix unless suffix == SKIP
+      @national_id = national_id unless national_id == SKIP
+      @date_of_birth = date_of_birth unless date_of_birth == SKIP
+      @email = email unless email == SKIP
+      @alternate_email = alternate_email unless alternate_email == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @alternate_phone_number = alternate_phone_number unless alternate_phone_number == SKIP
+      @gender = gender unless gender == SKIP
+      @address = address unless address == SKIP
+      @account = account unless account == SKIP
+      @docv = docv unless docv == SKIP
+      @additional_context = additional_context unless additional_context == SKIP
+      @di_session_token = di_session_token unless di_session_token == 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
+      given_name = hash.key?('given_name') ? hash['given_name'] : SKIP
+      family_name = hash.key?('family_name') ? hash['family_name'] : SKIP
+      suffix = hash.key?('suffix') ? hash['suffix'] : SKIP
+      national_id = hash.key?('national_id') ? hash['national_id'] : SKIP
+      date_of_birth = hash.key?('date_of_birth') ? hash['date_of_birth'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      alternate_email =
+        hash.key?('alternate_email') ? hash['alternate_email'] : SKIP
+      phone_number = hash.key?('phone_number') ? hash['phone_number'] : SKIP
+      alternate_phone_number =
+        hash.key?('alternate_phone_number') ? hash['alternate_phone_number'] : SKIP
+      gender = hash.key?('gender') ? hash['gender'] : SKIP
+      address = Address.from_hash(hash['address']) if hash['address']
+      account = Account.from_hash(hash['account']) if hash['account']
+      docv = Docv.from_hash(hash['docv']) if hash['docv']
+      additional_context = AdditionalContext.from_hash(hash['additional_context']) if
+        hash['additional_context']
+      di_session_token =
+        hash.key?('di_session_token') ? hash['di_session_token'] : SKIP
+      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.
+      Individual.new(id: id,
+                     given_name: given_name,
+                     family_name: family_name,
+                     suffix: suffix,
+                     national_id: national_id,
+                     date_of_birth: date_of_birth,
+                     email: email,
+                     alternate_email: alternate_email,
+                     phone_number: phone_number,
+                     alternate_phone_number: alternate_phone_number,
+                     gender: gender,
+                     address: address,
+                     account: account,
+                     docv: docv,
+                     additional_context: additional_context,
+                     di_session_token: di_session_token,
+                     custom: custom,
+                     additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Individual | 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}, given_name: #{@given_name}, family_name: #{@family_name},"\
+      " suffix: #{@suffix}, national_id: #{@national_id}, date_of_birth: #{@date_of_birth}, email:"\
+      " #{@email}, alternate_email: #{@alternate_email}, phone_number: #{@phone_number},"\
+      " alternate_phone_number: #{@alternate_phone_number}, gender: #{@gender}, address:"\
+      " #{@address}, account: #{@account}, docv: #{@docv}, additional_context:"\
+      " #{@additional_context}, di_session_token: #{@di_session_token}, 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}, given_name: #{@given_name.inspect}, family_name:"\
+      " #{@family_name.inspect}, suffix: #{@suffix.inspect}, national_id: #{@national_id.inspect},"\
+      " date_of_birth: #{@date_of_birth.inspect}, email: #{@email.inspect}, alternate_email:"\
+      " #{@alternate_email.inspect}, phone_number: #{@phone_number.inspect},"\
+      " alternate_phone_number: #{@alternate_phone_number.inspect}, gender: #{@gender.inspect},"\
+      " address: #{@address.inspect}, account: #{@account.inspect}, docv: #{@docv.inspect},"\
+      " additional_context: #{@additional_context.inspect}, di_session_token:"\
+      " #{@di_session_token.inspect}, custom: #{@custom.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/individual1.rb

@@ -0,0 +1,292 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Represents core information about the primary consumer.
+  class Individual1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique identifier for a consumer provided by the customer, used across
+    # various use cases.
+    # @return [String]
+    attr_accessor :id
+
+    # The consumer's given name.
+    # **Requirements:**
+    # - Must be UTF-8 encoded
+    # - Supports single-byte Latin characters only
+    # - The following special characters are not supported:
+    #   ^ ± ! @ £ $ % & * _ + ¡ € # ¢ § ¶ • ª º « < > ? \ / : ; | =
+    # @return [String]
+    attr_accessor :given_name
+
+    # The consumer's family name.
+    # **Requirements:**
+    # - Must be UTF-8 encoded
+    # - Supports single-byte Latin characters only
+    # - The following special characters are not supported:
+    #   ^ ± ! @ £ $ % & * _ + ¡ € # ¢ § ¶ • ª º « < > ? \ / : ; | =
+    # @return [String]
+    attr_accessor :family_name
+
+    # A suffix for the consumer's name, if applicable (e.g., Jr., Sr., III).
+    # @return [String]
+    attr_accessor :suffix
+
+    # The consumer's national identification number. For US consumer's, this can
+    # be a nine-digit Social Security Number (SSN) or Individual Tax
+    # Identification Number (ITIN). Partial SSNs (last four digits) are also
+    # accepted. Hyphens are optional.
+    # @return [String]
+    attr_accessor :national_id
+
+    # The consumer's date of birth in the format YYYY-MM-DD, compliant with RFC
+    # 3339.
+    # @return [Date]
+    attr_accessor :date_of_birth
+
+    # The consumer's email address.
+    # @return [String]
+    attr_accessor :email
+
+    # The consumer's alternate email address.
+    # @return [String]
+    attr_accessor :alternate_email
+
+    # 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 in E.164 format, which includes the country
+    # code (e.g., `+` followed by international dialing code and number). The
+    # API expects the standard E.164 format but tolerates hyphens and spaces for
+    # user convenience.
+    # @return [String]
+    attr_accessor :alternate_phone_number
+
+    # The consumer's gender.
+    # @return [Gender]
+    attr_accessor :gender
+
+    # The consumer's gender.
+    # @return [Address]
+    attr_accessor :address
+
+    # Defines the schema of an bank account.
+    # @return [Account]
+    attr_accessor :account
+
+    # Defines the schema of an bank account.
+    # @return [Docv]
+    attr_accessor :docv
+
+    # Contains the OTP data for the transaction.
+    # @return [Otp]
+    attr_accessor :otp
+
+    # Use this field to pass additional data required by specific Socure
+    # products. Additional fields are typically optional and should only be used
+    # if explicitly stated in the product documentation.
+    # @return [AdditionalContext]
+    attr_accessor :additional_context
+
+    # Token required to extract Device Intelligence (DI) signals.
+    # @return [String]
+    attr_accessor :di_session_token
+
+    # Send any additional, customer-specific data for this consumer in this
+    # field. See [Custom
+    # Fields](https://help.socure.com/riskos/docs/custom-fields) for more
+    # information.
+    # @return [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['given_name'] = 'given_name'
+      @_hash['family_name'] = 'family_name'
+      @_hash['suffix'] = 'suffix'
+      @_hash['national_id'] = 'national_id'
+      @_hash['date_of_birth'] = 'date_of_birth'
+      @_hash['email'] = 'email'
+      @_hash['alternate_email'] = 'alternate_email'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['alternate_phone_number'] = 'alternate_phone_number'
+      @_hash['gender'] = 'gender'
+      @_hash['address'] = 'address'
+      @_hash['account'] = 'account'
+      @_hash['docv'] = 'docv'
+      @_hash['otp'] = 'otp'
+      @_hash['additional_context'] = 'additional_context'
+      @_hash['di_session_token'] = 'di_session_token'
+      @_hash['custom'] = 'custom'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        given_name
+        family_name
+        suffix
+        national_id
+        date_of_birth
+        email
+        alternate_email
+        phone_number
+        alternate_phone_number
+        gender
+        address
+        account
+        docv
+        otp
+        additional_context
+        di_session_token
+        custom
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, given_name: SKIP, family_name: SKIP, suffix: SKIP,
+                   national_id: SKIP, date_of_birth: SKIP, email: SKIP,
+                   alternate_email: SKIP, phone_number: SKIP,
+                   alternate_phone_number: SKIP, gender: SKIP, address: SKIP,
+                   account: SKIP, docv: SKIP, otp: SKIP,
+                   additional_context: SKIP, di_session_token: SKIP,
+                   custom: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @given_name = given_name unless given_name == SKIP
+      @family_name = family_name unless family_name == SKIP
+      @suffix = suffix unless suffix == SKIP
+      @national_id = national_id unless national_id == SKIP
+      @date_of_birth = date_of_birth unless date_of_birth == SKIP
+      @email = email unless email == SKIP
+      @alternate_email = alternate_email unless alternate_email == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @alternate_phone_number = alternate_phone_number unless alternate_phone_number == SKIP
+      @gender = gender unless gender == SKIP
+      @address = address unless address == SKIP
+      @account = account unless account == SKIP
+      @docv = docv unless docv == SKIP
+      @otp = otp unless otp == SKIP
+      @additional_context = additional_context unless additional_context == SKIP
+      @di_session_token = di_session_token unless di_session_token == 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
+      given_name = hash.key?('given_name') ? hash['given_name'] : SKIP
+      family_name = hash.key?('family_name') ? hash['family_name'] : SKIP
+      suffix = hash.key?('suffix') ? hash['suffix'] : SKIP
+      national_id = hash.key?('national_id') ? hash['national_id'] : SKIP
+      date_of_birth = hash.key?('date_of_birth') ? hash['date_of_birth'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      alternate_email =
+        hash.key?('alternate_email') ? hash['alternate_email'] : SKIP
+      phone_number = hash.key?('phone_number') ? hash['phone_number'] : SKIP
+      alternate_phone_number =
+        hash.key?('alternate_phone_number') ? hash['alternate_phone_number'] : SKIP
+      gender = hash.key?('gender') ? hash['gender'] : SKIP
+      address = Address.from_hash(hash['address']) if hash['address']
+      account = Account.from_hash(hash['account']) if hash['account']
+      docv = Docv.from_hash(hash['docv']) if hash['docv']
+      otp = Otp.from_hash(hash['otp']) if hash['otp']
+      additional_context = AdditionalContext.from_hash(hash['additional_context']) if
+        hash['additional_context']
+      di_session_token =
+        hash.key?('di_session_token') ? hash['di_session_token'] : SKIP
+      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.
+      Individual1.new(id: id,
+                      given_name: given_name,
+                      family_name: family_name,
+                      suffix: suffix,
+                      national_id: national_id,
+                      date_of_birth: date_of_birth,
+                      email: email,
+                      alternate_email: alternate_email,
+                      phone_number: phone_number,
+                      alternate_phone_number: alternate_phone_number,
+                      gender: gender,
+                      address: address,
+                      account: account,
+                      docv: docv,
+                      otp: otp,
+                      additional_context: additional_context,
+                      di_session_token: di_session_token,
+                      custom: custom,
+                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Individual1 | 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}, given_name: #{@given_name}, family_name: #{@family_name},"\
+      " suffix: #{@suffix}, national_id: #{@national_id}, date_of_birth: #{@date_of_birth}, email:"\
+      " #{@email}, alternate_email: #{@alternate_email}, phone_number: #{@phone_number},"\
+      " alternate_phone_number: #{@alternate_phone_number}, gender: #{@gender}, address:"\
+      " #{@address}, account: #{@account}, docv: #{@docv}, otp: #{@otp}, additional_context:"\
+      " #{@additional_context}, di_session_token: #{@di_session_token}, 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}, given_name: #{@given_name.inspect}, family_name:"\
+      " #{@family_name.inspect}, suffix: #{@suffix.inspect}, national_id: #{@national_id.inspect},"\
+      " date_of_birth: #{@date_of_birth.inspect}, email: #{@email.inspect}, alternate_email:"\
+      " #{@alternate_email.inspect}, phone_number: #{@phone_number.inspect},"\
+      " alternate_phone_number: #{@alternate_phone_number.inspect}, gender: #{@gender.inspect},"\
+      " address: #{@address.inspect}, account: #{@account.inspect}, docv: #{@docv.inspect}, otp:"\
+      " #{@otp.inspect}, additional_context: #{@additional_context.inspect}, di_session_token:"\
+      " #{@di_session_token.inspect}, custom: #{@custom.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end