sc-apimatic-sdk 0.0.1

data/lib/socure_risk_os_api/models/payment_screening_business.rb

@@ -0,0 +1,155 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Business party details for Payment Screening.
+  class PaymentScreeningBusiness < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the business entity.
+    # @return [String]
+    attr_accessor :id
+
+    # Legal business name. Recommended when party type is BUSINESS.
+    # @return [String]
+    attr_accessor :name
+
+    # Business phone number. E.164 is expected, but hyphens and spaces are
+    # tolerated.
+    # @return [String]
+    attr_accessor :phone_number
+
+    # Employer Identification Number (EIN) of the business.
+    # @return [String]
+    attr_accessor :ein
+
+    # Business website URL.
+    # @return [String]
+    attr_accessor :website_url
+
+    # Business website URL.
+    # @return [Address]
+    attr_accessor :address
+
+    # Financial instrument details for Payment Screening.
+    # @return [PaymentScreeningInstrument]
+    attr_accessor :instrument
+
+    # Business formation details.
+    # @return [Object]
+    attr_accessor :formation
+
+    # 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['ein'] = 'ein'
+      @_hash['website_url'] = 'website_url'
+      @_hash['address'] = 'address'
+      @_hash['instrument'] = 'instrument'
+      @_hash['formation'] = 'formation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+        phone_number
+        ein
+        website_url
+        address
+        instrument
+        formation
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, name: SKIP, phone_number: SKIP, ein: SKIP,
+                   website_url: SKIP, address: SKIP, instrument: SKIP,
+                   formation: 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
+      @ein = ein unless ein == SKIP
+      @website_url = website_url unless website_url == SKIP
+      @address = address unless address == SKIP
+      @instrument = instrument unless instrument == SKIP
+      @formation = formation unless formation == 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
+      ein = hash.key?('ein') ? hash['ein'] : SKIP
+      website_url = hash.key?('website_url') ? hash['website_url'] : SKIP
+      address = Address.from_hash(hash['address']) if hash['address']
+      instrument = PaymentScreeningInstrument.from_hash(hash['instrument']) if hash['instrument']
+      formation = hash.key?('formation') ? hash['formation'] : 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.
+      PaymentScreeningBusiness.new(id: id,
+                                   name: name,
+                                   phone_number: phone_number,
+                                   ein: ein,
+                                   website_url: website_url,
+                                   address: address,
+                                   instrument: instrument,
+                                   formation: formation,
+                                   additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentScreeningBusiness | 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}, ein: #{@ein},"\
+      " website_url: #{@website_url}, address: #{@address}, instrument: #{@instrument}, formation:"\
+      " #{@formation}, 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}, ein: #{@ein.inspect}, website_url: #{@website_url.inspect},"\
+      " address: #{@address.inspect}, instrument: #{@instrument.inspect}, formation:"\
+      " #{@formation.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/payment_screening_individual.rb

@@ -0,0 +1,254 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Individual party details for Payment Screening.
+  class PaymentScreeningIndividual < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique internal identifier for the consumer.
+    # @return [String]
+    attr_accessor :id
+
+    # The consumer's given name.
+    # **Requirements:**
+    # - Must be UTF-8 encoded
+    # - Supports single-byte Latin characters only
+    # - Certain 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
+    # - Certain special characters are not supported
+    # @return [String]
+    attr_accessor :family_name
+
+    # 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
+
+    # Consumer date of birth in YYYY-MM-DD format.
+    # @return [Date]
+    attr_accessor :date_of_birth
+
+    # Consumer email address.
+    # @return [String]
+    attr_accessor :email
+
+    # Consumer 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 in E.164 format. 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
+
+    # Financial instrument details for Payment Screening.
+    # @return [PaymentScreeningInstrument]
+    attr_accessor :instrument
+
+    # 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
+
+    # Device intelligence session token.
+    # @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['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['instrument'] = 'instrument'
+      @_hash['additional_context'] = 'additional_context'
+      @_hash['di_session_token'] = 'di_session_token'
+      @_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
+        instrument
+        additional_context
+        di_session_token
+      ]
+    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,
+                   instrument: SKIP, additional_context: SKIP,
+                   di_session_token: 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
+      @instrument = instrument unless instrument == SKIP
+      @additional_context = additional_context unless additional_context == 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.
+      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']
+      instrument = PaymentScreeningInstrument.from_hash(hash['instrument']) if hash['instrument']
+      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
+
+      # 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.
+      PaymentScreeningIndividual.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,
+                                     instrument: instrument,
+                                     additional_context: additional_context,
+                                     di_session_token: di_session_token,
+                                     additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentScreeningIndividual | 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}, instrument: #{@instrument}, additional_context: #{@additional_context},"\
+      " 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} 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}, instrument: #{@instrument.inspect}, additional_context:"\
+      " #{@additional_context.inspect}, di_session_token: #{@di_session_token.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/payment_screening_instrument.rb

@@ -0,0 +1,105 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Financial instrument details for Payment Screening.
+  class PaymentScreeningInstrument < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Financial instrument type.
+    # @return [Type1]
+    attr_accessor :type
+
+    # Bank account details. Required when `type` is `BANK_ACCOUNT`.
+    # @return [Account1]
+    attr_accessor :account
+
+    # Crypto address details. Required when `type` is `CRYPTO_ADDRESS`.
+    # @return [CryptoAddress]
+    attr_accessor :crypto_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['account'] = 'account'
+      @_hash['crypto_address'] = 'crypto_address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        account
+        crypto_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type: SKIP, account: SKIP, crypto_address: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @account = account unless account == SKIP
+      @crypto_address = crypto_address unless crypto_address == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      account = Account1.from_hash(hash['account']) if hash['account']
+      crypto_address = CryptoAddress.from_hash(hash['crypto_address']) if hash['crypto_address']
+
+      # 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.
+      PaymentScreeningInstrument.new(type: type,
+                                     account: account,
+                                     crypto_address: crypto_address,
+                                     additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentScreeningInstrument | 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} type: #{@type}, account: #{@account}, crypto_address: #{@crypto_address},"\
+      " 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} type: #{@type.inspect}, account: #{@account.inspect}, crypto_address:"\
+      " #{@crypto_address.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/product.rb

@@ -0,0 +1,76 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # product.
+  class Product
+    PRODUCT = [
+      # TODO: Write general description for ENUM_ACCOUNT_INTELLIGENCE
+      ENUM_ACCOUNT_INTELLIGENCE = 'Account Intelligence'.freeze,
+
+      # TODO: Write general description for ENUM_ADDRESS_RISK
+      ENUM_ADDRESS_RISK = 'Address Risk'.freeze,
+
+      # TODO: Write general description for ENUM_DECEASED_CHECK
+      ENUM_DECEASED_CHECK = 'Deceased Check'.freeze,
+
+      # TODO: Write general description for ENUM_DEVICE_RISK
+      ENUM_DEVICE_RISK = 'Device Risk'.freeze,
+
+      # TODO: Write general description for ENUM_EMAIL_RISK
+      ENUM_EMAIL_RISK = 'Email Risk'.freeze,
+
+      # TODO: Write general description for ENUM_GLOBAL_WATCHLIST_SCREENING
+      ENUM_GLOBAL_WATCHLIST_SCREENING = 'Global Watchlist Screening'.freeze,
+
+      # TODO: Write general description for ENUM_PHONE_RISK
+      ENUM_PHONE_RISK = 'Phone Risk'.freeze,
+
+      # TODO: Write general description for ENUM_PREDICTIVE_DOCV
+      ENUM_PREDICTIVE_DOCV = 'Predictive DocV'.freeze,
+
+      # TODO: Write general description for ENUM_SIGMA_FIRSTPARTY_FRAUD
+      ENUM_SIGMA_FIRSTPARTY_FRAUD = 'Sigma First-Party Fraud'.freeze,
+
+      # TODO: Write general description for ENUM_SIGMA_IDENTITY_FRAUD
+      ENUM_SIGMA_IDENTITY_FRAUD = 'Sigma Identity Fraud'.freeze,
+
+      # TODO: Write general description for ENUM_SIGMA_SYNTHETIC
+      ENUM_SIGMA_SYNTHETIC = 'Sigma Synthetic'.freeze,
+
+      # TODO: Write general description for ENUM_SOCURE_VERIFY_KYC
+      ENUM_SOCURE_VERIFY_KYC = 'Socure Verify (KYC)'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PRODUCT.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_ACCOUNT_INTELLIGENCE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_account_intelligence' then ENUM_ACCOUNT_INTELLIGENCE
+      when 'enum_address_risk' then ENUM_ADDRESS_RISK
+      when 'enum_deceased_check' then ENUM_DECEASED_CHECK
+      when 'enum_device_risk' then ENUM_DEVICE_RISK
+      when 'enum_email_risk' then ENUM_EMAIL_RISK
+      when 'enum_global_watchlist_screening' then ENUM_GLOBAL_WATCHLIST_SCREENING
+      when 'enum_phone_risk' then ENUM_PHONE_RISK
+      when 'enum_predictive_docv' then ENUM_PREDICTIVE_DOCV
+      when 'enum_sigma_firstparty_fraud' then ENUM_SIGMA_FIRSTPARTY_FRAUD
+      when 'enum_sigma_identity_fraud' then ENUM_SIGMA_IDENTITY_FRAUD
+      when 'enum_sigma_synthetic' then ENUM_SIGMA_SYNTHETIC
+      when 'enum_socure_verify_kyc' then ENUM_SOCURE_VERIFY_KYC
+      else
+        default_value
+      end
+    end
+  end
+end