genesis_ruby 0.3.1 → 0.3.2

data/lib/genesis_ruby/api/requests/non_financial/managed_recurring/cancel.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module ManagedRecurring
+          # Cancels an active managed recurring item by its unique identifier.
+          class Cancel < Base::Versioned
+
+            attr_writer :unique_id
+
+            # Cancel initialization
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'managed_recurring/items/:unique_id'
+            end
+
+            # Unique identifier of the managed recurring item
+            def unique_id
+              @unique_id.to_s
+            end
+
+            protected
+
+            # Override default Versioned Network configuration
+            def init_configuration
+              super
+
+              init_delete_configuration
+            end
+
+            # Cancel request field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[unique_id]
+            end
+
+            # Cancel request structure
+            def request_structure
+              {}
+            end
+
+            # Override API endpoint with provided Unique ID
+            def process_request_parameters
+              super
+
+              processed_path = request_path.gsub(':unique_id', unique_id.to_s)
+
+              init_api_gateway_configuration(
+                request_path:  "#{version}/#{processed_path}",
+                include_token: false
+              )
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module ManagedRecurring
+          # Retrieves details about a specific managed recurring item based on its unique ID.
+          class Fetch < Base::Versioned
+
+            attr_writer :unique_id
+
+            # Fetch initialization
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'managed_recurring/items/:unique_id'
+            end
+
+            # Unique identifier of the managed recurring item
+            def unique_id
+              @unique_id.to_s
+            end
+
+            protected
+
+            # Override default Versioned Network configuration
+            def init_configuration
+              super
+
+              init_get_configuration
+            end
+
+            # Fetch request field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[unique_id]
+            end
+
+            # Fetch request structure
+            def request_structure
+              {}
+            end
+
+            # Override API endpoint with provided Unique ID
+            def process_request_parameters
+              super
+
+              processed_path = request_path.gsub(':unique_id', unique_id.to_s)
+
+              init_api_gateway_configuration(
+                request_path:  "#{version}/#{processed_path}",
+                include_token: false
+              )
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/managed_recurring/fetch_all.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module ManagedRecurring
+          # Retrieves all active managed recurring items.
+          class FetchAll < Base::Versioned
+
+            # FetchAll initialization
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'managed_recurring/items'
+            end
+
+            protected
+
+            # Override default Versioned Network configuration
+            def init_configuration
+              super
+
+              init_get_configuration
+            end
+
+            # FetchAll request structure
+            def request_structure
+              {}
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          module Account
+            # Reverify a specific Account that belongs to a specific Payee.
+            class Reverify < Request
+
+              REQUEST_PATH = 'payee/:payee_unique_id/account/:account_unique_id/reverify'
+
+              attr_accessor :payee_unique_id, :account_unique_id
+
+              # Reverify Payee Account initialization
+              def initialize(configuration, _builder_interface = nil)
+                super configuration, Builder::JSON
+              end
+
+              protected
+
+              # Sets the request field validations
+              def init_field_validations
+                super
+
+                required_fields.push *%i[
+                  payee_unique_id account_unique_id
+                ]
+              end
+
+              # Request configuration
+              def init_configuration
+                init_json_configuration
+
+                api_config.type = METHOD_POST
+              end
+
+              # Override API endpoint configuration
+              def process_request_parameters
+                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
+
+                super
+              end
+
+              # Request structure
+              def populate_structure
+                @tree_structure = {}
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          # Associate Owners with a specific Payee.
+          class AssociatePayeeWithOwners < Base::NonFinancial::Payee::Base
+
+            attr_accessor :payee_unique_id
+
+            # Associate Payee With Owners initialization
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'payee/:payee_unique_id/owners'
+            end
+
+            # Add a single owner to the owners collection
+            def add_owner(unique_id:, **options)
+              raise GenesisRuby::InvalidArgumentError, 'Owner unique_id must be a String' unless unique_id.is_a?(String)
+              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[
+                payee_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(':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/payee/create.rb

@@ -11,7 +11,19 @@ module GenesisRuby
             PAYEE_TYPE_PERSON  = 'person'
             PAYEE_TYPE_COMPANY = 'company'
 
-            attr_accessor :payee_type, :payee_name, :payee_country
+            attr_accessor :payee_type, :payee_name, :payee_country, :payee_notification_url,
+                          :payee_registration_number, :payee_address_city, :payee_address_street,
+                          :payee_address_state, :payee_address_country, :payee_address_zip_code
+
+            # Payee date getter formatted as YYYY-MM-DD
+            def payee_date
+              @payee_date&.strftime GenesisRuby::Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+            end
+
+            # Payee date setter with date validation
+            def payee_date=(value)
+              parse_date attribute: __method__, value: value, allow_empty: true
+            end
 
             # Create Payee initialization
             def initialize(configuration, _builder_interface = nil)
@@ -30,17 +42,22 @@ module GenesisRuby
                 payee_type payee_name payee_country
               ]
 
-              field_values.merge! payee_type:    [PAYEE_TYPE_PERSON, PAYEE_TYPE_COMPANY],
-                                  payee_country: GenesisRuby::Utils::Country::COUNTRIES.keys
+              field_values.merge! payee_type:            [PAYEE_TYPE_PERSON, PAYEE_TYPE_COMPANY],
+                                  payee_country:         GenesisRuby::Utils::Country::COUNTRIES.keys,
+                                  payee_address_country: GenesisRuby::Utils::Country::COUNTRIES.keys
             end
 
             # Returns the request structure
-            def request_structure
+            def request_structure # rubocop:disable Metrics/MethodLength
               {
                 payee: {
-                  type:    payee_type,
-                  name:    payee_name,
-                  country: payee_country
+                  type:                payee_type,
+                  name:                payee_name,
+                  country:             payee_country,
+                  date:                payee_date,
+                  notification_url:    payee_notification_url,
+                  registration_number: payee_registration_number,
+                  address:             payee_address_structure
                 }
               }
             end
@@ -52,6 +69,19 @@ module GenesisRuby
               init_api_service_configuration request_path: request_path, include_token: false
             end
 
+            private
+
+            # Build the nested address structure
+            def payee_address_structure
+              {
+                city:     payee_address_city,
+                street:   payee_address_street,
+                state:    payee_address_state,
+                country:  payee_address_country,
+                zip_code: payee_address_zip_code
+              }
+            end
+
           end
         end
       end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'genesis_ruby/api/constants/non_financial/payee/document_types'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          # Create a Document for a specific Payee.
+          class CreatePayeeDocument < Base::NonFinancial::Payee::Base
+
+            attr_accessor :payee_unique_id, :document_type, :file
+
+            # Create Payee Document initialization
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'payee/:payee_unique_id/documents'
+            end
+
+            protected
+
+            # Sets the request field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[
+                payee_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(':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/payee/dissociate_payee_with_owners.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          # Dissociate Owners from a specific Payee.
+          class DissociatePayeeWithOwners < Base::NonFinancial::Payee::Base
+
+            attr_accessor :payee_unique_id
+
+            # Dissociate Payee With Owners initialization
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'payee/:payee_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[
+                payee_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(':payee_unique_id', payee_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

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Payee
+          # Retrieve the details of all Payees.
+          class List < Request
+
+            REQUEST_PATH = 'payee'
+
+            def initialize(configuration, _builder_interface = nil)
+              super configuration, Builder::JSON
+            end
+
+            protected
+
+            # Request configuration
+            def init_configuration
+              init_json_configuration
+
+              api_config.type = METHOD_GET
+
+              init_api_service_configuration request_path: REQUEST_PATH
+            end
+
+            # Request structure
+            def populate_structure
+              @tree_structure = {}
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

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

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