genesis_ruby 0.2.5 → 0.2.7

data/lib/genesis_ruby/api/requests/non_financial/fx/get_tiers.rb

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

data/lib/genesis_ruby/api/requests/non_financial/fx/search_rate.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Requests
@@ -48,9 +50,12 @@ module GenesisRuby
             def process_request_parameters
               super
 
-              request_path.sub!(':tier_id', tier_id)
+              processed_path = request_path.gsub(':tier_id', tier_id.to_s)
 
-              init_api_gateway_configuration request_path: "#{version}/#{request_path}", include_token: false
+              init_api_gateway_configuration(
+                request_path: "#{version}/#{processed_path}",
+                include_token: false
+              )
             end
 
           end

data/lib/genesis_ruby/api/requests/non_financial/installments/fetch.rb

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

data/lib/genesis_ruby/api/requests/non_financial/installments/show.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenesisRuby
   module Api
     module Requests
@@ -45,9 +47,12 @@ module GenesisRuby
             def process_request_parameters
               super
 
-              request_path.sub!(':installment_id', installment_id)
+              processed_path = request_path.gsub(':installment_id', installment_id.to_s)
 
-              init_api_gateway_configuration request_path: "#{version}/#{request_path}", include_token: false
+              init_api_gateway_configuration(
+                request_path: "#{version}/#{processed_path}",
+                include_token: false
+              )
             end
 
           end

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
@@ -51,7 +53,6 @@ module GenesisRuby
                 super
 
                 required_fields.push *%i[
-                  customer_information_structure
                   customer_unique_id
                   customer_registration_date
                   customer_registration_ip_address
@@ -59,7 +60,8 @@ module GenesisRuby
 
                 field_values.merge! device_fingerprint_type: [1, 2, 3],
                                     profile_action_type:     [1, 2],
-                                    profile_current_status:  [0, 1, 2, 3],
+                                    profile_current_status:
+                                      GenesisRuby::Api::Constants::NonFinancial::Kyc::ProfileCurrentStatuses.all,
                                     industry_type:           [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
                 field_values.merge! customer_information_required_field_values
               end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'genesis_ruby/api/constants/non_financial/kyc/profile_current_statuses'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Kyc
+          module ConsumerRegistration
+            # Update Consumer Registration Request class for KYC Non-Financial API services
+            class Update < Api::Requests::Base::NonFinancial::Kyc::Base
+
+              attr_accessor :reference_id, :profile_current_status, :status_reason
+
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'update_consumer'
+              end
+
+              protected
+
+              # Sets the request field validations
+              def init_field_validations
+                super
+
+                required_fields.push *%i[
+                  reference_id
+                  profile_current_status
+                ]
+
+                field_values.merge! profile_current_status:
+                  GenesisRuby::Api::Constants::NonFinancial::Kyc::ProfileCurrentStatuses.all
+              end
+
+              # Defines the request structure
+              def request_structure
+                {
+                  reference_id:           reference_id,
+                  profile_current_status: profile_current_status,
+                  status_reason:          status_reason
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

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