genesis_ruby 0.2.5 → 0.2.7

data/lib/genesis_ruby/api/requests/non_financial/kyc/transaction/create.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+require 'genesis_ruby/api/constants/non_financial/kyc/transaction_statuses'
+require 'genesis_ruby/api/constants/non_financial/kyc/industry_types'
+require 'genesis_ruby/api/constants/non_financial/kyc/order_sources'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Kyc
+          module Transaction
+            # Create transaction type for KYC Non-Financial API services
+            class Create < Api::Requests::Base::NonFinancial::Kyc::Base # rubocop:disable Metrics/ClassLength
+
+              include Api::Mixins::Requests::Financial::PaymentAttributes
+              include Api::Mixins::Requests::NonFinancial::Kyc::DepositLimitsAttributes
+              include Api::Mixins::Requests::NonFinancial::Kyc::CustomerInformationAttributes
+              include Api::Mixins::Requests::NonFinancial::Kyc::KycBillingInfoAttributes
+              include Api::Mixins::Requests::NonFinancial::Kyc::KycShippingInfoAttributes
+              include Api::Mixins::Requests::NonFinancial::Kyc::PaymentDetailsAttributes
+
+              attr_accessor :session_id, :customer_username, :customer_unique_id, :customer_status,
+                            :customer_loyalty_level, :customer_registration_ip_address,
+                            :customer_registration_device_id, :transaction_unique_id,
+                            :customer_ip_address, :customer_device_id,
+                            :third_party_device_id, :device_fingerprint, :device_fingerprint_type,
+                            :shopping_cart_items_count, :order_source, :merchant_website, :industry_type,
+                            :customer_password, :custom_variable, :transaction_status
+
+              attr_writer   :deposits_count, :withdrawals_count, :current_balance, :rule_context
+
+              # Initializes the Create Transaction Request
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'create_transaction'
+              end
+
+              # Returns customer registration date
+              def customer_registration_date
+                @customer_registration_date&.strftime GenesisRuby::Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+              end
+
+              # Sets customer registration date
+              def customer_registration_date=(value)
+                parse_date attribute: __method__, value: value, allow_empty: true
+              end
+
+              # Returns the first deposit date
+              def first_deposit_date
+                @first_deposit_date&.strftime GenesisRuby::Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+              end
+
+              # Sets the first deposit date
+              def first_deposit_date=(value)
+                parse_date attribute: __method__, value: value, allow_empty: true
+              end
+
+              # Returns the first withdrawal date
+              def first_withdrawal_date
+                @first_withdrawal_date&.strftime GenesisRuby::Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+              end
+
+              # Sets the first withdrawal date
+              def first_withdrawal_date=(value)
+                parse_date attribute: __method__, value: value, allow_empty: true
+              end
+
+              # Returns the local time in the format YYYY-MM-DD HH:MM:SS
+              def local_time
+                @local_time&.strftime GenesisRuby::Api::Constants::DateTimeFormats::YYYY_MM_DD_H_I_S
+              end
+
+              # Sets the local time
+              def local_time=(value)
+                parse_date attribute: __method__, value: value, allow_empty: true
+              end
+
+              # Returns the transaction created at date in the format YYYY-MM-DD HH:MM:SS
+              def transaction_created_at
+                @transaction_created_at&.strftime GenesisRuby::Api::Constants::DateTimeFormats::YYYY_MM_DD_H_I_S
+              end
+
+              # Sets the transaction created at date
+              def transaction_created_at=(value)
+                parse_date attribute: __method__, value: value, allow_empty: true
+              end
+
+              # Returns the deposits count as an integer
+              def deposits_count
+                @deposits_count&.to_i
+              end
+
+              # Returns the withdrawals count as an integer
+              def withdrawals_count
+                @withdrawals_count&.to_i
+              end
+
+              # Returns the current balance as an integer
+              def current_balance
+                @current_balance&.to_i
+              end
+
+              # Returns the rule context as an integer
+              def rule_context
+                @rule_context&.to_i
+              end
+
+              protected
+
+              # Sets field values and dependencies for the Create Transaction Request
+              def init_field_validations # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+                super
+
+                required_fields.push *%i[
+                  transaction_unique_id
+                  transaction_created_at
+                  customer_ip_address
+                ] + customer_information_required_fields + deposit_limits_required_fields
+
+                field_values.merge! transaction_status:      Api::Constants::NonFinancial::Kyc::TransactionStatuses.all,
+                                    device_fingerprint_type: [1, 2, 3],
+                                    order_source:            GenesisRuby::Api::Constants::NonFinancial::Kyc::OrderSources.all, # rubocop:disable Layout/LineLength
+                                    industry_type:           Api::Constants::NonFinancial::Kyc::IndustryTypes.all,
+                                    payment_method:          GenesisRuby::Api::Constants::NonFinancial::Kyc::CreateTransactionPaymentMethods.all # rubocop:disable Layout/LineLength
+
+                pm_const = GenesisRuby::Api::Constants::NonFinancial::Kyc::CreateTransactionPaymentMethods
+                field_value_dependencies.merge!(
+                  {
+                    payment_method: {
+                      pm_const::PAYMENT_METHOD_CC          => %i[bin tail],
+                      pm_const::PAYMENT_METHOD_CC_OPTIONAL => %i[cvv_present hashed_pan],
+                      pm_const::PAYMENT_METHOD_EC          => %i[routing account]
+                    }
+                  }
+                )
+
+                field_values.merge! customer_information_required_field_values
+              end
+
+              # Returns the request structure for Create Transaction Request
+              def request_structure # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+                {
+                  session_id:                       session_id,
+                  customer_username:                customer_username,
+                  customer_unique_id:               customer_unique_id,
+                  customer_status:                  customer_status,
+                  customer_loyalty_level:           customer_loyalty_level,
+                  customer_registration_date:       customer_registration_date,
+                  customer_registration_ip_address: customer_registration_ip_address,
+                  customer_registration_device_id:  customer_registration_device_id,
+                  customer_information:             customer_information_structure,
+                  first_deposit_date:               first_deposit_date,
+                  first_withdrawal_date:            first_withdrawal_date,
+                  deposits_count:                   deposits_count,
+                  withdrawals_count:                withdrawals_count,
+                  current_balance:                  current_balance,
+                  deposit_limits:                   deposit_limits_structure,
+                  transaction_unique_id:            transaction_unique_id,
+                  billing_information:              kyc_billing_info_structure,
+                  shipping_information:             kyc_shipping_info_structure,
+                  payment_details:                  payment_details_structure,
+                  amount:                           amount,
+                  currency:                         currency,
+                  transaction_created_at:           transaction_created_at,
+                  transaction_status:               transaction_status,
+                  customer_ip_address:              customer_ip_address,
+                  customer_device_id:               customer_device_id,
+                  third_party_device_id:            third_party_device_id,
+                  device_fingerprint:               device_fingerprint,
+                  device_fingerprint_type:          device_fingerprint_type,
+                  shopping_cart_items_count:        shopping_cart_items_count,
+                  local_time:                       local_time,
+                  order_source:                     order_source,
+                  merchant_website:                 merchant_website,
+                  industry_type:                    industry_type,
+                  customer_password:                customer_password,
+                  rule_context:                     rule_context,
+                  custom_variable:                  custom_variable
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/kyc/transaction/update.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'genesis_ruby/api/constants/non_financial/kyc/transaction_statuses'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Kyc
+          module Transaction
+            # Utilize this method to update a particular transaction status so we can continue improving the data models
+            # and provide the best scores and recommendations.
+            class Update < Api::Requests::Base::NonFinancial::Kyc::Base
+
+              attr_accessor :session_id,
+                            :transaction_unique_id,
+                            :reason,
+                            :reference_id,
+                            :cvv_check_result,
+                            :avs_check_result,
+                            :processor_identifier
+              attr_writer   :transaction_status
+
+              # Initialize the Update transaction request
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'update_transaction'
+              end
+
+              # Returns the transaction status as an integer
+              def transaction_status
+                @transaction_status&.to_i
+              end
+
+              # Initializes the required fields and their validations
+              def init_field_validations
+                required_fields.push *%i[transaction_unique_id]
+
+                field_values.merge! transaction_status: Api::Constants::NonFinancial::Kyc::TransactionStatuses.all
+              end
+
+              # Returns the request structure for the Update transaction request
+              def request_structure
+                {
+                  session_id:            session_id,
+                  transaction_unique_id: transaction_unique_id,
+                  reference_id:          reference_id,
+                  transaction_status:    transaction_status,
+                  reason:                reason,
+                  cvv_check_result:      cvv_check_result,
+                  avs_check_result:      avs_check_result,
+                  processor_identifier:  processor_identifier
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/kyc/verifications/create.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'genesis_ruby/api/constants/non_financial/kyc/address_supported_types'
+require 'genesis_ruby/api/constants/non_financial/kyc/languages'
+require 'genesis_ruby/api/constants/non_financial/kyc/verification_modes'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Kyc
+          module Verifications
+            # The verification request will provide a link that will be used to redirect the customer.
+            # The customer will provide the required documents and will be verified against them.
+            # As a result, the user will be redirected back to merchant based on the provided redirect URL.
+            class Create < Api::Requests::Base::NonFinancial::Kyc::Base
+
+              include Api::Mixins::Requests::NonFinancial::Kyc::BackgroundChecksAttributes
+              include Api::Mixins::Requests::NonFinancial::Kyc::FaceAttributes
+              include Api::Mixins::Requests::NonFinancial::Kyc::VerificationAttributes
+              include Api::Mixins::Requests::NonFinancial::Kyc::VerificationDocumentAttributes
+
+              attr_accessor :language, :address_backside_proof_required, :allow_retry, :verification_mode
+              attr_reader   :redirect_url, :address_supported_types
+
+              # Initializes the Create Verification Request
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'verifications'
+              end
+
+              # URL where the customer is sent to after completing the verification process
+              def redirect_url=(value)
+                unless GenesisRuby::Utils::Common.valid_url?(value)
+                  raise ParameterError, "Invalid URL given for #{__method__}"
+                end
+
+                @redirect_url = value
+              end
+
+              # Supported types of address that can be verified
+              def address_supported_types=(value)
+                parse_array_of_strings attribute:   __method__,
+                                       value:       value,
+                                       allowed:     Api::Constants::NonFinancial::Kyc::AddressSupportedTypes.all,
+                                       allow_empty: true
+              end
+
+              protected
+
+              def init_field_validations
+                required_fields.push *%i[email]
+
+                field_values.merge!(
+                  language:                        Api::Constants::NonFinancial::Kyc::Languages.all,
+                  address_backside_proof_required: [true, false],
+                  allow_retry:                     [true, false],
+                  verification_mode:               Api::Constants::NonFinancial::Kyc::VerificationModes.all
+                )
+              end
+
+              # Returns request structure for the Create verification
+              def request_structure # rubocop:disable Metrics/MethodLength
+                {
+                  email:                           email,
+                  country:                         country,
+                  language:                        language,
+                  redirect_url:                    redirect_url,
+                  reference_id:                    reference_id,
+                  document_supported_types:        document_supported_types,
+                  address_supported_types:         address_supported_types,
+                  face:                            face_attributes_structure,
+                  backside_proof_required:         backside_proof_required,
+                  address_backside_proof_required: address_backside_proof_required,
+                  expiry_date:                     expiry_date,
+                  allow_retry:                     allow_retry,
+                  verification_mode:               verification_mode,
+                  background_checks:               background_checks_attributes_structure,
+                  document:                        verification_document_attributes_structure
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/kyc/verifications/register.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Kyc
+          module Verifications
+            # Verification register request can be performed by reference_id. A reference id registration
+            # allows you to store the reference id in Genesis and receive notifications in Genesis for it.
+            class Register < Api::Requests::Base::NonFinancial::Kyc::Base
+
+              include Api::Mixins::Requests::Financial::ReferenceAttributes
+
+              # Initialize the request
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'verifications/register'
+              end
+
+              protected
+
+              # Set the request field validations
+              def init_field_validations
+                super
+
+                required_fields.push *%i[reference_id]
+              end
+
+              # Return request structure
+              def request_structure
+                {
+                  reference_id: reference_id
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/kyc/verifications/remote_identity.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Kyc
+          module Verifications
+            # Remote Identity Verification Request class for KYC Non-Financial API services
+            class RemoteIdentity < Api::Requests::Base::NonFinancial::Kyc::Base
+
+              include Api::Mixins::Requests::NonFinancial::Kyc::DocumentAttributes
+              include Api::Mixins::Requests::NonFinancial::Kyc::VerificationAttributes
+
+              # Initializes the Remote Identity Verification Request
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'verifications'
+              end
+
+              protected
+
+              # Performs validation checks for the Remote Identity verification request
+              def check_requirements
+                raise ParameterError, 'Either email or reference_id field has to be set.' if email.nil? && reference_id.nil? # rubocop:disable Layout/LineLength
+
+                super
+              end
+
+              # Returns request structure for the Remote Identity verification
+              def request_structure
+                {
+                  email:                    email,
+                  reference_id:             reference_id,
+                  country:                  country,
+                  backside_proof_required:  backside_proof_required,
+                  expiry_date:              expiry_date,
+                  document_supported_types: document_supported_types,
+                  document:                 document_attributes_structure
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/kyc/verifications/status.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Kyc
+          module Verifications
+            # Verification status check request can be performed by reference_id. A status check may be needed
+            # if async notification has not arrived yet or when kyc notifications are not used in general.
+            class Status < Api::Requests::Base::NonFinancial::Kyc::Base
+
+              include Api::Mixins::Requests::Financial::ReferenceAttributes
+
+              # Initialize the request
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'verifications/status'
+              end
+
+              protected
+
+              # Set the request field validations
+              def init_field_validations
+                super
+
+                required_fields.push *%i[reference_id]
+              end
+
+              # Return request structure
+              def request_structure
+                {
+                  reference_id: reference_id
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/payee/account/create.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          module Account
+            # Create a Account related to a specific Payee.
+            class Create < Base::Versioned
+
+              PAYEE_ACCOUNT_TYPE_IBAN = 'iban'
+              PAYEE_ACCOUNT_TYPE_BANK = 'bank'
+
+              attr_accessor :payee_unique_id, :payee_account_type, :payee_account_number, :payee_account_country,
+                            :payee_account_institution_code
+
+              # Retrieve Payee initialization
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'payee/:payee_unique_id/account'
+              end
+
+              protected
+
+              # Sets the request field validations
+              def init_field_validations # rubocop:disable Metrics/MethodLength
+                super
+
+                required_fields.push *%i[
+                  payee_unique_id payee_account_type payee_account_number
+                ]
+                field_values.merge! payee_account_type:    [PAYEE_ACCOUNT_TYPE_IBAN, PAYEE_ACCOUNT_TYPE_BANK],
+                                    payee_account_country: GenesisRuby::Utils::Country::COUNTRIES.keys
+                field_value_dependencies.merge!(
+                  {
+                    payee_account_type: {
+                      PAYEE_ACCOUNT_TYPE_BANK => %i[payee_account_institution_code]
+                    }
+                  }
+                )
+              end
+
+              # Returns the request structure
+              def request_structure
+                {
+                  account: {
+                    type:             payee_account_type,
+                    number:           payee_account_number,
+                    country:          payee_account_country,
+                    institution_code: payee_account_institution_code
+
+                  }
+                }
+              end
+
+              # Override API endpoint configuration
+              def process_request_parameters
+                super
+
+                processed_path = request_path.dup.gsub(':payee_unique_id', payee_unique_id.to_s)
+
+                init_api_service_configuration request_path: processed_path, include_token: false
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/payee/account/list.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          module Account
+            # Retrieve the details of all Account records that belongs to specific Payee.
+            class List < Base::Versioned
+
+              attr_accessor :payee_unique_id, :number_eq, :type_eq, :institution_code_eq
+
+              # Retrieve Payee initialization
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'payee/:payee_unique_id/account'
+              end
+
+              protected
+
+              # Override default Versioned Network configuration
+              def init_configuration
+                super
+
+                init_get_configuration
+              end
+
+              # Sets the request field validations
+              def init_field_validations
+                super
+
+                required_fields.push *%i[
+                  payee_unique_id
+                ]
+              end
+
+              # Returns the request structure
+              def request_structure
+                {}
+              end
+
+              # Override API endpoint configuration
+              def process_request_parameters
+                processed_path  = request_path.dup.gsub(':payee_unique_id', payee_unique_id.to_s)
+
+                query_params    = build_query_params
+                processed_path += "?#{query_params}" unless query_params.empty?
+
+                init_api_service_configuration request_path: processed_path, include_token: false
+
+                super
+              end
+
+              private
+
+              # Build query parameters from filter fields
+              def build_query_params
+                params = {}
+                params['number_eq']           = number_eq if number_eq
+                params['type_eq']             = type_eq if type_eq
+                params['institution_code_eq'] = institution_code_eq if institution_code_eq
+
+                URI.encode_www_form(params)
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end