genesis_ruby 0.3.1 → 0.3.2

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          # Retrieve the details of all Owner records that belongs to specific Payee.
+          class ListPayeeOwners < Base::NonFinancial::Payee::Base
+
+            attr_accessor :payee_unique_id, :type
+
+            # List Payee Owners initialization
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'payee/:payee_unique_id/owners'
+            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['type'] = type if type
+
+              URI.encode_www_form(params)
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/payee/owners/associate_owner_with_owners.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          module Owners
+            # Associate Owners with a specific Owner.
+            class AssociateOwnerWithOwners < Base::NonFinancial::Payee::Base
+
+              attr_accessor :owner_unique_id
+
+              # Associate Owner With Owners initialization
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'payee/owners/:owner_unique_id/owners'
+              end
+
+              # Add a single owner to the owners collection
+              def add_owner(unique_id:, **options)
+                unless unique_id.is_a?(String)
+                  raise GenesisRuby::InvalidArgumentError, 'Owner unique_id must be a String'
+                end
+                raise GenesisRuby::InvalidArgumentError, 'Owner unique_id is required' if unique_id.empty?
+
+                validate_percent_ownership(options[:percent_ownership]) if options.key?(:percent_ownership)
+
+                owners << { unique_id: unique_id }.merge(options)
+              end
+
+              # Assign owners collection with validation
+              def owners=(value)
+                if value.nil?
+                  @owners = nil
+                elsif !value.is_a?(Array)
+                  raise GenesisRuby::InvalidArgumentError, 'Owners must be an Array'
+                else
+                  validate_owners_collection(value)
+                  @owners = value
+                end
+              end
+
+              protected
+
+              # Owners collection
+              def owners
+                @owners ||= []
+              end
+
+              # Sets the request field validations
+              def init_field_validations
+                super
+
+                required_fields.push *%i[
+                  owner_unique_id
+                  owners
+                ]
+              end
+
+              private
+
+              # Validate the owners collection entries
+              def validate_owners_collection(value)
+                value.each_with_index do |owner, index|
+                  unless owner.is_a?(Hash) && owner[:unique_id].is_a?(String) && !owner[:unique_id].empty?
+                    raise GenesisRuby::InvalidArgumentError,
+                          "Owner at index #{index} must be a Hash with a non-empty String unique_id"
+                  end
+
+                  validate_percent_ownership(owner[:percent_ownership]) if owner.key?(:percent_ownership)
+                end
+              end
+
+              # Validate percent_ownership value when provided
+              def validate_percent_ownership(value)
+                return if value.nil?
+
+                raise GenesisRuby::InvalidArgumentError, 'percent_ownership must be numeric' unless value.is_a?(Numeric)
+
+                return if value >= 0.0 && value <= 100.0
+
+                raise GenesisRuby::InvalidArgumentError, 'percent_ownership must be between 0.0 and 100.0'
+              end
+
+              # Returns the request structure
+              def request_structure
+                {
+                  owners: owners
+                }
+              end
+
+              # Override API endpoint configuration
+              def process_request_parameters
+                super
+
+                processed_path = request_path.dup.gsub(':owner_unique_id', owner_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/owners/create.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'genesis_ruby/api/constants/non_financial/payee/owner_types'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          module Owners
+            # Create an Owner entity.
+            class Create < Base::NonFinancial::Payee::Base
+
+              attr_accessor :owner_type, :owner_name, :owner_country, :owner_date,
+                            :notification_url, :registration_number, :owner_address,
+                            :payees, :owners
+
+              # Create Owner initialization
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'payee/owners'
+              end
+
+              protected
+
+              # Sets the request field validations
+              def init_field_validations
+                super
+
+                required_fields.push *%i[
+                  owner_type
+                                       owner_name
+                                       owner_country
+                ]
+
+                field_values.merge! owner_type: GenesisRuby::Api::Constants::NonFinancial::Payee::OwnerTypes.all,
+                                    owner_country: GenesisRuby::Utils::Country::COUNTRIES.keys
+              end
+
+              # Returns the request structure
+              def request_structure # rubocop:disable Metrics/MethodLength
+                {
+                  owner: {
+                    type:                owner_type,
+                    name:                owner_name,
+                    country:             owner_country,
+                    date:                owner_date,
+                    notification_url:    notification_url,
+                    registration_number: registration_number,
+                    address:             owner_address,
+                    payees:              payees,
+                    owners:              owners
+                  }
+                }
+              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
+end

data/lib/genesis_ruby/api/requests/non_financial/payee/owners/create_owner_document.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'genesis_ruby/api/constants/non_financial/payee/document_types'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          module Owners
+            # Create a Document for a specific Owner.
+            class CreateOwnerDocument < Base::NonFinancial::Payee::Base
+
+              attr_accessor :owner_unique_id, :document_type, :file
+
+              # Create Owner Document initialization
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'payee/owners/:owner_unique_id/documents'
+              end
+
+              protected
+
+              # Sets the request field validations
+              def init_field_validations
+                super
+
+                required_fields.push *%i[
+                  owner_unique_id
+                                       document_type
+                                       file
+                ]
+
+                field_values.merge! document_type: GenesisRuby::Api::Constants::NonFinancial::Payee::DocumentTypes.all
+              end
+
+              # Returns the request structure
+              def request_structure
+                {
+                  document: {
+                    document_type: document_type,
+                    file:          file
+                  }
+                }
+              end
+
+              # Override API endpoint configuration
+              def process_request_parameters
+                super
+
+                processed_path = request_path.dup.gsub(':owner_unique_id', owner_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/owners/delete.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          module Owners
+            # Delete an Owner entity.
+            class Delete < Base::NonFinancial::Payee::Base
+
+              attr_accessor :owner_unique_id
+
+              # Delete Owner initialization
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'payee/owners/:owner_unique_id'
+
+                init_delete_configuration
+              end
+
+              protected
+
+              # Sets the request field validations
+              def init_field_validations
+                super
+
+                required_fields.push *%i[
+                  owner_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(':owner_unique_id', owner_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/owners/dissociate_owners.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          module Owners
+            # Dissociate Owners from a specific Owner.
+            class DissociateOwners < Base::NonFinancial::Payee::Base
+
+              attr_accessor :owner_unique_id
+
+              # Dissociate Owners initialization
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'payee/owners/:owner_unique_id/owners'
+
+                init_delete_configuration
+              end
+
+              # Add a unique_id to the collection of owners to dissociate
+              def add_unique_id(value)
+                raise GenesisRuby::InvalidArgumentError, 'Unique ID must be a String' unless value.is_a?(String)
+                raise GenesisRuby::InvalidArgumentError, 'Unique ID is required' if value.empty?
+
+                unique_ids << value
+              end
+
+              # Assign unique_ids collection with validation
+              def unique_ids=(value)
+                if value.nil?
+                  @unique_ids = nil
+                elsif !value.is_a?(Array)
+                  raise GenesisRuby::InvalidArgumentError, 'Unique IDs must be an Array'
+                else
+                  validate_unique_ids_collection(value)
+                  @unique_ids = value
+                end
+              end
+
+              protected
+
+              # Unique IDs collection
+              def unique_ids
+                @unique_ids ||= []
+              end
+
+              # Sets the request field validations
+              def init_field_validations
+                super
+
+                required_fields.push *%i[
+                  owner_unique_id
+                  unique_ids
+                ]
+              end
+
+              # Returns the request structure
+              def request_structure
+                {
+                  owners: {
+                    unique_ids: unique_ids
+                  }
+                }
+              end
+
+              # Override API endpoint configuration
+              def process_request_parameters
+                super
+
+                processed_path = request_path.dup.gsub(':owner_unique_id', owner_unique_id.to_s)
+
+                init_api_service_configuration request_path: processed_path, include_token: false
+              end
+
+              private
+
+              # Validate unique_ids collection entries
+              def validate_unique_ids_collection(value)
+                value.each_with_index do |uid, index|
+                  unless uid.is_a?(String) && !uid.empty?
+                    raise GenesisRuby::InvalidArgumentError,
+                          "Unique ID at index #{index} must be a non-empty String"
+                  end
+                end
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/payee/owners/list_owner_documents.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          module Owners
+            # Retrieve the details of all Document records that belongs to specific Owner.
+            class ListOwnerDocuments < Base::NonFinancial::Payee::Base
+
+              attr_accessor :owner_unique_id
+
+              # List Owner Documents initialization
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'payee/owners/:owner_unique_id/documents'
+              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[
+                  owner_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(':owner_unique_id', owner_unique_id.to_s)
+
+                init_api_service_configuration request_path: processed_path, include_token: false
+
+                super
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/payee/owners/list_owners.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          module Owners
+            # Retrieve the details of all Owner records.
+            class ListOwners < Base::NonFinancial::Payee::Base
+
+              # List Owners initialization
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'payee/owners'
+              end
+
+              protected
+
+              # Override default Versioned Network configuration
+              def init_configuration
+                super
+
+                init_get_configuration
+              end
+
+              # Returns the request structure
+              def request_structure
+                {}
+              end
+
+              # Override API endpoint configuration
+              def process_request_parameters
+                init_api_service_configuration request_path: request_path, include_token: false
+
+                super
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          module Owners
+            # Retrieve the details of a specific Owner.
+            class Retrieve < Base::NonFinancial::Payee::Base
+
+              attr_accessor :owner_unique_id
+
+              # Retrieve Owner initialization
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'payee/owners/:owner_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[
+                  owner_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(':owner_unique_id', owner_unique_id.to_s)
+
+                init_api_service_configuration request_path: processed_path, include_token: false
+
+                super
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/payee/owners/retrieve_owner_document.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          module Owners
+            # Retrieve the details of a specific Document for a specific Owner.
+            class RetrieveOwnerDocument < Base::NonFinancial::Payee::Base
+
+              attr_accessor :owner_unique_id, :document_unique_id
+
+              # Retrieve Owner Document initialization
+              def initialize(configuration, _builder_interface = nil)
+                super configuration
+
+                self.request_path = 'payee/owners/:owner_unique_id/documents/:document_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[
+                  owner_unique_id
+                                       document_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(':owner_unique_id', owner_unique_id.to_s)
+                                             .gsub(':document_unique_id', document_unique_id.to_s)
+
+                init_api_service_configuration request_path: processed_path, include_token: false
+
+                super
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end