genesis_ruby 0.2.6 → 0.2.7

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

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'genesis_ruby/api/constants/non_financial/kyc/service_languages'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Kyc
+          module Call
+            # Create Call Request class for KYC Non-Financial API services
+            # This method is used to make a call or send an SMS to a given phone number.
+            class Create < Api::Requests::Base::NonFinancial::Kyc::Base
+
+              SERVICE_TYPE_SMS   = 1
+              SERVICE_TYPE_VOICE = 2
+
+              VALID_SERVICE_TYPES = [SERVICE_TYPE_SMS, SERVICE_TYPE_VOICE].freeze
+
+              attr_accessor :customer_username, :customer_unique_id, :transaction_unique_id, :service_language,
+                            :service_type
+              attr_reader   :customer_phone_number, :security_code
+
+              # Initialize the Make Call document request
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'create_authentication'
+              end
+
+              # Set the customer username for the Make Call request
+              def customer_phone_number=(value)
+                error_message = format(
+                  'Invalid value given for %{attribute}',
+                  attribute: __method__
+                )
+                raise GenesisRuby::InvalidArgumentError, error_message unless value.nil? || value =~ /^\d+$/
+
+                @customer_phone_number = value
+              end
+
+              # Set the service type for the Make Call request
+              def security_code=(value)
+                error_message = format(
+                  'Invalid value given for %{attribute}',
+                  attribute: __method__
+                )
+                raise GenesisRuby::InvalidArgumentError, error_message unless value.nil? || value =~ /^[1-9]\d{3}$/
+
+                @security_code = value
+              end
+
+              protected
+
+              # Initialize field validations for the Make Call request
+              def init_field_validations
+                super
+
+                required_fields.push *%i[
+                  transaction_unique_id
+                  customer_phone_number
+                  service_language
+                  security_code
+                  service_type
+                ]
+
+                field_values.merge! service_type:     VALID_SERVICE_TYPES,
+                                    service_language: GenesisRuby::Api::Constants::NonFinancial::Kyc::ServiceLanguages.all # rubocop:disable Layout/LineLength
+              end
+
+              # Build the request structure for the Make Call request
+              def request_structure
+                {
+                  customer_unique_id:    customer_unique_id,
+                  customer_username:     customer_username,
+                  transaction_unique_id: transaction_unique_id,
+                  customer_phone_number: customer_phone_number,
+                  service_language:      service_language,
+                  security_code:         security_code,
+                  service_type:          service_type
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'genesis_ruby/api/constants/non_financial/kyc/verification_statuses'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Kyc
+          module Call
+            # Update Call Request class for KYC Non-Financial API services
+            # This method is used to update the call status with the latest info received from the main system.
+            # It also updates the transaction associated with this verification call.
+            class Update < Api::Requests::Base::NonFinancial::Kyc::Base
+
+              attr_accessor :reference_id, :security_code_input
+              attr_writer   :verification_status
+
+              # Initialize the Update Call document request
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'update_authentication'
+              end
+
+              def verification_status
+                @verification_status.to_s
+              end
+
+              protected
+
+              # Initialize the field validations for the Update Call request
+              def init_field_validations
+                super
+
+                required_fields.push *%i[
+                  reference_id
+                  security_code_input
+                  verification_status
+                ]
+
+                field_values.merge! verification_status: Constants::NonFinancial::Kyc::VerificationStatuses.all
+              end
+
+              # Build the request structure for the Update Call request
+              def request_structure
+                {
+                  reference_id:        reference_id,
+                  security_code_input: security_code_input,
+                  verification_status: verification_status
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/kyc/cnpj/check.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Kyc
+          module Cnpj
+            # Check the status of a specific Brazilian company's CNPJ number
+            class Check < Api::Requests::Base::NonFinancial::Kyc::Base
+
+              include Api::Mixins::Requests::DocumentAttributes
+
+              # Initializes the CNPJ Check Request
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'cnpj/:document_id'
+              end
+
+              protected
+
+              # Sets the request field validations
+              def init_field_validations
+                super
+
+                required_fields.push *%i[document_id]
+              end
+
+              # CNPJ Check request structure
+              def request_structure
+                {}
+              end
+
+              # Override API endpoint with provided document ID
+              def process_request_parameters
+                super
+
+                processed_path = request_path.gsub(':document_id', document_id.to_s)
+
+                init_kyc_service_configuration(
+                  request_path: "api/#{version}/#{processed_path}"
+                )
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Requests

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'genesis_ruby/api/constants/non_financial/kyc/profile_current_statuses'
 
 module GenesisRuby

data/lib/genesis_ruby/api/requests/non_financial/kyc/cpf/check.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Kyc
+          module Cpf
+            # Check the status of a specific Brazilian personal's CPF number
+            class Check < Api::Requests::Base::NonFinancial::Kyc::Base
+
+              include Api::Mixins::Requests::DocumentAttributes
+
+              # Initializes the CPF Check Request
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'cpf/:document_id'
+              end
+
+              protected
+
+              # Sets the request field validations
+              def init_field_validations
+                super
+
+                required_fields.push *%i[document_id]
+              end
+
+              # CPF Check request structure
+              def request_structure
+                {}
+              end
+
+              # Override API endpoint with provided document ID
+              def process_request_parameters
+                super
+
+                processed_path = request_path.gsub(':document_id', document_id.to_s)
+
+                init_kyc_service_configuration(
+                  request_path: "api/#{version}/#{processed_path}"
+                )
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/kyc/identity_document/download.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Kyc
+          module IdentityDocument
+            # Uploaded documents will be stored by legal provisions and they can be requested for review.
+            class Download < Api::Requests::Base::NonFinancial::Kyc::Base
+
+              attr_accessor :identity_document_id
+
+              # Initialize the Download document request
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'download_document'
+              end
+
+              protected
+
+              # Initializes the required fields for the Download Document request
+              def init_field_validations
+                super
+
+                required_fields.push *%i[identity_document_id]
+              end
+
+              # Returns the request structure for the Download Document request
+              def request_structure
+                {
+                  identity_document_id: identity_document_id
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/kyc/identity_document/upload.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'genesis_ruby/api/constants/non_financial/kyc/identity_document_methods'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Kyc
+          module IdentityDocument
+            # Used to verify documents provided by the customer.
+            class Upload < Api::Requests::Base::NonFinancial::Kyc::Base
+
+              include Api::Mixins::Requests::NonFinancial::Kyc::IdentityDocumentAttributes
+
+              attr_accessor :customer_username, :customer_unique_id, :transaction_unique_id, :reference_id, :method
+
+              # Initialize the Upload Document request
+              def initialize(configuration, _builder_interface = nil)
+                super(configuration)
+
+                self.request_path = 'upload_document'
+              end
+
+              protected
+
+              # Initializes the required fields for the Upload Document request
+              def init_field_validations
+                super
+
+                required_fields.push *%i[
+                  method
+                ]
+
+                field_values.merge! method: GenesisRuby::Api::Constants::NonFinancial::Kyc::IdentityDocumentMethods.all
+              end
+
+              # Validates the request parameters
+              def check_requirements
+                raise ParameterError, 'Either transaction_unique_id or reference_id field has to be set.' if transaction_unique_id.nil? && reference_id.nil? # rubocop:disable Layout/LineLength
+                raise ParameterError, 'Add at least one document' if docs.empty?
+
+                super
+              end
+
+              # Returns the request structure for the Upload Document request
+              def request_structure # rubocop:disable Metrics/MethodLength
+                {
+                  customer_username:     customer_username,
+                  customer_unique_id:    customer_unique_id,
+                  transaction_unique_id: transaction_unique_id,
+                  reference_id:          reference_id,
+                  method:                method,
+                  doc:                   get_doc(0),
+                  doc2:                  get_doc(1),
+                  doc3:                  get_doc(2),
+                  doc4:                  get_doc(3)
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

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