apimatic-ak-sdk 0.0.1

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

@@ -0,0 +1,186 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # 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/akoya/logging/sdk_logger.rb

@@ -0,0 +1,17 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # 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/akoya/models/account.rb

@@ -0,0 +1,86 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # Account Model.
+  class Account < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account ID of the related account
+    # @return [String]
+    attr_accessor :account_id
+
+    # Types of relationships between accounts and holders. Suggested values
+    # @return [AccountHolderRelationship]
+    attr_accessor :relationship
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'accountId'
+      @_hash['relationship'] = 'relationship'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        relationship
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id: SKIP, relationship: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_id = account_id unless account_id == SKIP
+      @relationship = relationship unless relationship == 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.
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      relationship = hash.key?('relationship') ? hash['relationship'] : 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(account_id: account_id,
+                  relationship: relationship,
+                  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} account_id: #{@account_id}, relationship: #{@relationship},"\
+      " 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} account_id: #{@account_id.inspect}, relationship: #{@relationship.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/akoya/models/account_category.rb

@@ -0,0 +1,50 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # The account category of the insurance account. Possible enums:
+  # DEPOSIT_ACCOUNT, INVESTMENT_ACCOUNT, LOAN_ACCOUNT, LOC_ACCOUNT,
+  # INSURANCE_ACCOUNT
+  class AccountCategory
+    ACCOUNT_CATEGORY = [
+      # TODO: Write general description for DEPOSIT_ACCOUNT
+      DEPOSIT_ACCOUNT = 'DEPOSIT_ACCOUNT'.freeze,
+
+      # TODO: Write general description for INVESTMENT_ACCOUNT
+      INVESTMENT_ACCOUNT = 'INVESTMENT_ACCOUNT'.freeze,
+
+      # TODO: Write general description for LOAN_ACCOUNT
+      LOAN_ACCOUNT = 'LOAN_ACCOUNT'.freeze,
+
+      # TODO: Write general description for LOC_ACCOUNT
+      LOC_ACCOUNT = 'LOC_ACCOUNT'.freeze,
+
+      # TODO: Write general description for INSURANCE_ACCOUNT
+      INSURANCE_ACCOUNT = 'INSURANCE_ACCOUNT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DEPOSIT_ACCOUNT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'deposit_account' then DEPOSIT_ACCOUNT
+      when 'investment_account' then INVESTMENT_ACCOUNT
+      when 'loan_account' then LOAN_ACCOUNT
+      when 'loc_account' then LOC_ACCOUNT
+      when 'insurance_account' then INSURANCE_ACCOUNT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/akoya/models/account_contact_entity.rb

@@ -0,0 +1,132 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # Contact information for the account
+  class AccountContactEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Owners of the account
+    # @return [Array[AccountHolderEntity]]
+    attr_accessor :holders
+
+    # Email addresses associated with the account
+    # @return [Array[String]]
+    attr_accessor :emails
+
+    # Physical mail addresses associated with the account
+    # @return [Array[DeliveryAddress]]
+    attr_accessor :addresses
+
+    # Telephone numbers associated with the account
+    # @return [Array[TelephoneNumber]]
+    attr_accessor :telephones
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['holders'] = 'holders'
+      @_hash['emails'] = 'emails'
+      @_hash['addresses'] = 'addresses'
+      @_hash['telephones'] = 'telephones'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        holders
+        emails
+        addresses
+        telephones
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(holders: SKIP, emails: SKIP, addresses: SKIP,
+                   telephones: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @holders = holders unless holders == SKIP
+      @emails = emails unless emails == SKIP
+      @addresses = addresses unless addresses == SKIP
+      @telephones = telephones unless telephones == 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.
+      # Parameter is an array, so we need to iterate through it
+      holders = nil
+      unless hash['holders'].nil?
+        holders = []
+        hash['holders'].each do |structure|
+          holders << (AccountHolderEntity.from_hash(structure) if structure)
+        end
+      end
+
+      holders = SKIP unless hash.key?('holders')
+      emails = hash.key?('emails') ? hash['emails'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      addresses = nil
+      unless hash['addresses'].nil?
+        addresses = []
+        hash['addresses'].each do |structure|
+          addresses << (DeliveryAddress.from_hash(structure) if structure)
+        end
+      end
+
+      addresses = SKIP unless hash.key?('addresses')
+      # Parameter is an array, so we need to iterate through it
+      telephones = nil
+      unless hash['telephones'].nil?
+        telephones = []
+        hash['telephones'].each do |structure|
+          telephones << (TelephoneNumber.from_hash(structure) if structure)
+        end
+      end
+
+      telephones = SKIP unless hash.key?('telephones')
+
+      # 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.
+      AccountContactEntity.new(holders: holders,
+                               emails: emails,
+                               addresses: addresses,
+                               telephones: telephones,
+                               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} holders: #{@holders}, emails: #{@emails}, addresses: #{@addresses},"\
+      " telephones: #{@telephones}, 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} holders: #{@holders.inspect}, emails: #{@emails.inspect}, addresses:"\
+      " #{@addresses.inspect}, telephones: #{@telephones.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/akoya/models/account_holder_entity.rb

@@ -0,0 +1,178 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # Extends `Customer` and adds a `relationship` field to define the customer's
+  # relationship with an account
+  class AccountHolderEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Long-term persistent identity of the end-user. This identity must be
+    # unique to the owning institution
+    # @return [String]
+    attr_accessor :customer_id
+
+    # The end-user's name
+    # @return [CustomerNameAccountHolderEntity]
+    attr_accessor :name
+
+    # The business customer information, only used if 'type' is 'BUSINESS'.
+    # @return [BusinessCustomerEntityAccountHolderEntity]
+    attr_accessor :business_customer
+
+    # An array of the customer's physical mail addresses
+    # @return [Array[DeliveryAddress]]
+    attr_accessor :addresses
+
+    # An array of the customer's physical mail addresses
+    # @return [Array[Telephone]]
+    attr_accessor :telephones
+
+    # An array of the end-user's electronic mail addresses
+    # @return [Array[String]]
+    attr_accessor :email
+
+    # List of accounts related to this end-user
+    # @return [Array[Account]]
+    attr_accessor :accounts
+
+    # Customer's relationship to the account
+    # @return [AccountHolderRelationshipAccountHolderEntity]
+    attr_accessor :relationship
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer_id'] = 'customerId'
+      @_hash['name'] = 'name'
+      @_hash['business_customer'] = 'businessCustomer'
+      @_hash['addresses'] = 'addresses'
+      @_hash['telephones'] = 'telephones'
+      @_hash['email'] = 'email'
+      @_hash['accounts'] = 'accounts'
+      @_hash['relationship'] = 'relationship'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer_id
+        name
+        business_customer
+        addresses
+        telephones
+        email
+        accounts
+        relationship
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(customer_id: SKIP, name: SKIP, business_customer: SKIP,
+                   addresses: SKIP, telephones: SKIP, email: SKIP,
+                   accounts: SKIP, relationship: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @customer_id = customer_id unless customer_id == SKIP
+      @name = name unless name == SKIP
+      @business_customer = business_customer unless business_customer == SKIP
+      @addresses = addresses unless addresses == SKIP
+      @telephones = telephones unless telephones == SKIP
+      @email = email unless email == SKIP
+      @accounts = accounts unless accounts == SKIP
+      @relationship = relationship unless relationship == 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.
+      customer_id = hash.key?('customerId') ? hash['customerId'] : SKIP
+      name = CustomerNameAccountHolderEntity.from_hash(hash['name']) if hash['name']
+      if hash['businessCustomer']
+        business_customer = BusinessCustomerEntityAccountHolderEntity.from_hash(hash['businessCustomer'])
+      end
+      # Parameter is an array, so we need to iterate through it
+      addresses = nil
+      unless hash['addresses'].nil?
+        addresses = []
+        hash['addresses'].each do |structure|
+          addresses << (DeliveryAddress.from_hash(structure) if structure)
+        end
+      end
+
+      addresses = SKIP unless hash.key?('addresses')
+      # Parameter is an array, so we need to iterate through it
+      telephones = nil
+      unless hash['telephones'].nil?
+        telephones = []
+        hash['telephones'].each do |structure|
+          telephones << (Telephone.from_hash(structure) if structure)
+        end
+      end
+
+      telephones = SKIP unless hash.key?('telephones')
+      email = hash.key?('email') ? hash['email'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      accounts = nil
+      unless hash['accounts'].nil?
+        accounts = []
+        hash['accounts'].each do |structure|
+          accounts << (Account.from_hash(structure) if structure)
+        end
+      end
+
+      accounts = SKIP unless hash.key?('accounts')
+      relationship = hash.key?('relationship') ? hash['relationship'] : 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.
+      AccountHolderEntity.new(customer_id: customer_id,
+                              name: name,
+                              business_customer: business_customer,
+                              addresses: addresses,
+                              telephones: telephones,
+                              email: email,
+                              accounts: accounts,
+                              relationship: relationship,
+                              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} customer_id: #{@customer_id}, name: #{@name}, business_customer:"\
+      " #{@business_customer}, addresses: #{@addresses}, telephones: #{@telephones}, email:"\
+      " #{@email}, accounts: #{@accounts}, relationship: #{@relationship}, 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} customer_id: #{@customer_id.inspect}, name: #{@name.inspect},"\
+      " business_customer: #{@business_customer.inspect}, addresses: #{@addresses.inspect},"\
+      " telephones: #{@telephones.inspect}, email: #{@email.inspect}, accounts:"\
+      " #{@accounts.inspect}, relationship: #{@relationship.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end