genesis_ruby 0.2.6 → 0.2.7

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

@@ -1,4 +1,4 @@
-require 'genesis_ruby/api/constants/non_financial/kyc/document_supported_types'
+# frozen_string_literal: true
 
 module GenesisRuby
   module Api
@@ -10,6 +10,7 @@ module GenesisRuby
             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)
@@ -18,48 +19,6 @@ module GenesisRuby
                 self.request_path = 'verifications'
               end
 
-              attr_accessor :reference_id, :country, :backside_proof_required
-              attr_reader   :email
-
-              # Sets the email address for the Remote Identity verification
-              def email=(value)
-                raise InvalidArgumentError unless value =~ /\A.+@.+\..+\Z/
-
-                @email = value
-              end
-
-              # Gets the expiry date for the Remote Identity verification
-              def expiry_date
-                @expiry_date&.strftime(
-                  Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
-                )
-              end
-
-              # Sets the expiry date for the Remote Identity verification
-              def expiry_date=(value)
-                parse_date attribute: __method__, value: value, allow_empty: true
-              end
-
-              # Sets the document supported types for the Remote Identity verification
-              def document_supported_types=(value)
-                parse_array_of_strings attribute: __method__,
-                                       value: value,
-                                       allowed: Api::Constants::NonFinancial::Kyc::DocumentSupportedTypes.all
-              end
-
-              # Returns the document supported types for the Remote Identity verification
-              def document_supported_types
-                @document_supported_types || []
-              end
-
-              # Initializes field validations for the Remote Identity verification request
-              def init_field_validations
-                super
-
-                field_values.merge! country: GenesisRuby::Utils::Country::COUNTRIES.keys.map(&:upcase),
-                                    backside_proof_required: [true, false]
-              end
-
               protected
 
               # Performs validation checks for the Remote Identity verification request

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

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          module Account
+            # Retrieve the details of a specific Account record based on it's unique ID that belongs to specific Payee.
+            class Retrieve < Base::Versioned
+
+              attr_accessor :payee_unique_id, :account_unique_id
+
+              # Retrieve Payee initialization
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'payee/:payee_unique_id/account/:account_unique_id'
+              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 account_unique_id
+                ]
+              end
+
+              # Returns the request structure
+              def request_structure
+                {}
+              end
+
+              # Override API endpoint configuration
+              def process_request_parameters
+                super
+
+                processed_path = request_path.dup
+                                             .gsub(':payee_unique_id', payee_unique_id.to_s)
+                                             .gsub(':account_unique_id', account_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/create.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          # Create a Payee record.
+          class Create < Base::Versioned
+
+            PAYEE_TYPE_PERSON  = 'person'
+            PAYEE_TYPE_COMPANY = 'company'
+
+            attr_accessor :payee_type, :payee_name, :payee_country
+
+            # Create Payee initialization
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'payee'
+            end
+
+            protected
+
+            # Sets the request field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[
+                payee_type payee_name payee_country
+              ]
+
+              field_values.merge! payee_type:    [PAYEE_TYPE_PERSON, PAYEE_TYPE_COMPANY],
+                                  payee_country: GenesisRuby::Utils::Country::COUNTRIES.keys
+            end
+
+            # Returns the request structure
+            def request_structure
+              {
+                payee: {
+                  type:    payee_type,
+                  name:    payee_name,
+                  country: payee_country
+                }
+              }
+            end
+
+            # Override API endpoint configuration
+            def process_request_parameters
+              super
+
+              init_api_service_configuration request_path: request_path, include_token: false
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/payee/retrieve.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          # Retrieve the details of a specific a Payee record based on it's unique ID.
+          class Retrieve < Base::Versioned
+
+            attr_accessor :payee_unique_id
+
+            # Retrieve Payee initialization
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'payee/:payee_unique_id'
+            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
+              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

data/lib/genesis_ruby/api/requests/non_financial/processed_transactions/date_range.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'genesis_ruby/api/constants/transactions/parameters/non_financial/externally_processed'
 require 'genesis_ruby/api/constants/transactions/parameters/non_financial/processing_type'
 

data/lib/genesis_ruby/api/requests/non_financial/processed_transactions/post_date_range.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'genesis_ruby/api/constants/transactions/parameters/non_financial/externally_processed'
 require 'genesis_ruby/api/constants/transactions/parameters/non_financial/processing_type'
 

data/lib/genesis_ruby/api/requests/non_financial/processed_transactions/transaction.rb

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

data/lib/genesis_ruby/api/requests/non_financial/reconcile/date_range.rb

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

data/lib/genesis_ruby/api/requests/non_financial/reconcile/transaction.rb

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

data/lib/genesis_ruby/api/requests/non_financial/sca/checker.rb

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

data/lib/genesis_ruby/api/requests/non_financial/tokenization/cryptogram.rb

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

data/lib/genesis_ruby/api/requests/non_financial/tokenization/delete_token.rb

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

data/lib/genesis_ruby/api/requests/non_financial/tokenization/detokenize.rb

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

data/lib/genesis_ruby/api/requests/non_financial/tokenization/get_card.rb

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

data/lib/genesis_ruby/api/requests/non_financial/tokenization/tokenize.rb

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

data/lib/genesis_ruby/api/requests/non_financial/tokenization/update_token.rb

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

data/lib/genesis_ruby/api/requests/non_financial/tokenization/validate_token.rb

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

data/lib/genesis_ruby/api/requests/wpf/create.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'genesis_ruby/utils/transactions/wpf_types'
 require 'genesis_ruby/api/constants/transactions/parameters/sca_exemptions'
 require 'genesis_ruby/api/constants/i18n'

data/lib/genesis_ruby/api/requests/wpf/reconcile.rb

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

data/lib/genesis_ruby/api/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'genesis_ruby/errors/response_error'
 require 'genesis_ruby/parser'
 require 'genesis_ruby/api/constants/states'