sc-apimatic-sdk 0.0.1

data/lib/socure_risk_os_api/logging/configuration/api_logging_configuration.rb

@@ -0,0 +1,186 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Initializes a new instance of RequestLoggingConfiguration.
+  class RequestLoggingConfiguration < CoreLibrary::ApiRequestLoggingConfiguration
+    # @param log_body [Boolean] Indicates whether the message body should be logged. Default is false.
+    # @param log_headers [Boolean] Indicates whether the message headers should be logged. Default is false.
+    # @param headers_to_exclude [Array<String>] Array of headers not displayed in logging. Default is an empty array.
+    # @param headers_to_include [Array<String>] Array of headers to be displayed in logging. Default is an empty array.
+    # @param headers_to_unmask [Array<String>] Array of headers which values are non-sensitive to display in logging.
+    #   Default is an empty array.
+    def initialize(log_body: false, log_headers: false, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil,
+                   include_query_in_path: false)
+      super(
+        log_body,
+        log_headers,
+        headers_to_exclude,
+        headers_to_include,
+        headers_to_unmask,
+        include_query_in_path
+      )
+    end
+
+    def clone_with(log_body: nil, log_headers: nil, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil, include_query_in_path: nil)
+      log_body ||= self.log_body
+      log_headers ||= self.log_headers
+      headers_to_include ||= self.headers_to_include
+      headers_to_exclude ||= self.headers_to_exclude
+      headers_to_unmask ||= self.headers_to_unmask
+      include_query_in_path ||= self.include_query_in_path
+
+      RequestLoggingConfiguration.new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask,
+        include_query_in_path: include_query_in_path
+      )
+    end
+
+    def self.from_env
+      log_body = ENV['REQUEST_LOG_BODY']
+      log_headers = ENV['REQUEST_LOG_HEADERS']
+      headers_to_include = ENV['REQUEST_HEADERS_TO_INCLUDE']
+      headers_to_exclude = ENV['REQUEST_HEADERS_TO_EXCLUDE']
+      headers_to_unmask = ENV['REQUEST_HEADERS_TO_UNMASK']
+      include_query_in_path = ENV['REQUEST_INCLUDE_QUERY_IN_PATH']
+
+      new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask,
+        include_query_in_path: include_query_in_path
+      )
+    end
+
+    def self.any_logging_configured?
+      %w[
+        REQUEST_LOG_BODY
+        REQUEST_LOG_HEADERS
+        REQUEST_HEADERS_TO_INCLUDE
+        REQUEST_HEADERS_TO_EXCLUDE
+        REQUEST_HEADERS_TO_UNMASK
+        REQUEST_INCLUDE_QUERY_IN_PATH
+      ].any? { |key| ENV.key?(key) && !ENV[key].nil? && !ENV[key].empty? }
+    end
+  end
+
+  # Initializes a new instance of ResponseLoggingConfiguration.
+  class ResponseLoggingConfiguration < CoreLibrary::ApiResponseLoggingConfiguration
+    def initialize(log_body: false, log_headers: false, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil)
+      super(
+        log_body,
+        log_headers,
+        headers_to_exclude,
+        headers_to_include,
+        headers_to_unmask
+      )
+    end
+
+    def clone_with(log_body: nil, log_headers: nil, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil)
+      log_body ||= self.log_body
+      log_headers ||= self.log_headers
+      headers_to_include ||= self.headers_to_include
+      headers_to_exclude ||= self.headers_to_exclude
+      headers_to_unmask ||= self.headers_to_unmask
+
+      ResponseLoggingConfiguration.new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask
+      )
+    end
+
+    def self.from_env
+      log_body = ENV['RESPONSE_LOG_BODY']
+      log_headers = ENV['RESPONSE_LOG_HEADERS']
+      headers_to_include = ENV['RESPONSE_HEADERS_TO_INCLUDE']
+      headers_to_exclude = ENV['RESPONSE_HEADERS_TO_EXCLUDE']
+      headers_to_unmask = ENV['RESPONSE_HEADERS_TO_UNMASK']
+
+      new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask
+      )
+    end
+
+    def self.any_logging_configured?
+      %w[
+        RESPONSE_LOG_BODY
+        RESPONSE_LOG_HEADERS
+        RESPONSE_HEADERS_TO_INCLUDE
+        RESPONSE_HEADERS_TO_EXCLUDE
+        RESPONSE_HEADERS_TO_UNMASK
+      ].any? { |key| ENV.key?(key) && !ENV[key].nil? && !ENV[key].empty? }
+    end
+  end
+
+  # Initializes a new instance of LoggingConfiguration.
+  class LoggingConfiguration < CoreLibrary::ApiLoggingConfiguration
+    def initialize(logger: nil, log_level: nil, mask_sensitive_headers: true,
+                   request_logging_config: nil,
+                   response_logging_config: nil)
+      request_logging_config ||= RequestLoggingConfiguration.new
+      response_logging_config ||= ResponseLoggingConfiguration.new
+      super(
+        logger,
+        log_level,
+        request_logging_config,
+        response_logging_config,
+        mask_sensitive_headers
+      )
+    end
+
+    def clone_with(logger: nil, log_level: nil, mask_sensitive_headers: nil,
+                   request_logging_config: nil, response_logging_config: nil)
+      logger ||= self.logger
+      log_level ||= self.log_level
+      mask_sensitive_headers ||= self.mask_sensitive_headers
+      request_logging_config ||= self.request_logging_config.clone
+      response_logging_config ||= self.response_logging_config.clone
+
+      LoggingConfiguration.new(
+        logger: logger,
+        log_level: log_level,
+        mask_sensitive_headers: mask_sensitive_headers,
+        request_logging_config: request_logging_config,
+        response_logging_config: response_logging_config
+      )
+    end
+
+    def self.from_env
+      log_level = ENV['LOG_LEVEL']
+      mask_sensitive_headers = ENV['MASK_SENSITIVE_HEADERS']
+
+      new(
+        log_level: log_level,
+        mask_sensitive_headers: mask_sensitive_headers,
+        request_logging_config: RequestLoggingConfiguration.from_env,
+        response_logging_config: ResponseLoggingConfiguration.from_env
+      )
+    end
+
+    def self.any_logging_configured?
+      RequestLoggingConfiguration.any_logging_configured? ||
+        ResponseLoggingConfiguration.any_logging_configured? ||
+        ENV.key?('LOG_LEVEL') ||
+        ENV.key?('MASK_SENSITIVE_HEADERS')
+    end
+  end
+end

data/lib/socure_risk_os_api/logging/sdk_logger.rb

@@ -0,0 +1,17 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SocureRiskOsApi
+  # Represents the generic logger facade
+  class AbstractLogger < Logger
+    # Logs a message with a specified log level and additional parameters.
+    # @param level [Symbol] The log level of the message.
+    # @param message [String] The message to log.
+    # @param params [Hash] Additional parameters to include in the log message.
+    def log(level, message, params)
+      raise NotImplementedError, 'This method needs to be implemented in a child class.'
+    end
+  end
+end

data/lib/socure_risk_os_api/models/account.rb

@@ -0,0 +1,206 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module SocureRiskOsApi
+  # Defines the schema of an bank account.
+  class Account < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account Type
+    # @return [Type]
+    attr_accessor :type
+
+    # Bank account number
+    # @return [String]
+    attr_accessor :account_number
+
+    # Routing number associated with the account
+    # @return [String]
+    attr_accessor :routing_number
+
+    # Swift/BIC Code of the account
+    # @return [String]
+    attr_accessor :swift_bic
+
+    # ISO 8601/ RFC 3339 date-time. Date the account was opened.
+    # @return [DateTime]
+    attr_accessor :opened_at
+
+    # Name of the institution (e.g. XYZ bank)
+    # @return [String]
+    attr_accessor :institution_name
+
+    # Client provided unique Account ID.
+    # @return [String]
+    attr_accessor :id
+
+    # Client provided unique Account ID.
+    # @return [Address]
+    attr_accessor :institution_address
+
+    # The inquiry type. Below are the possible values.
+    # - `AVAILABILITY`: Used to confirm a bank account's availability.
+    # - `OWNERSHIP`: Used to verify a bank account's ownership.
+    # @return [Array[Inquiry]]
+    attr_accessor :account_inquiries
+
+    # Represents a snapshot of the account’s state at a specific point in time.
+    # @return [AccountSnapshot]
+    attr_accessor :account_snapshot
+
+    # Send any additional, customer-specific data in this field. See [Custom
+    # Fields](https://help.socure.com/riskos/docs/custom-fields) for more
+    # information.
+    # @return [Hash[String, Object]]
+    attr_accessor :custom
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['account_number'] = 'account_number'
+      @_hash['routing_number'] = 'routing_number'
+      @_hash['swift_bic'] = 'swift_bic'
+      @_hash['opened_at'] = 'opened_at'
+      @_hash['institution_name'] = 'institution_name'
+      @_hash['id'] = 'id'
+      @_hash['institution_address'] = 'institution_address'
+      @_hash['account_inquiries'] = 'account_inquiries'
+      @_hash['account_snapshot'] = 'account_snapshot'
+      @_hash['custom'] = 'custom'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        account_number
+        routing_number
+        swift_bic
+        opened_at
+        institution_name
+        id
+        institution_address
+        account_inquiries
+        account_snapshot
+        custom
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type: SKIP, account_number: SKIP, routing_number: SKIP,
+                   swift_bic: SKIP, opened_at: SKIP, institution_name: SKIP,
+                   id: SKIP, institution_address: SKIP, account_inquiries: SKIP,
+                   account_snapshot: SKIP, custom: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @routing_number = routing_number unless routing_number == SKIP
+      @swift_bic = swift_bic unless swift_bic == SKIP
+      @opened_at = opened_at unless opened_at == SKIP
+      @institution_name = institution_name unless institution_name == SKIP
+      @id = id unless id == SKIP
+      @institution_address = institution_address unless institution_address == SKIP
+      @account_inquiries = account_inquiries unless account_inquiries == SKIP
+      @account_snapshot = account_snapshot unless account_snapshot == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : SKIP
+      routing_number =
+        hash.key?('routing_number') ? hash['routing_number'] : SKIP
+      swift_bic = hash.key?('swift_bic') ? hash['swift_bic'] : SKIP
+      opened_at = if hash.key?('opened_at')
+                    (DateTimeHelper.from_rfc3339(hash['opened_at']) if hash['opened_at'])
+                  else
+                    SKIP
+                  end
+      institution_name =
+        hash.key?('institution_name') ? hash['institution_name'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      institution_address = Address.from_hash(hash['institution_address']) if
+        hash['institution_address']
+      account_inquiries =
+        hash.key?('account_inquiries') ? hash['account_inquiries'] : SKIP
+      account_snapshot = AccountSnapshot.from_hash(hash['account_snapshot']) if
+        hash['account_snapshot']
+      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.
+      Account.new(type: type,
+                  account_number: account_number,
+                  routing_number: routing_number,
+                  swift_bic: swift_bic,
+                  opened_at: opened_at,
+                  institution_name: institution_name,
+                  id: id,
+                  institution_address: institution_address,
+                  account_inquiries: account_inquiries,
+                  account_snapshot: account_snapshot,
+                  custom: custom,
+                  additional_properties: additional_properties)
+    end
+
+    def to_custom_opened_at
+      DateTimeHelper.to_rfc3339(opened_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Account | 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_number: #{@account_number}, routing_number:"\
+      " #{@routing_number}, swift_bic: #{@swift_bic}, opened_at: #{@opened_at}, institution_name:"\
+      " #{@institution_name}, id: #{@id}, institution_address: #{@institution_address},"\
+      " account_inquiries: #{@account_inquiries}, account_snapshot: #{@account_snapshot}, 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} type: #{@type.inspect}, account_number: #{@account_number.inspect},"\
+      " routing_number: #{@routing_number.inspect}, swift_bic: #{@swift_bic.inspect}, opened_at:"\
+      " #{@opened_at.inspect}, institution_name: #{@institution_name.inspect}, id: #{@id.inspect},"\
+      " institution_address: #{@institution_address.inspect}, account_inquiries:"\
+      " #{@account_inquiries.inspect}, account_snapshot: #{@account_snapshot.inspect}, custom:"\
+      " #{@custom.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/account1.rb

@@ -0,0 +1,203 @@
+# socure_risk_os_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module SocureRiskOsApi
+  # Bank account details. Required when `type` is `BANK_ACCOUNT`.
+  class Account1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Client-provided unique account identifier.
+    # @return [String]
+    attr_accessor :id
+
+    # Bank account type.
+    # @return [Type2]
+    attr_accessor :type
+
+    # Bank account number.
+    # @return [String]
+    attr_accessor :account_number
+
+    # Routing number associated with the account.
+    # @return [String]
+    attr_accessor :routing_number
+
+    # SWIFT/BIC code.
+    # @return [String]
+    attr_accessor :swift_bic
+
+    # International Bank Account Number (IBAN).
+    # @return [String]
+    attr_accessor :iban
+
+    # Date and time the account was opened, in ISO 8601 / RFC 3339 format.
+    # @return [DateTime]
+    attr_accessor :opened_at
+
+    # Financial institution name.
+    # @return [String]
+    attr_accessor :institution_name
+
+    # Inquiry types requested for the account.
+    # @return [Array[AccountInquiry]]
+    attr_accessor :account_inquiries
+
+    # Inquiry types requested for the account.
+    # @return [Address]
+    attr_accessor :institution_address
+
+    # Represents a snapshot of the account’s state at a specific point in time.
+    # @return [AccountSnapshot]
+    attr_accessor :account_snapshot
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['type'] = 'type'
+      @_hash['account_number'] = 'account_number'
+      @_hash['routing_number'] = 'routing_number'
+      @_hash['swift_bic'] = 'swift_bic'
+      @_hash['iban'] = 'iban'
+      @_hash['opened_at'] = 'opened_at'
+      @_hash['institution_name'] = 'institution_name'
+      @_hash['account_inquiries'] = 'account_inquiries'
+      @_hash['institution_address'] = 'institution_address'
+      @_hash['account_snapshot'] = 'account_snapshot'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        type
+        account_number
+        routing_number
+        swift_bic
+        iban
+        opened_at
+        institution_name
+        account_inquiries
+        institution_address
+        account_snapshot
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, type: SKIP, account_number: SKIP,
+                   routing_number: SKIP, swift_bic: SKIP, iban: SKIP,
+                   opened_at: SKIP, institution_name: SKIP,
+                   account_inquiries: SKIP, institution_address: SKIP,
+                   account_snapshot: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @type = type unless type == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @routing_number = routing_number unless routing_number == SKIP
+      @swift_bic = swift_bic unless swift_bic == SKIP
+      @iban = iban unless iban == SKIP
+      @opened_at = opened_at unless opened_at == SKIP
+      @institution_name = institution_name unless institution_name == SKIP
+      @account_inquiries = account_inquiries unless account_inquiries == SKIP
+      @institution_address = institution_address unless institution_address == SKIP
+      @account_snapshot = account_snapshot unless account_snapshot == 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
+      type = hash.key?('type') ? hash['type'] : SKIP
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : SKIP
+      routing_number =
+        hash.key?('routing_number') ? hash['routing_number'] : SKIP
+      swift_bic = hash.key?('swift_bic') ? hash['swift_bic'] : SKIP
+      iban = hash.key?('iban') ? hash['iban'] : SKIP
+      opened_at = if hash.key?('opened_at')
+                    (DateTimeHelper.from_rfc3339(hash['opened_at']) if hash['opened_at'])
+                  else
+                    SKIP
+                  end
+      institution_name =
+        hash.key?('institution_name') ? hash['institution_name'] : SKIP
+      account_inquiries =
+        hash.key?('account_inquiries') ? hash['account_inquiries'] : SKIP
+      institution_address = Address.from_hash(hash['institution_address']) if
+        hash['institution_address']
+      account_snapshot = AccountSnapshot.from_hash(hash['account_snapshot']) if
+        hash['account_snapshot']
+
+      # 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.
+      Account1.new(id: id,
+                   type: type,
+                   account_number: account_number,
+                   routing_number: routing_number,
+                   swift_bic: swift_bic,
+                   iban: iban,
+                   opened_at: opened_at,
+                   institution_name: institution_name,
+                   account_inquiries: account_inquiries,
+                   institution_address: institution_address,
+                   account_snapshot: account_snapshot,
+                   additional_properties: additional_properties)
+    end
+
+    def to_custom_opened_at
+      DateTimeHelper.to_rfc3339(opened_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Account1 | 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}, type: #{@type}, account_number: #{@account_number},"\
+      " routing_number: #{@routing_number}, swift_bic: #{@swift_bic}, iban: #{@iban}, opened_at:"\
+      " #{@opened_at}, institution_name: #{@institution_name}, account_inquiries:"\
+      " #{@account_inquiries}, institution_address: #{@institution_address}, account_snapshot:"\
+      " #{@account_snapshot}, 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}, type: #{@type.inspect}, account_number:"\
+      " #{@account_number.inspect}, routing_number: #{@routing_number.inspect}, swift_bic:"\
+      " #{@swift_bic.inspect}, iban: #{@iban.inspect}, opened_at: #{@opened_at.inspect},"\
+      " institution_name: #{@institution_name.inspect}, account_inquiries:"\
+      " #{@account_inquiries.inspect}, institution_address: #{@institution_address.inspect},"\
+      " account_snapshot: #{@account_snapshot.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/socure_risk_os_api/models/account_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
+  # AccountInquiry.
+  class AccountInquiry
+    ACCOUNT_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?
+
+      ACCOUNT_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