sc-apimatic-sdk 0.0.1

data/lib/socure_risk_os_api/models/account_snapshot.rb

@@ -0,0 +1,106 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module SocureRiskOsApi
+  # Represents a snapshot of the account’s state at a specific point in time.
+  class AccountSnapshot < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The timestamp indicating when the evaluation was initiated, in ISO 8601 /
+    # RFC 3339 format.
+    # @return [DateTime]
+    attr_accessor :timestamp
+
+    # A read-only snapshot of the account’s balances and recent activity.
+    # @return [AccountView]
+    attr_accessor :account_view
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['account_view'] = 'account_view'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        timestamp
+        account_view
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(timestamp: SKIP, account_view: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @timestamp = timestamp unless timestamp == SKIP
+      @account_view = account_view unless account_view == 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.
+      timestamp = if hash.key?('timestamp')
+                    (DateTimeHelper.from_rfc3339(hash['timestamp']) if hash['timestamp'])
+                  else
+                    SKIP
+                  end
+      account_view = AccountView.from_hash(hash['account_view']) if hash['account_view']
+
+      # 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.
+      AccountSnapshot.new(timestamp: timestamp,
+                          account_view: account_view,
+                          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 [AccountSnapshot | 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} timestamp: #{@timestamp}, account_view: #{@account_view},"\
+      " 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} timestamp: #{@timestamp.inspect}, account_view: #{@account_view.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/account_view.rb

@@ -0,0 +1,116 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module SocureRiskOsApi
+  # A read-only snapshot of the account’s balances and recent activity.
+  class AccountView < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents a monetary amount with its associated currency.
+    # @return [Amount]
+    attr_accessor :available_balance
+
+    # Represents a monetary amount with its associated currency.
+    # @return [Amount]
+    attr_accessor :current_balance
+
+    # Represents a monetary amount with its associated currency.
+    # @return [DateTime]
+    attr_accessor :last_activity_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['available_balance'] = 'available_balance'
+      @_hash['current_balance'] = 'current_balance'
+      @_hash['last_activity_at'] = 'last_activity_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        available_balance
+        current_balance
+        last_activity_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(available_balance: SKIP, current_balance: SKIP,
+                   last_activity_at: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @available_balance = available_balance unless available_balance == SKIP
+      @current_balance = current_balance unless current_balance == SKIP
+      @last_activity_at = last_activity_at unless last_activity_at == 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.
+      available_balance = Amount.from_hash(hash['available_balance']) if hash['available_balance']
+      current_balance = Amount.from_hash(hash['current_balance']) if hash['current_balance']
+      last_activity_at = if hash.key?('last_activity_at')
+                           (DateTimeHelper.from_rfc3339(hash['last_activity_at']) if hash['last_activity_at'])
+                         else
+                           SKIP
+                         end
+
+      # 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.
+      AccountView.new(available_balance: available_balance,
+                      current_balance: current_balance,
+                      last_activity_at: last_activity_at,
+                      additional_properties: additional_properties)
+    end
+
+    def to_custom_last_activity_at
+      DateTimeHelper.to_rfc3339(last_activity_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AccountView | 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} available_balance: #{@available_balance}, current_balance:"\
+      " #{@current_balance}, last_activity_at: #{@last_activity_at}, 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} available_balance: #{@available_balance.inspect}, current_balance:"\
+      " #{@current_balance.inspect}, last_activity_at: #{@last_activity_at.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/actions.rb

@@ -0,0 +1,88 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # A top-level container for instructions that modify the lifecycle of the
+  # current evaluation session.
+  class Actions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Set to `true` to force the workflow out of an `ON_HOLD` state. This
+    # bypasses the current paused step (for example, OTP entry) so the consumer
+    # can fix a typo or switch delivery channels.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :resume
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['resume'] = 'resume'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        resume
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(resume: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @resume = resume unless resume == 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.
+      resume = hash.key?('resume') ? hash['resume'] : 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.
+      Actions.new(resume: resume,
+                  additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Actions | 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} resume: #{@resume}, 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} resume: #{@resume.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/additional_context.rb

@@ -0,0 +1,235 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module SocureRiskOsApi
+  # 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.
+  class AdditionalContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates if the consumer has provided consent. This field must be set to
+    # `true` in order for the transaction to be processed; otherwise a 400 error
+    # will be returned.
+    # > **Note**: A `null` value can be passed in the field to skip the eCBSV
+    # module and still process the transaction with the other modules included
+    # in the request.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :user_consent
+
+    # The date and time when the user provided consent, specified in ISO 8601
+    # format. If no value is provided, defaults to the current timestamp of the
+    # evaluation.
+    # > **Note**: Although the `consentTimestamp` parameter is optional, it's
+    # crucial to provide it when using the `ecbsv` module to meet the 90-day
+    # consent window set by the SSA for compliance with the eCBSV service.
+    # @return [DateTime]
+    attr_accessor :consent_timestamp
+
+    # The `referenceId` of a previous Socure transaction. Allows you to link
+    # multiple transactions together.
+    # @return [String]
+    attr_accessor :previous_reference_id
+
+    # The username associated with a consumer's account.
+    # @return [String]
+    attr_accessor :user_name
+
+    # This field must be set to `GLBA_502(e)` to support acceptable use of the
+    # product. Data contributed to Sigma First-Party Fraud is Non-Public
+    # Information (NPI) that may only be further disclosed pursuant to the GLBA
+    # fraud exception.
+    # @return [DisclosurePurpose]
+    attr_accessor :disclosure_purpose
+
+    # The entity type. Possible values are `Individual`, `Organization`,
+    # `Vessel`, `Aircraft`, `Others`.
+    # @return [String]
+    attr_accessor :entity_type
+
+    # The entity's full name. Must not contain special characters.
+    # @return [String]
+    attr_accessor :entity_name
+
+    # Set to `true` if the entity was accepted to conduct business with your
+    # organization. The default setting is `false`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :accept_list
+
+    # Optional notes that capture details about known risks when conducting
+    # business with the entity. Only use this field if the `accept_list` is set
+    # to `true`.
+    # @return [String]
+    attr_accessor :notes
+
+    # The driver's license identification number.
+    # @return [String]
+    attr_accessor :driver_license
+
+    # The two letter postal code of the issuing state.
+    # @return [String]
+    attr_accessor :driver_license_state
+
+    # Set to `true` to run Socure Phone Risk with Real-Time SIM Swap
+    # Verification. When enabled, the Phone Risk response returns additional SIM
+    # Swap reason codes. Requires the Phone Risk with SIM Swap enrichment to be
+    # configured in your workflow.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :mno_status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['user_consent'] = 'user_consent'
+      @_hash['consent_timestamp'] = 'consent_timestamp'
+      @_hash['previous_reference_id'] = 'previous_reference_id'
+      @_hash['user_name'] = 'user_name'
+      @_hash['disclosure_purpose'] = 'disclosure_purpose'
+      @_hash['entity_type'] = 'entity_type'
+      @_hash['entity_name'] = 'entity_name'
+      @_hash['accept_list'] = 'accept_list'
+      @_hash['notes'] = 'notes'
+      @_hash['driver_license'] = 'driver_license'
+      @_hash['driver_license_state'] = 'driver_license_state'
+      @_hash['mno_status'] = 'mno_status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        user_consent
+        consent_timestamp
+        previous_reference_id
+        user_name
+        disclosure_purpose
+        entity_type
+        entity_name
+        accept_list
+        notes
+        driver_license
+        driver_license_state
+        mno_status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(user_consent: SKIP, consent_timestamp: SKIP,
+                   previous_reference_id: SKIP, user_name: SKIP,
+                   disclosure_purpose: SKIP, entity_type: SKIP,
+                   entity_name: SKIP, accept_list: SKIP, notes: SKIP,
+                   driver_license: SKIP, driver_license_state: SKIP,
+                   mno_status: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @user_consent = user_consent unless user_consent == SKIP
+      @consent_timestamp = consent_timestamp unless consent_timestamp == SKIP
+      @previous_reference_id = previous_reference_id unless previous_reference_id == SKIP
+      @user_name = user_name unless user_name == SKIP
+      @disclosure_purpose = disclosure_purpose unless disclosure_purpose == SKIP
+      @entity_type = entity_type unless entity_type == SKIP
+      @entity_name = entity_name unless entity_name == SKIP
+      @accept_list = accept_list unless accept_list == SKIP
+      @notes = notes unless notes == SKIP
+      @driver_license = driver_license unless driver_license == SKIP
+      @driver_license_state = driver_license_state unless driver_license_state == SKIP
+      @mno_status = mno_status unless mno_status == 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.
+      user_consent = hash.key?('user_consent') ? hash['user_consent'] : SKIP
+      consent_timestamp = if hash.key?('consent_timestamp')
+                            (DateTimeHelper.from_rfc3339(hash['consent_timestamp']) if hash['consent_timestamp'])
+                          else
+                            SKIP
+                          end
+      previous_reference_id =
+        hash.key?('previous_reference_id') ? hash['previous_reference_id'] : SKIP
+      user_name = hash.key?('user_name') ? hash['user_name'] : SKIP
+      disclosure_purpose =
+        hash.key?('disclosure_purpose') ? hash['disclosure_purpose'] : SKIP
+      entity_type = hash.key?('entity_type') ? hash['entity_type'] : SKIP
+      entity_name = hash.key?('entity_name') ? hash['entity_name'] : SKIP
+      accept_list = hash.key?('accept_list') ? hash['accept_list'] : SKIP
+      notes = hash.key?('notes') ? hash['notes'] : SKIP
+      driver_license =
+        hash.key?('driver_license') ? hash['driver_license'] : SKIP
+      driver_license_state =
+        hash.key?('driver_license_state') ? hash['driver_license_state'] : SKIP
+      mno_status = hash.key?('mno_status') ? hash['mno_status'] : 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.
+      AdditionalContext.new(user_consent: user_consent,
+                            consent_timestamp: consent_timestamp,
+                            previous_reference_id: previous_reference_id,
+                            user_name: user_name,
+                            disclosure_purpose: disclosure_purpose,
+                            entity_type: entity_type,
+                            entity_name: entity_name,
+                            accept_list: accept_list,
+                            notes: notes,
+                            driver_license: driver_license,
+                            driver_license_state: driver_license_state,
+                            mno_status: mno_status,
+                            additional_properties: additional_properties)
+    end
+
+    def to_custom_consent_timestamp
+      DateTimeHelper.to_rfc3339(consent_timestamp)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AdditionalContext | 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} user_consent: #{@user_consent}, consent_timestamp: #{@consent_timestamp},"\
+      " previous_reference_id: #{@previous_reference_id}, user_name: #{@user_name},"\
+      " disclosure_purpose: #{@disclosure_purpose}, entity_type: #{@entity_type}, entity_name:"\
+      " #{@entity_name}, accept_list: #{@accept_list}, notes: #{@notes}, driver_license:"\
+      " #{@driver_license}, driver_license_state: #{@driver_license_state}, mno_status:"\
+      " #{@mno_status}, 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} user_consent: #{@user_consent.inspect}, consent_timestamp:"\
+      " #{@consent_timestamp.inspect}, previous_reference_id: #{@previous_reference_id.inspect},"\
+      " user_name: #{@user_name.inspect}, disclosure_purpose: #{@disclosure_purpose.inspect},"\
+      " entity_type: #{@entity_type.inspect}, entity_name: #{@entity_name.inspect}, accept_list:"\
+      " #{@accept_list.inspect}, notes: #{@notes.inspect}, driver_license:"\
+      " #{@driver_license.inspect}, driver_license_state: #{@driver_license_state.inspect},"\
+      " mno_status: #{@mno_status.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end