genesis_ruby 0.2.3 → 0.2.4

data/lib/genesis_ruby/api/requests/financial/wallets/pay_pal.rb

@@ -14,7 +14,6 @@ module GenesisRuby
             include Api::Mixins::Requests::Financial::Business::BusinessAttributes
             include Api::Mixins::Requests::DocumentAttributes
             include Api::Mixins::Requests::Financial::NotificationAttributes
-            include Api::Mixins::Requests::Financial::PaymentAttributes
             include Api::Mixins::Requests::Financial::NotificationAttributes
             include Api::Mixins::Requests::Financial::PendingPaymentAttributes
 
@@ -24,12 +23,13 @@ module GenesisRuby
 
             # Initialize PayPal request field validations
             def init_field_validations
+              super
+
               required_fields
                 .push *%i[transaction_id payment_type amount currency return_success_url return_failure_url]
 
-              field_values.merge! currency:     Api::Constants::Currencies::Iso4217.all.map(&:upcase),
-                                  payment_type: Api::Constants::Transactions::Parameters::Wallets::PayPal::
-                                      PaymentTypes.all
+              field_values.merge! payment_type:
+                Api::Constants::Transactions::Parameters::Wallets::PayPal::PaymentTypes.all
             end
 
             # PayPal transaction type
@@ -39,22 +39,20 @@ module GenesisRuby
 
             # PayPal request attributes structure
             def payment_transaction_structure # rubocop:disable Metrics/MethodLength
-              payment_attributes_structure.merge(
-                {
-                  notification_url:    notification_url,
-                  return_success_url:  return_success_url,
-                  return_failure_url:  return_failure_url,
-                  return_pending_url:  return_pending_url,
-                  customer_email:      customer_email,
-                  customer_phone:      customer_phone,
-                  payment_type:        payment_type,
-                  birth_date:          birth_date,
-                  document_id:         document_id,
-                  billing_address:     billing_address_parameters_structure,
-                  shipping_address:    shipping_address_parameters_structure,
-                  business_attributes: business_attributes_structure
-                }
-              )
+              {
+                notification_url:    notification_url,
+                return_success_url:  return_success_url,
+                return_failure_url:  return_failure_url,
+                return_pending_url:  return_pending_url,
+                customer_email:      customer_email,
+                customer_phone:      customer_phone,
+                payment_type:        payment_type,
+                birth_date:          birth_date,
+                document_id:         document_id,
+                billing_address:     billing_address_parameters_structure,
+                shipping_address:    shipping_address_parameters_structure,
+                business_attributes: business_attributes_structure
+              }
             end
 
           end

data/lib/genesis_ruby/api/requests/non_financial/consumers/create.rb

@@ -0,0 +1,44 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Consumers
+          # Creates a consumer based on email address
+          class Create < Base::Consumer
+
+            include Api::Mixins::Requests::CustomerAddress::BillingInfoAttributes
+            include Api::Mixins::Requests::CustomerAddress::ShippingInfoAttributes
+
+            attr_accessor :email
+
+            # Create Consumer constructor
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'create_consumer'
+            end
+
+            protected
+
+            # Create Consumer field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[email]
+            end
+
+            # Create Consumer request structure
+            def request_structure
+              {
+                email:            email,
+                billing_address:  billing_address_parameters_structure,
+                shipping_address: shipping_address_parameters_structure
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/consumers/disable.rb

@@ -0,0 +1,40 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Consumers
+          # Disable consumer from usage until further action.
+          class Disable < Base::Consumer
+
+            attr_accessor :email, :consumer_id
+
+            # Disable Consumer constructor
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'disable_consumer'
+            end
+
+            protected
+
+            # Disable consumer field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[email consumer_id]
+            end
+
+            # Disable Consumer request structure
+            def request_structure
+              {
+                email:       email,
+                consumer_id: consumer_id
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/consumers/enable.rb

@@ -0,0 +1,40 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Consumers
+          # Enable consumer that was disabled in the past.
+          class Enable < Base::Consumer
+
+            attr_accessor :email, :consumer_id
+
+            # Enable Consumer constructor
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'enable_consumer'
+            end
+
+            protected
+
+            # Enable consumer field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[email consumer_id]
+            end
+
+            # Enable Consumer request structure
+            def request_structure
+              {
+                email:       email,
+                consumer_id: consumer_id
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/consumers/get_cards.rb

@@ -0,0 +1,40 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Consumers
+          # Get previously tokenized card details for a consumer.
+          class GetCards < Base::Consumer
+
+            attr_accessor :email, :consumer_id
+
+            # GetCards Consumer constructor
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'get_consumer_cards'
+            end
+
+            protected
+
+            # GetCards consumer field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[email consumer_id]
+            end
+
+            # GetCards Consumer request structure
+            def request_structure
+              {
+                email:       email,
+                consumer_id: consumer_id
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Consumers
+          # Retrieves consumer details based on consumer id or email
+          class Retrieve < Base::Consumer
+
+            attr_accessor :email, :consumer_id
+
+            # Retrieve Consumer constructor
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'retrieve_consumer'
+            end
+
+            protected
+
+            # Retrieve Consumer custom field validations
+            def check_requirements
+              raise ParameterError, 'Either email or consumer_id field has to be set.' if email.nil? && consumer_id.nil?
+
+              super
+            end
+
+            # Retrieve Consumer request structure
+            def request_structure
+              {
+                email:       email,
+                consumer_id: consumer_id
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/consumers/update.rb

@@ -0,0 +1,45 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Consumers
+          # Updates consumer email and addresses.
+          class Update < Base::Consumer
+
+            include Api::Mixins::Requests::CustomerAddress::BillingInfoAttributes
+            include Api::Mixins::Requests::CustomerAddress::ShippingInfoAttributes
+
+            attr_accessor :email, :consumer_id
+
+            # Update Consumer constructor
+            def initialize(configuration, _builder_interface = nil)
+              super configuration
+
+              self.request_path = 'update_consumer'
+            end
+
+            protected
+
+            # Update Consumer field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[email consumer_id]
+            end
+
+            # Update Consumer request structure
+            def request_structure
+              {
+                email:            email,
+                consumer_id:      consumer_id,
+                billing_address:  billing_address_parameters_structure,
+                shipping_address: shipping_address_parameters_structure
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/fraud/retrieval/date_range.rb

@@ -0,0 +1,81 @@
+require 'genesis_ruby/api/constants/transactions/parameters/non_financial/externally_processed'
+require 'genesis_ruby/api/constants/transactions/parameters/non_financial/processing_type'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Fraud
+          module Retrieval
+            # Date range based retrieval request retrieval allows you to fetch information
+            # for all retrieval requests for a given merchant within a given date range
+            class DateRange < Api::Request
+
+              include Api::Mixins::Requests::NonFinancial::DateAttributes
+              include Api::Mixins::Requests::NonFinancial::PagingAttributes
+
+              attr_accessor :externally_processed, :processing_type
+
+              # Start of the requested date range
+              def start_date
+                @start_date&.strftime Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+              end
+
+              # End of the requested date range
+              def end_date
+                @end_date&.strftime Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+              end
+
+              # Date of import in the system
+              def import_date
+                @import_date&.strftime Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+              end
+
+              def import_date=(value)
+                parse_date attribute: __method__, value: value, allow_empty: true
+              end
+
+              protected
+
+              # Set Gateway API configuration
+              def init_configuration
+                init_xml_configuration
+                init_api_gateway_configuration request_path: 'retrieval_requests/by_date', include_token: false
+                @api_config.parser_skip_root_node = false
+              end
+
+              # Field Validations
+              def init_field_validations
+                super
+
+                constant_values = {
+                  externally_processed: Constants::Transactions::Parameters::NonFinancial::ExternallyProcessed.all,
+                  processing_type:      Constants::Transactions::Parameters::NonFinancial::ProcessingType.all
+                }
+
+                required_fields.push *%i[start_date]
+                field_values.merge! constant_values
+              end
+
+              # API Request structure
+              def populate_structure # rubocop:disable Metrics/MethodLength
+                @tree_structure = {
+                  retrieval_request_request: {
+                    start_date:           start_date,
+                    end_date:             end_date,
+                    import_date:          import_date,
+                    page:                 page,
+                    per_page:             per_page,
+                    externally_processed: externally_processed,
+                    processing_type:      processing_type
+                  }
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/non_financial/fraud/retrieval/transaction.rb

@@ -0,0 +1,52 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module Fraud
+          module Retrieval
+            # Retrieve a single retrieval request or a list of requests by ARN or by passing the unique ID
+            # of the original transaction.
+            class Transaction < Api::Request
+
+              include Api::Mixins::Requests::NonFinancial::ModeAttributes
+
+              attr_accessor :arn, :original_transaction_unique_id
+
+              protected
+
+              # Set Gateway API configuration
+              def init_configuration
+                init_xml_configuration
+                init_api_gateway_configuration request_path: 'retrieval_requests', include_token: false
+              end
+
+              # Retrieval custom field validations
+              def check_requirements
+                unless arn.nil? ^ original_transaction_unique_id.nil?
+                  raise(
+                    ParameterError,
+                    'Either arn or original_transaction_unique_id field has to be set, not both.'
+                  )
+                end
+
+                super
+              end
+
+              # API Request structure
+              def populate_structure
+                @tree_structure = {
+                  retrieval_request_request: {
+                    arn:                            arn,
+                    original_transaction_unique_id: original_transaction_unique_id,
+                    mode:                           mode
+                  }
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+require 'genesis_ruby/api/constants/transactions/parameters/non_financial/externally_processed'
+require 'genesis_ruby/api/constants/transactions/parameters/non_financial/processing_type'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module ProcessedTransactions
+          # Date range based processed transaction retrieval allows you to fetch information for
+          # all processed transactions for a given merchant within a given date range.
+          class DateRange < Request
+
+            include Api::Mixins::Requests::NonFinancial::DateAttributes
+            include Api::Mixins::Requests::NonFinancial::PagingAttributes
+
+            attr_accessor :externally_processed, :processing_type
+
+            # Start of the requested date range
+            def start_date
+              @start_date&.strftime GenesisRuby::Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+            end
+
+            # End of the requested date range
+            def end_date
+              @end_date&.strftime GenesisRuby::Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+            end
+
+            protected
+
+            # Processed Transactions API DateRange request configuration
+            def init_configuration
+              init_xml_configuration
+              @api_config.parser_skip_root_node = false
+
+              init_api_gateway_configuration request_path: 'processed_transactions/by_date', include_token: false
+            end
+
+            # Processed Transactions API DateRange field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[start_date]
+              field_values.merge! externally_processed: Constants::Transactions::Parameters::NonFinancial::
+                                      ExternallyProcessed.all,
+                                  processing_type:      Constants::Transactions::Parameters::NonFinancial::
+                                      ProcessingType.all
+            end
+
+            # Processed Transactions API DateRange request structure
+            def populate_structure
+              @tree_structure = {
+                processed_transaction_request: {
+                  start_date:           start_date,
+                  end_date:             end_date,
+                  externally_processed: externally_processed,
+                  processing_type:      processing_type,
+                  page:                 page,
+                  per_page:             per_page
+                }
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+require 'genesis_ruby/api/constants/transactions/parameters/non_financial/externally_processed'
+require 'genesis_ruby/api/constants/transactions/parameters/non_financial/processing_type'
+
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module ProcessedTransactions
+          # Post Date range based processed transaction retrieval allows you to fetch information for
+          # all processed transactions for a given merchant within a given post date range.
+          class PostDateRange < Request
+
+            include Api::Mixins::Requests::NonFinancial::DateAttributes
+            include Api::Mixins::Requests::NonFinancial::PagingAttributes
+
+            attr_accessor :batch_number, :batch_slip_number, :deposit_slip_number, :externally_processed,
+                          :processing_type
+
+            # Start of the requested date range
+            def start_date
+              @start_date&.strftime GenesisRuby::Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+            end
+
+            # End of the requested date range
+            def end_date
+              @end_date&.strftime GenesisRuby::Api::Constants::DateTimeFormats::YYYY_MM_DD_ISO_8601
+            end
+
+            protected
+
+            # Processed Transactions API DateRange request configuration
+            def init_configuration
+              init_xml_configuration
+              @api_config.parser_skip_root_node = false
+
+              init_api_gateway_configuration request_path: 'processed_transactions/by_post_date', include_token: false
+            end
+
+            # Processed Transactions API DateRange field validations
+            def init_field_validations
+              super
+
+              required_fields.push *%i[start_date]
+              field_values.merge! externally_processed: Constants::Transactions::Parameters::NonFinancial::
+                                      ExternallyProcessed.all,
+                                  processing_type:      Constants::Transactions::Parameters::NonFinancial::
+                                      ProcessingType.all
+            end
+
+            # Processed Transactions API DateRange request structure
+            def populate_structure # rubocop:disable Metrics/MethodLength
+              @tree_structure = {
+                processed_transaction_request: {
+                  start_date:           start_date,
+                  end_date:             end_date,
+                  batch_number:         batch_number,
+                  batch_slip_number:    batch_slip_number,
+                  deposit_slip_number:  deposit_slip_number,
+                  externally_processed: externally_processed,
+                  processing_type:      processing_type,
+                  page:                 page,
+                  per_page:             per_page
+                }
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module GenesisRuby
+  module Api
+    module Requests
+      module NonFinancial
+        module ProcessedTransactions
+          # Single processed transaction retrieval allows to get a certain processed transaction by
+          # its ARN or by passing its unique ID.
+          class Transaction < Request
+
+            attr_accessor :arn, :unique_id
+
+            protected
+
+            # Processed Transactions API Transaction request configuration
+            def init_configuration
+              init_xml_configuration
+
+              init_api_gateway_configuration request_path: 'processed_transactions', include_token: false
+            end
+
+            # Processed Transactions API Transaction custom validations
+            def check_requirements
+              unless arn.nil? ^ unique_id.nil?
+                raise(
+                  ParameterError,
+                  'Either ARN or unique ID field has to be set, not both'
+                )
+              end
+
+              super
+            end
+
+            # Processed Transactions API Transaction request structure
+            def populate_structure
+              @tree_structure = {
+                processed_transaction_request: {
+                  arn:       arn,
+                  unique_id: unique_id
+                }
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end