pnz-payments-sdk 1.0.0

data/lib/account_and_transaction_api_specification/models/creditor_agent.rb

@@ -0,0 +1,100 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Party that manages the account on behalf of the account owner, that is
+  # manages the registration and booking of entries on the account, calculates
+  # balances on the account and provides information about the account. This is
+  # the servicer of the beneficiary account.
+  class CreditorAgent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the identification scheme, in a coded form as published in an
+    # external list.
+    # @return [SchemeNameEnum]
+    attr_accessor :scheme_name
+
+    # Unique and unambiguous identification of the servicing institution.
+    # @return [String]
+    attr_accessor :identification
+
+    # Name by which an agent is known and which is usually used to identify that
+    # agent.
+    # @return [String]
+    attr_accessor :name
+
+    # Information that locates and identifies a specific address, as defined by
+    # postal services.
+    # @return [PostalAddress]
+    attr_accessor :postal_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['scheme_name'] = 'SchemeName'
+      @_hash['identification'] = 'Identification'
+      @_hash['name'] = 'Name'
+      @_hash['postal_address'] = 'PostalAddress'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        scheme_name
+        identification
+        name
+        postal_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(scheme_name = SKIP, identification = SKIP, name = SKIP,
+                   postal_address = SKIP)
+      @scheme_name = scheme_name unless scheme_name == SKIP
+      @identification = identification unless identification == SKIP
+      @name = name unless name == SKIP
+      @postal_address = postal_address unless postal_address == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      scheme_name = hash.key?('SchemeName') ? hash['SchemeName'] : SKIP
+      identification =
+        hash.key?('Identification') ? hash['Identification'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      postal_address = PostalAddress.from_hash(hash['PostalAddress']) if hash['PostalAddress']
+
+      # Create object from extracted values.
+      CreditorAgent.new(scheme_name,
+                        identification,
+                        name,
+                        postal_address)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} scheme_name: #{@scheme_name}, identification: #{@identification}, name:"\
+      " #{@name}, postal_address: #{@postal_address}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} scheme_name: #{@scheme_name.inspect}, identification:"\
+      " #{@identification.inspect}, name: #{@name.inspect}, postal_address:"\
+      " #{@postal_address.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/creditor_reference.rb

@@ -0,0 +1,81 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # CreditorReference Model.
+  class CreditorReference < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :particulars
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['particulars'] = 'Particulars'
+      @_hash['code'] = 'Code'
+      @_hash['reference'] = 'Reference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        particulars
+        code
+        reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(particulars = SKIP, code = SKIP, reference = SKIP)
+      @particulars = particulars unless particulars == SKIP
+      @code = code unless code == SKIP
+      @reference = reference unless reference == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      particulars = hash.key?('Particulars') ? hash['Particulars'] : SKIP
+      code = hash.key?('Code') ? hash['Code'] : SKIP
+      reference = hash.key?('Reference') ? hash['Reference'] : SKIP
+
+      # Create object from extracted values.
+      CreditorReference.new(particulars,
+                            code,
+                            reference)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} particulars: #{@particulars}, code: #{@code}, reference: #{@reference}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} particulars: #{@particulars.inspect}, code: #{@code.inspect}, reference:"\
+      " #{@reference.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/currency_exchange.rb

@@ -0,0 +1,147 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AccountAndTransactionApiSpecification
+  # Set of elements used to provide details on the currency exchange.
+  class CurrencyExchange < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Currency from which an amount is to be converted in a currency conversion.
+    # @return [String]
+    attr_accessor :source_currency
+
+    # Currency from which an amount is to be converted in a currency conversion.
+    # @return [String]
+    attr_accessor :target_currency
+
+    # Currency from which an amount is to be converted in a currency conversion.
+    # @return [String]
+    attr_accessor :unit_currency
+
+    # Factor used to convert an amount from one currency into another. This
+    # reflects the price at which one currency was bought with another currency.
+    # Usage: ExchangeRate expresses the ratio between UnitCurrency and
+    # QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).
+    # @return [Float]
+    attr_accessor :exchange_rate
+
+    # Unique identification to unambiguously identify the foreign exchange
+    # contract.
+    # @return [String]
+    attr_accessor :contract_identification
+
+    # Date and time at which an exchange rate is quoted.
+    # All dates in the JSON payloads are represented in ISO 8601 date-time
+    # format.
+    # All date-time fields in responses must include the timezone. An example is
+    # below:
+    # 2017-04-05T10:43:07+00:00
+    # @return [DateTime]
+    attr_accessor :quotation_date
+
+    # Amount of money of the cash balance after a transaction entry is applied
+    # to the account..
+    # @return [InstructedAmount]
+    attr_accessor :instructed_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['source_currency'] = 'SourceCurrency'
+      @_hash['target_currency'] = 'TargetCurrency'
+      @_hash['unit_currency'] = 'UnitCurrency'
+      @_hash['exchange_rate'] = 'ExchangeRate'
+      @_hash['contract_identification'] = 'ContractIdentification'
+      @_hash['quotation_date'] = 'QuotationDate'
+      @_hash['instructed_amount'] = 'InstructedAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        target_currency
+        unit_currency
+        contract_identification
+        quotation_date
+        instructed_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(source_currency = nil, exchange_rate = nil,
+                   target_currency = SKIP, unit_currency = SKIP,
+                   contract_identification = SKIP, quotation_date = SKIP,
+                   instructed_amount = SKIP)
+      @source_currency = source_currency
+      @target_currency = target_currency unless target_currency == SKIP
+      @unit_currency = unit_currency unless unit_currency == SKIP
+      @exchange_rate = exchange_rate
+      @contract_identification = contract_identification unless contract_identification == SKIP
+      @quotation_date = quotation_date unless quotation_date == SKIP
+      @instructed_amount = instructed_amount unless instructed_amount == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      source_currency =
+        hash.key?('SourceCurrency') ? hash['SourceCurrency'] : nil
+      exchange_rate = hash.key?('ExchangeRate') ? hash['ExchangeRate'] : nil
+      target_currency =
+        hash.key?('TargetCurrency') ? hash['TargetCurrency'] : SKIP
+      unit_currency = hash.key?('UnitCurrency') ? hash['UnitCurrency'] : SKIP
+      contract_identification =
+        hash.key?('ContractIdentification') ? hash['ContractIdentification'] : SKIP
+      quotation_date = if hash.key?('QuotationDate')
+                         (DateTimeHelper.from_rfc3339(hash['QuotationDate']) if hash['QuotationDate'])
+                       else
+                         SKIP
+                       end
+      instructed_amount = InstructedAmount.from_hash(hash['InstructedAmount']) if
+        hash['InstructedAmount']
+
+      # Create object from extracted values.
+      CurrencyExchange.new(source_currency,
+                           exchange_rate,
+                           target_currency,
+                           unit_currency,
+                           contract_identification,
+                           quotation_date,
+                           instructed_amount)
+    end
+
+    def to_custom_quotation_date
+      DateTimeHelper.to_rfc3339(quotation_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} source_currency: #{@source_currency}, target_currency: #{@target_currency},"\
+      " unit_currency: #{@unit_currency}, exchange_rate: #{@exchange_rate},"\
+      " contract_identification: #{@contract_identification}, quotation_date: #{@quotation_date},"\
+      " instructed_amount: #{@instructed_amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} source_currency: #{@source_currency.inspect}, target_currency:"\
+      " #{@target_currency.inspect}, unit_currency: #{@unit_currency.inspect}, exchange_rate:"\
+      " #{@exchange_rate.inspect}, contract_identification: #{@contract_identification.inspect},"\
+      " quotation_date: #{@quotation_date.inspect}, instructed_amount:"\
+      " #{@instructed_amount.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/data.rb

@@ -0,0 +1,71 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Data
+  class Data < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account
+    # @return [Array[AccountModel]]
+    attr_accessor :account
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account'] = 'Account'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account = SKIP)
+      @account = account unless account == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      account = nil
+      unless hash['Account'].nil?
+        account = []
+        hash['Account'].each do |structure|
+          account << (AccountModel.from_hash(structure) if structure)
+        end
+      end
+
+      account = SKIP unless hash.key?('Account')
+
+      # Create object from extracted values.
+      Data.new(account)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account: #{@account}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account: #{@account.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/debtor_account.rb

@@ -0,0 +1,102 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Unambiguous identification of the account of the debtor, in the case of a
+  # crebit transaction.
+  class DebtorAccount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [AccountSchemeModelEnum]
+    attr_accessor :scheme_name
+
+    # Identification assigned by an institution to identify an account. This
+    # identification is known by the account owner.
+    # @return [String]
+    attr_accessor :identification
+
+    # Name of the account, as assigned by the account servicing institution, in
+    # agreement with the account owner in order to provide an additional means
+    # of identification of the account.
+    # Usage: The account name is different from the account owner name. The
+    # account name is used in certain user communities to provide a means of
+    # identifying the account, in addition to the account owner's identity and
+    # the account number.
+    # @return [String]
+    attr_accessor :name
+
+    # This is secondary identification of the account, as assigned by the
+    # account servicing institution.
+    # @return [String]
+    attr_accessor :secondary_identification
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['scheme_name'] = 'SchemeName'
+      @_hash['identification'] = 'Identification'
+      @_hash['name'] = 'Name'
+      @_hash['secondary_identification'] = 'SecondaryIdentification'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        secondary_identification
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(scheme_name = nil, identification = nil, name = SKIP,
+                   secondary_identification = SKIP)
+      @scheme_name = scheme_name
+      @identification = identification
+      @name = name unless name == SKIP
+      @secondary_identification = secondary_identification unless secondary_identification == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      scheme_name = hash.key?('SchemeName') ? hash['SchemeName'] : nil
+      identification =
+        hash.key?('Identification') ? hash['Identification'] : nil
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      secondary_identification =
+        hash.key?('SecondaryIdentification') ? hash['SecondaryIdentification'] : SKIP
+
+      # Create object from extracted values.
+      DebtorAccount.new(scheme_name,
+                        identification,
+                        name,
+                        secondary_identification)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} scheme_name: #{@scheme_name}, identification: #{@identification}, name:"\
+      " #{@name}, secondary_identification: #{@secondary_identification}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} scheme_name: #{@scheme_name.inspect}, identification:"\
+      " #{@identification.inspect}, name: #{@name.inspect}, secondary_identification:"\
+      " #{@secondary_identification.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/debtor_agent.rb

@@ -0,0 +1,70 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Financial institution servicing an account for the debtor.
+  class DebtorAgent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the identification scheme, in a coded form as published in an
+    # external list.
+    # @return [String]
+    attr_reader :scheme_name
+
+    # Unique and unambiguous identification of a financial institution or a
+    # branch of a financial institution.
+    # @return [String]
+    attr_accessor :identification
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['scheme_name'] = 'SchemeName'
+      @_hash['identification'] = 'Identification'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(identification = nil)
+      @scheme_name = 'BICFI'
+      @identification = identification
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      identification =
+        hash.key?('Identification') ? hash['Identification'] : nil
+
+      # Create object from extracted values.
+      DebtorAgent.new(identification)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} scheme_name: #{@scheme_name}, identification: #{@identification}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} scheme_name: #{@scheme_name.inspect}, identification:"\
+      " #{@identification.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/debtor_reference.rb

@@ -0,0 +1,81 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # DebtorReference Model.
+  class DebtorReference < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :particulars
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['particulars'] = 'Particulars'
+      @_hash['code'] = 'Code'
+      @_hash['reference'] = 'Reference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        particulars
+        code
+        reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(particulars = SKIP, code = SKIP, reference = SKIP)
+      @particulars = particulars unless particulars == SKIP
+      @code = code unless code == SKIP
+      @reference = reference unless reference == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      particulars = hash.key?('Particulars') ? hash['Particulars'] : SKIP
+      code = hash.key?('Code') ? hash['Code'] : SKIP
+      reference = hash.key?('Reference') ? hash['Reference'] : SKIP
+
+      # Create object from extracted values.
+      DebtorReference.new(particulars,
+                          code,
+                          reference)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} particulars: #{@particulars}, code: #{@code}, reference: #{@reference}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} particulars: #{@particulars.inspect}, code: #{@code.inspect}, reference:"\
+      " #{@reference.inspect}>"
+    end
+  end
+end