genesis_ruby 0.2.3 → 0.2.5

data/lib/genesis_ruby/api/constants/transactions/parameters/purpose_of_payment.rb

@@ -0,0 +1,136 @@
+module GenesisRuby
+  module Api
+    module Constants
+      module Transactions
+        module Parameters
+          # Purpose of Payment
+          class PurposeOfPayment
+
+            extend Mixins::Constants::Common
+
+            # Interest
+            ISINTE = 'ISINTE'.freeze
+
+            # Income tax
+            ISINTX = 'ISINTX'.freeze
+
+            # Investment
+            ISINVS = 'ISINVS'.freeze
+
+            # Labor insurance
+            ISLBRI = 'ISLBRI'.freeze
+
+            # License fee
+            ISLICF = 'ISLICF'.freeze
+
+            # Life insurance
+            ISLIFI = 'ISLIFI'.freeze
+
+            # Loan
+            ISLOAN = 'ISLOAN'.freeze
+
+            # Medical services
+            ISMDCS = 'ISMDCS'.freeze
+
+            # Mobile P2B payment
+            ISMP2B = 'ISMP2B'.freeze
+
+            # Mobile P2P payment
+            ISMP2P = 'ISMP2P'.freeze
+
+            # Mobile top up
+            ISMTUP = 'ISMTUP'.freeze
+
+            # Not otherwise specified
+            ISNOWS = 'ISNOWS'.freeze
+
+            # Other
+            ISOTHR = 'ISOTHR'.freeze
+
+            # Transaction is related to a payment of other telecom related bill
+            ISOTLC = 'ISOTLC'.freeze
+
+            # Payroll
+            ISPAYR = 'ISPAYR'.freeze
+
+            # Contribution to pension fund
+            ISPEFC = 'ISPEFC'.freeze
+
+            # Pension payment
+            ISPENS = 'ISPENS'.freeze
+
+            # Payment of telephone bill
+            ISPHON = 'ISPHON'.freeze
+
+            # Property insurance
+            ISPPTI = 'ISPPTI'.freeze
+
+            # Transaction is for general rental/lease
+            ISRELG = 'ISRELG'.freeze
+
+            # The payment of rent
+            ISRENT = 'ISRENT'.freeze
+
+            # Payment for railway transport related business
+            ISRLWY = 'ISRLWY'.freeze
+
+            # Royalties
+            ISROYA = 'ISROYA'.freeze
+
+            # Salary payment
+            ISSALA = 'ISSALA'.freeze
+
+            # Payment to savings/retirement account
+            ISSAVG = 'ISSAVG'.freeze
+
+            # Securities
+            ISSECU = 'ISSECU'.freeze
+
+            # Social security benefit
+            ISSSBE = 'ISSSBE'.freeze
+
+            # Study
+            ISSTDY = 'ISSTDY'.freeze
+
+            # Subscription
+            ISSUBS = 'ISSUBS'.freeze
+
+            # Supplier payment
+            ISSUPP = 'ISSUPP'.freeze
+
+            # Refund of a tax payment or obligation
+            ISTAXR = 'ISTAXR'.freeze
+
+            # Tax payment
+            ISTAXS = 'ISTAXS'.freeze
+
+            # Transaction is related to a payment of telecommunications related bill
+            ISTBIL = 'ISTBIL'.freeze
+
+            # Trade services operation
+            ISTRAD = 'ISTRAD'.freeze
+
+            # Treasury payment
+            ISTREA = 'ISTREA'.freeze
+
+            # Payment for travel
+            ISTRPT = 'ISTRPT'.freeze
+
+            # Utility bill payment
+            ISUBIL = 'ISUBIL'.freeze
+
+            # Value added tax payment
+            ISVATX = 'ISVATX'.freeze
+
+            # With holding
+            ISWHLD = 'ISWHLD'.freeze
+
+            # Payment of water bill
+            ISWTER = 'ISWTER'.freeze
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/constants/transactions/parameters/source_of_funds.rb

@@ -0,0 +1,34 @@
+module GenesisRuby
+  module Api
+    module Constants
+      module Transactions
+        module Parameters
+          # Source of Funds
+          class SourceOfFunds
+
+            extend Mixins::Constants::Common
+
+            # Source of Funds Credit
+            CREDIT               = 'credit'.freeze
+
+            # Source of Funds Debit
+            DEBIT                = 'debit'.freeze
+
+            # Source of Funds Prepaid
+            PREPAID              = 'prepaid'.freeze
+
+            # Source of Funds Cash
+            CASH                 = 'cash'.freeze
+
+            # Source of Funds Other Debit Account
+            OTHER_DEBIT_ACCOUNT  = 'other_debit_account'.freeze
+
+            # Source of funds Other Credit Account
+            OTHER_CREDIT_ACCOUNT = 'other_credit_account'.freeze
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/digital_asset_type_attributes.rb

@@ -0,0 +1,26 @@
+require 'genesis_ruby/api/constants/transactions/parameters/digital_asset_types'
+
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        # Digital Asset Type Attributes mixin
+        module DigitalAssetTypeAttributes
+
+          attr_reader :digital_asset_type
+
+          # When performing crypto currency transaction with a VISA card there is an option
+          # to specify the digital asset type for detailed identification of the current crypto
+          # currency transaction
+          def digital_asset_type=(value)
+            allowed_options attribute:   __method__,
+                            allowed:     GenesisRuby::Api::Constants::Transactions::Parameters::DigitalAssetTypes.all,
+                            value:       value,
+                            allow_empty: true
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/african_mobile_attributes.rb

@@ -0,0 +1,30 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          # African Mobile Attributes mixin
+          module AfricanMobileAttributes
+
+            attr_reader :target, :operator
+
+            # Number of the Paybill for which the transaction is intended
+            def target=(value)
+              limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 20
+            end
+
+            # Name of the Mobile network operator which should process the transaction
+            def operator=(value)
+              allowed_options attribute: __method__,
+                              allowed:
+                                GenesisRuby::Api::Constants::Transactions::Parameters::AfricanMobileOperators.all,
+                              value: value.to_s.upcase,
+                              allow_empty: false
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/beneficiary_attributes.rb

@@ -0,0 +1,38 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          # The beneficiary parameters attributes
+          module BeneficiaryAttributes
+
+            attr_accessor :beneficiary_name
+            attr_reader   :beneficiary_document_id, :beneficiary_pix_key
+
+            # The Document ID of the beneficiary, such as CPF or CNPJ for Brazilian entities
+            def beneficiary_document_id=(value)
+              limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 14
+            end
+
+            # The PIX key associated with the beneficiary
+            def beneficiary_pix_key=(value)
+              limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 36
+            end
+
+            protected
+
+            # Beneficiary parameters structure
+            def beneficiary_parameters_structure
+              {
+                name:        beneficiary_name,
+                document_id: beneficiary_document_id,
+                pix_key:     beneficiary_pix_key
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/cards/tokenization_params_attributes.rb

@@ -0,0 +1,36 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          module Cards
+            # Tokenization Params Attributes mixin
+            module TokenizationParamsAttributes
+
+              attr_accessor :tokenization_tavv
+              attr_reader :tokenization_eci
+
+              # Electronic Commerce Indicator (ECI) is a value that is returned from the Directory Server
+              # (Visa, MasterCard, etc.) to indicate the authentication results of your customer’s
+              # credit card payment on 3D Secure
+              def tokenization_eci=(value)
+                limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 2
+              end
+
+              protected
+
+              # Tokenization Params Attributes Structure
+              def tokenization_params_attributes_structure
+                {
+                  eci:  tokenization_eci,
+                  tavv: tokenization_tavv
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/customer_account_attributes.rb

@@ -0,0 +1,21 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          # Customer Account Attributes
+          module CustomerAccountAttributes
+
+            attr_reader :customer_account_id
+
+            # Customer account id parameter validation
+            def customer_account_id=(value)
+              limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 20
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/customer_identification_attributes.rb

@@ -0,0 +1,82 @@
+require 'genesis_ruby/api/constants/transactions/parameters/customer_identification/customer_identification_owner'
+require 'genesis_ruby/api/constants/transactions/parameters/customer_identification/customer_identification_type'
+require 'genesis_ruby/api/constants/transactions/parameters/customer_identification/customer_identification_subtype'
+require 'genesis_ruby/utils/country'
+
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          # Customer Identification Attributes
+          module CustomerIdentificationAttributes
+
+            attr_accessor :customer_identification_document_id
+
+            attr_reader   :customer_identification_owner, :customer_identification_type,
+                          :customer_identification_subtype, :customer_identification_issuing_country
+
+            # Customer Identification Owner
+            def customer_identification_owner=(value)
+              allowed_options(
+                attribute: __method__,
+                allowed:
+                  GenesisRuby::Api::Constants::Transactions::Parameters::CustomerIdentification::CustomerIdentificationOwner.all, # rubocop:disable Layout/LineLength
+                value: value,
+                error_message: 'Invalid data for Customer Identification Document Owner',
+                allow_empty: true
+              )
+            end
+
+            # Customer Identification Type
+            def customer_identification_type=(value)
+              allowed_options(
+                attribute: __method__,
+                allowed:
+                  GenesisRuby::Api::Constants::Transactions::Parameters::CustomerIdentification::CustomerIdentificationType.all, # rubocop:disable Layout/LineLength
+                value: value,
+                error_message: 'Invalid data for Customer Identification Document Type',
+                allow_empty: true
+              )
+            end
+
+            # Customer Identification Issuing Country
+            def customer_identification_issuing_country=(value)
+              allowed_options(
+                attribute: __method__,
+                allowed: GenesisRuby::Utils::Country::COUNTRIES.keys,
+                value: value,
+                error_message: 'Invalid country code for Document issuer country',
+                allow_empty: true
+              )
+            end
+
+            # Customer Identification Document Subtype
+            def customer_identification_subtype=(value)
+              allowed_options(
+                attribute: __method__,
+                allowed: GenesisRuby::Api::Constants::Transactions::Parameters::CustomerIdentification::CustomerIdentificationSubtype.all, # rubocop:disable Layout/LineLength
+                value: value,
+                error_message: 'Invalid value for Customer Identification Document Subtype',
+                allow_empty: true
+              )
+            end
+
+            protected
+
+            def customer_identification_attributes_structure
+              {
+                owner:           customer_identification_owner,
+                type:            customer_identification_type,
+                subtype:         customer_identification_subtype,
+                document_id:     customer_identification_document_id,
+                issuing_country: customer_identification_issuing_country
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/gift_cards_attributes.rb

@@ -0,0 +1,26 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          # Gift Cards Attributes mixin
+          module GiftCardsAttributes
+
+            attr_reader :card_number, :cvv
+
+            # Gift card number
+            def card_number=(value)
+              limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, min: 19, max: 21
+            end
+
+            # Verification code of the gift card
+            def cvv=(value)
+              limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, min: 5, max: 8
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/online_banking_payments/payer_attributes.rb

@@ -0,0 +1,65 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          module OnlineBankingPayments
+            # Payer attributes
+            module PayerAttributes
+
+              attr_reader :payer_document_id, :payer_bank_code, :payer_bank_account_number,
+                          :payer_bank_branch, :payer_bank_account_verification_digit,
+                          :payer_bank_phone_number
+
+              # Payer document ID
+              def payer_document_id=(value)
+                limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 16
+              end
+
+              # The bank code used to process the transaction
+              def payer_bank_code=(value)
+                limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 12
+              end
+
+              # The payer's bank account number
+              def payer_bank_account_number=(value)
+                limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 33
+              end
+
+              # The name of the bank branch where the account is held
+              def payer_bank_branch=(value)
+                limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 11
+              end
+
+              # Single digit verification code assigned by the external provider,
+              # used to validate the bank account
+              def payer_bank_account_verification_digit=(value)
+                limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 1
+              end
+
+              # The payer's bank contact phone number
+              def payer_bank_phone_number=(value)
+                limited_string attribute: __method__, value: value.to_s.empty? ? nil : value.to_s, max: 11
+              end
+
+              protected
+
+              # Payer parameters structure
+              def payer_parameters_structure
+                {
+                  document_id:                     payer_document_id,
+                  bank_code:                       payer_bank_code,
+                  bank_account_number:             payer_bank_account_number,
+                  bank_branch:                     payer_bank_branch,
+                  bank_account_verification_digit: payer_bank_account_verification_digit,
+                  bank_phone_number:               payer_bank_phone_number
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/preauthorization_attributes.rb

@@ -0,0 +1,25 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          # Mixin Preauthorization Attributes
+          module PreauthorizationAttributes
+
+            attr_reader :preauthorization
+
+            # Preauthorization setter
+            def preauthorization=(value)
+              allowed_options attribute:     __method__,
+                              allowed:       [true, false],
+                              value:         value,
+                              allow_empty:   true,
+                              error_message: 'Accepts only boolean values'
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/purpose_of_payment_attributes.rb

@@ -0,0 +1,29 @@
+require 'genesis_ruby/api/constants/transactions/parameters/purpose_of_payment'
+
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          # Purpose of Payment Attributes
+          module PurposeOfPaymentAttributes
+
+            attr_reader :purpose_of_payment
+
+            # Purpose of Payment setter
+            def purpose_of_payment=(value)
+              allowed_options(
+                attribute: __method__,
+                allowed: GenesisRuby::Api::Constants::Transactions::Parameters::PurposeOfPayment.all,
+                value: value,
+                error_message: 'Invalid data for Purpose of Payment',
+                allow_empty: true
+              )
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/source_of_funds_attributes.rb

@@ -0,0 +1,38 @@
+require 'genesis_ruby/api/constants/transactions/parameters/source_of_funds'
+
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          # Source of Funds Attributes
+          module SourceOfFundsAttributes
+
+            attr_reader :source_of_funds
+
+            # Source of Funds setter
+            def source_of_funds=(value)
+              allowed_options(
+                attribute: __method__,
+                allowed: GenesisRuby::Api::Constants::Transactions::Parameters::SourceOfFunds.all,
+                value: value,
+                error_message: 'Invalid data for Source of Funds',
+                allow_empty: true
+              )
+            end
+
+            protected
+
+            # Source of Funds attributes structure
+            def source_of_funds_attributes_structure
+              {
+                source_of_funds: source_of_funds
+              }
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/travel_data/airline_itinerary_attributes.rb

@@ -135,7 +135,7 @@ module GenesisRuby
               end
 
               # Attributes Structure
-              def airline_attributes_structure # rubocop:disable RSpec/MethodLength
+              def airline_attributes_structure # rubocop:disable Metrics/MethodLength
                 {
                   ticket_number:               travel_aid_ticket_number,
                   passenger_name:              travel_aid_passenger_name,

data/lib/genesis_ruby/api/mixins/requests/non_financial/fx/id_attributes.rb

@@ -0,0 +1,28 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module NonFinancial
+          module Fx
+            # ID Attributes mixin
+            module IdAttributes
+
+              attr_writer :id
+
+              # Tier ID
+              def id
+                @id.to_s
+              end
+
+              # Required fields
+              def id_required_fields
+                [:id]
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/non_financial/fx/tier_id_attributes.rb

@@ -0,0 +1,28 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module NonFinancial
+          module Fx
+            # Tier ID Attributes mixin
+            module TierIdAttributes
+
+              attr_writer :tier_id
+
+              # Identification of the tier
+              def tier_id
+                @tier_id.to_s
+              end
+
+              # Required fields
+              def tier_id_required_fields
+                [:tier_id]
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end