genesis_ruby 0.3.1 → 0.3.2

data/lib/genesis_ruby/api/requests/non_financial/billing_api/statement.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'genesis_ruby/api/constants/date_time_formats'
+require 'genesis_ruby/api/constants/currencies/iso4217'
+require 'genesis_ruby/api/constants/transactions/parameters/non_financial/billing_api/statement_response_fields'
+require 'genesis_ruby/api/requests/base/non_financial/billing_api/base'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module BillingApi
+          # Billing Statements API request
+          class Statement < Base::NonFinancial::BillingApi::Base # rubocop:disable Metrics/ClassLength
+
+            MAX_COUNT_BILLING_STATEMENT = 1_000
+            MAX_DAYS_DIFFERENCE         = 7
+
+            # Allowed values for the +status+ filter
+            STATUSES          = %w(open pending paid bounced).freeze
+
+            # Allowed values for the +sort_by_field+ parameter
+            ORDER_BY_FIELDS   = %w(billingStatement creationDate startDate endDate valueDate
+                                   currency status masterAccountName).freeze
+
+            attr_accessor :payment_method, :status
+            attr_reader :currency
+
+            # Cursor for the next page of results
+            attr_writer :next
+
+            def currency=(value)
+              @currency = value.to_s.empty? ? nil : value.to_s.upcase
+            end
+
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.root_key     = 'query'
+              self.request_name = 'billingStatements'
+              self.request_path = 'billing_statements'
+            end
+
+            # List of requested response fields
+            def response_fields
+              @response_fields || []
+            end
+
+            # Sets response fields validated against StatementResponseFields
+            def response_fields=(value)
+              parse_array_of_strings attribute: __method__,
+                                     value: value,
+                                     allowed: Api::Constants::Transactions::Parameters::NonFinancial::BillingApi::
+                                         StatementResponseFields.all
+            end
+
+            # Returns the creation date formatted as YYYY-MM-DD
+            def creation_date
+              @creation_date&.strftime(Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601)
+            end
+
+            # Sets the creation date filter
+            def creation_date=(value)
+              parse_date attribute: __method__, value: value, allow_empty: true
+            end
+
+            protected
+
+            # Adds response_fields to the list of required fields
+            def init_field_validations
+              super
+
+              required_fields.push :response_fields
+              field_values.merge! currency:      Api::Constants::Currencies::Iso4217.all.map(&:upcase),
+                                  status:        STATUSES,
+                                  sort_by_field: ORDER_BY_FIELDS
+            end
+
+            # Validates all request requirements including filters and date ranges
+            def check_requirements
+              super
+
+              validate_filters
+              validate_date_range(:start_date, :end_date, MAX_DAYS_DIFFERENCE) if @start_date || @end_date
+              if @start_date_from || @start_date_to
+                validate_date_range(:start_date_from, :start_date_to, MAX_DAYS_DIFFERENCE)
+              end
+              validate_date_range(:end_date_from, :end_date_to, MAX_DAYS_DIFFERENCE) if @end_date_from || @end_date_to
+              validate_array_size :billing_statement, MAX_COUNT_BILLING_STATEMENT
+            end
+
+            # Builds the GraphQL query filters hash
+            def query_filters # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+              filters = {
+                startDate:        escape_argument(:start_date),
+                endDate:          escape_argument(:end_date),
+                startDateFrom:    escape_argument(:start_date_from),
+                startDateTo:      escape_argument(:start_date_to),
+                endDateFrom:      escape_argument(:end_date_from),
+                endDateTo:        escape_argument(:end_date_to),
+                billingStatement: billing_statement.empty? ? nil : billing_statement,
+                currency:         escape_string(currency),
+                status:           status,
+                paymentMethod:    escape_string(payment_method),
+                creationDate:     escape_string(creation_date)
+              }
+
+              { filter: filters, **paging_and_sort }
+            end
+
+            # Builds the GraphQL response fields structure including paging metadata
+            def query_response_fields
+              {
+                items:  format_response_fields,
+                paging: %w(count perPage after before)
+              }
+            end
+
+            # Merges sort and cursor-based paging into a single hash, omitting empty values
+            def paging_and_sort
+              result = {}
+              result[:sort]   = { byDirection: sort_by_direction, byField: sort_by_field }.compact
+              result[:paging] = cursor_paging
+              result.reject { |_, v| v.empty? }
+            end
+
+            # Builds the cursor-based paging hash
+            def cursor_paging
+              paging = {}
+              paging[:perPage] = per_page if per_page
+              paging[:next]    = "\"#{@next}\"" if @next
+              paging
+            end
+
+            # Maps response field names to their expanded GraphQL representations
+            def format_response_fields
+              response_fields.map { |field| complex_field(field) }
+            end
+
+            # Expands summary and details fields into their full GraphQL sub-selections
+            def complex_field(field)
+              case field
+              when 'summary'
+                'summary { grossVolume debit credit fees taxes netReserves adjustments ' \
+                  'netSettlementAmount paymentFxConversionFee paymentAmount paymentCurrency }'
+              when 'details'
+                'details { transactionTypesBreakdown { category transactionType count amount } }'
+              else
+                field
+              end
+            end
+
+            # Raises an error when no filter attributes are set
+            def validate_filters # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+              return unless start_date.nil? && end_date.nil? &&
+                            start_date_from.nil? && start_date_to.nil? &&
+                            end_date_from.nil? && end_date_to.nil? &&
+                            billing_statement.empty? && currency.nil? &&
+                            status.nil? && payment_method.nil? && creation_date.nil?
+
+              raise ParameterError, 'At least one filter is required!'
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/billing_api/transactions.rb

@@ -13,11 +13,14 @@ module GenesisRuby
         module BillingApi
           # Billing Transactions API allows to programmatically retrieve information about billing transactions
           # using given filters, pagination, and sort parameters.
-          class Transactions < Base::Graphql # rubocop:disable Metrics/ClassLength
+          class Transactions < Base::NonFinancial::BillingApi::Base # rubocop:disable Metrics/ClassLength
 
-            include Api::Mixins::Requests::NonFinancial::BillingApi::SortAttributes
-            include Api::Mixins::Requests::NonFinancial::DateAttributes
-            include Api::Mixins::Requests::NonFinancial::PagingAttributes
+            MAX_UNIQUE_ID_COUNT              = 1_000
+            MAX_BILLING_STATEMENT_COUNT      = 10
+            MAX_MERCHANT_TRANSACTION_COUNT   = 1_000
+            MAX_MASTER_ACCOUNT_NAME_COUNT    = 10
+            MAX_TRANSACTION_TYPE_COUNT       = 10
+            MAX_DAYS_DIFFERENCE              = 7
 
             def initialize(configuration, _builder_interface = nil)
               super configuration
@@ -40,32 +43,22 @@ module GenesisRuby
                                          ResponseFields.all
             end
 
-            # List of billing transaction unique IDs. Max number of elements is 10000. Primary filter.
+            # List of billing transaction unique IDs. Max number of elements is 1000. Primary filter.
             def unique_id
               @unique_id || []
             end
 
-            # List of billing transaction unique IDs. Max number of elements is 10000. Primary filter.
+            # List of billing transaction unique IDs. Max number of elements is 1000. Primary filter.
             def unique_id=(value)
               parse_array_of_strings attribute: __method__, value: value, allow_empty: true
             end
 
-            # List of billing statement names. Max number of elements allowed is 10. Primary filter.
-            def billing_statement
-              @billing_statement || []
-            end
-
-            # List of billing statement names. Max number of elements allowed is 10. Primary filter.
-            def billing_statement=(value)
-              parse_array_of_strings attribute: __method__, value: value, allow_empty: true
-            end
-
-            # List of merchant transaction IDs. Max number of elements allowed is 10000. Primary filter.
+            # List of merchant transaction IDs. Max number of elements allowed is 1000. Primary filter.
             def merchant_transaction_id
               @merchant_transaction_id || []
             end
 
-            # List of merchant transaction IDs. Max number of elements allowed is 10000. Primary filter.
+            # List of merchant transaction IDs. Max number of elements allowed is 1000. Primary filter.
             def merchant_transaction_id=(value)
               parse_array_of_strings attribute: __method__, value: value, allow_empty: true
             end
@@ -96,16 +89,11 @@ module GenesisRuby
 
             protected
 
-            # Billing API Authorization Token
-            def init_authorization_token
-              api_config.bearer_token = configuration.billing_api_token
-            end
-
             # Billing API Transactions field validations
             def init_field_validations
               super
 
-              required_fields.push *%i[response_fields]
+              required_fields.push :response_fields
               field_values.merge! sort_by_direction: Api::Constants::Transactions::Parameters::NonFinancial::
                                       SortDirections.all,
                                   sort_by_field: Api::Constants::Transactions::Parameters::NonFinancial::BillingApi::
@@ -117,7 +105,7 @@ module GenesisRuby
               super
 
               validate_filters
-              validate_dates if @start_date || @end_date
+              validate_date_range(:start_date, :end_date, MAX_DAYS_DIFFERENCE) if @start_date || @end_date
               validate_array_fields_size
             end
 
@@ -152,49 +140,21 @@ module GenesisRuby
               }
             end
 
-            # Format given timestamp string to GraphQL suitable argument
-            def escape_argument(attribute)
-              __send__(attribute).to_s.empty? ? nil : "\"#{__send__(attribute)}\""
-            end
-
             # Validate Billing API Primary filters
             def validate_filters
-              unless start_date.nil? && end_date.nil? && unique_id.empty? && billing_statement.empty? &&
-                     merchant_transaction_id.empty?
-                return
-              end
+              return unless start_date.nil? && end_date.nil? && unique_id.empty? && billing_statement.empty? &&
+                            merchant_transaction_id.empty?
 
               raise ParameterError, 'At least one Primary filter is required!'
             end
 
-            # Validate StartDate and EndDate
-            def validate_dates
-              message   = 'If filter startDate is provided, then endDate should also be provided and vice versa.'
-              raise ParameterError, message unless @start_date.is_a?(DateTime) && @end_date.is_a?(DateTime)
-
-              raise ParameterError, 'EndData must be after StartDate!' if @start_date == @end_date
-
-              days_diff = @end_date - @start_date
-              message   = 'Maximum difference between StartDate and EndDate is 7 days'
-              raise ParameterError, message unless days_diff >= 0 && days_diff <= 7
-            end
-
             # Validate Billing API Array field requirements
             def validate_array_fields_size
-              validate_array_size :unique_id, 10_000
-              validate_array_size :billing_statement, 10
-              validate_array_size :merchant_transaction_id, 10_000
-              validate_array_size :master_account_name, 10
-              validate_array_size :transaction_type, 10
-            end
-
-            # Validate Max size of the given Array attribute
-            def validate_array_size(attribute, size)
-              message = format 'Max array length on %{attribute} exceed allowed size of %{size}',
-                               attribute: attribute,
-                               size:      size
-
-              raise ParameterError, message if __send__(attribute).length > size
+              validate_array_size :unique_id, MAX_UNIQUE_ID_COUNT
+              validate_array_size :billing_statement, MAX_BILLING_STATEMENT_COUNT
+              validate_array_size :merchant_transaction_id, MAX_MERCHANT_TRANSACTION_COUNT
+              validate_array_size :master_account_name, MAX_MASTER_ACCOUNT_NAME_COUNT
+              validate_array_size :transaction_type, MAX_TRANSACTION_TYPE_COUNT
             end
 
           end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Kyc
+          module Business
+            # Create a Business record
+            class Create < Api::Requests::Base::NonFinancial::Kyc::Base
+
+              attr_accessor :registration_number, :country, :name
+
+              # Initializes the Create Business Request
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'businesses'
+              end
+
+              protected
+
+              # Sets the request field validations
+              def init_field_validations
+                super
+
+                required_fields.push *%i[registration_number country]
+              end
+
+              # Returns the request structure for the Create Business request
+              def request_structure
+                {
+                  registration_number: registration_number,
+                  country:             country,
+                  name:                name
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/kyc/business/document.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Kyc
+          module Business
+            # Get a specific document related to the business entity
+            class Document < Api::Requests::Base::NonFinancial::Kyc::Base
+
+              attr_accessor :business_id, :id
+
+              # Initializes the Business Document Request
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'businesses/:business_id/documents/:id'
+              end
+
+              protected
+
+              # Override default KYC Network configuration for GET request
+              def init_configuration
+                super
+
+                init_get_configuration
+              end
+
+              # Sets the request field validations
+              def init_field_validations
+                super
+
+                required_fields.push *%i[business_id id]
+              end
+
+              # Business Document request structure
+              def request_structure
+                {}
+              end
+
+              # Override API endpoint with provided business ID and document ID
+              def process_request_parameters
+                super
+
+                processed_path = request_path.gsub(':business_id', business_id.to_s)
+                                             .gsub(':id', 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/business/document_list.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Kyc
+          module Business
+            # Get a list of documents related to the business entity
+            class DocumentList < Api::Requests::Base::NonFinancial::Kyc::Base
+
+              attr_accessor :business_id
+
+              # Initializes the Business Document List Request
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'businesses/:business_id/documents'
+              end
+
+              protected
+
+              # Override default KYC Network configuration for GET request
+              def init_configuration
+                super
+
+                init_get_configuration
+              end
+
+              # Sets the request field validations
+              def init_field_validations
+                super
+
+                required_fields.push *%i[business_id]
+              end
+
+              # Business Document List request structure
+              def request_structure
+                {}
+              end
+
+              # Override API endpoint with provided business ID
+              def process_request_parameters
+                super
+
+                processed_path = request_path.gsub(':business_id', business_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/business/verification.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Kyc
+          module Business
+            # Performs verification of a specific Business record based on its ID
+            class Verification < Api::Requests::Base::NonFinancial::Kyc::Base
+
+              attr_accessor :business_id
+
+              # Initializes the Business Verification Request
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'businesses/:business_id/verification'
+              end
+
+              protected
+
+              # Sets the request field validations
+              def init_field_validations
+                super
+
+                required_fields.push *%i[business_id]
+              end
+
+              # Business Verification request structure
+              def request_structure
+                {}
+              end
+
+              # Override API endpoint with provided business ID
+              def process_request_parameters
+                super
+
+                processed_path = request_path.gsub(':business_id', business_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/verifications/address_by_document_proof.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'genesis_ruby/api/constants/non_financial/kyc/address_document_supported_types'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Kyc
+          module Verifications
+            # Address Verification by Document Proof
+            # Verification of customer address using a document.
+            class AddressByDocumentProof < Api::Requests::Base::NonFinancial::Kyc::Base
+
+              include Api::Mixins::Requests::NonFinancial::Kyc::DocumentAttributes
+
+              attr_accessor :reference_id
+              attr_reader :backside_proof_required, :with_enhanced_address_verification, :with_async_workflow
+
+              # Supported types of document that can be verified for address verification
+              def document_supported_types=(value)
+                parse_array_of_strings attribute: __method__,
+                                       value: value,
+                                       allowed: Api::Constants::NonFinancial::Kyc::AddressDocumentSupportedTypes.all,
+                                       allow_empty: true
+              end
+
+              # Supported types of document that can be verified for address verification
+              def document_supported_types
+                @document_supported_types || []
+              end
+
+              # Initializes the Address Verification by Document Proof Request
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'verifications/address/by_proof'
+              end
+
+              # A flag to enable the enhanced address verification
+              def with_enhanced_address_verification=(value)
+                allowed_options attribute: __method__,
+                                allowed: [true, false],
+                                value: value,
+                                allow_empty: true,
+                                error_message: 'Accepts only boolean values'
+              end
+
+              # Signifies that both sides of the document are required to verify the address
+              def backside_proof_required=(value)
+                allowed_options attribute: __method__,
+                                allowed: [true, false],
+                                value: value,
+                                allow_empty: true,
+                                error_message: 'Accepts only boolean values'
+              end
+
+              # A flag that controls whether the request is sent synchronously or asynchronously
+              def with_async_workflow=(value)
+                allowed_options attribute: __method__,
+                                allowed: [true, false],
+                                value: value,
+                                allow_empty: true,
+                                error_message: 'Accepts only boolean values'
+              end
+
+              protected
+
+              # Set the request field validations
+              def init_field_validations
+                required_fields.push *%i[reference_id document_supported_types full_address proof]
+              end
+
+              # Returns request structure for the Address Verification by Document Proof
+              def request_structure
+                {
+                  reference_id:                       reference_id,
+                  document_supported_types:           document_supported_types,
+                  backside_proof_required:            backside_proof_required,
+                  with_enhanced_address_verification: with_enhanced_address_verification,
+                  with_async_workflow:                with_async_workflow,
+                  document:                           document_attributes_structure
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,6 +3,7 @@
 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'
+require 'genesis_ruby/api/mixins/requests/non_financial/kyc/business_attributes'
 
 module GenesisRuby
   module Api
@@ -19,6 +20,7 @@ module GenesisRuby
               include Api::Mixins::Requests::NonFinancial::Kyc::FaceAttributes
               include Api::Mixins::Requests::NonFinancial::Kyc::VerificationAttributes
               include Api::Mixins::Requests::NonFinancial::Kyc::VerificationDocumentAttributes
+              include Api::Mixins::Requests::NonFinancial::Kyc::BusinessAttributes
 
               attr_accessor :language, :address_backside_proof_required, :allow_retry, :verification_mode
               attr_reader   :redirect_url, :address_supported_types
@@ -77,7 +79,8 @@ module GenesisRuby
                   allow_retry:                     allow_retry,
                   verification_mode:               verification_mode,
                   background_checks:               background_checks_attributes_structure,
-                  document:                        verification_document_attributes_structure
+                  document:                        verification_document_attributes_structure,
+                  business:                        business_attributes_structure
                 }
               end